Package io.quarkus.kubernetes.spi

Class KubernetesJobBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.kubernetes.spi.KubernetesJobBuildItem

All Implemented Interfaces:

Targetable

public final class KubernetesJobBuildItem
extends io.quarkus.builder.item.MultiBuildItem
implements Targetable

A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container.

Env vars specified through this build item, will take precedence over inherited ones.

Constructor Summary

Constructors

Constructor	Description
KubernetesJobBuildItem(String name, String target, String image, List<String> command, List<String> arguments, Map<String,String> envVars, boolean sharedEnvironment, boolean sharedFilesystem)

Method Summary

Modifier and Type	Method	Description
static KubernetesJobBuildItem	create(String image)
List<String>	getArguments()
List<String>	getCommand()
Map<String,String>	getEnvVars()
String	getImage()
String	getName()
String	getTarget()
boolean	isSharedEnvironment()	Flag for tasks that require access to the environment variables of the application.
boolean	isSharedFilesystem()	Flag for tasks that need to share filesystem with the application.
KubernetesJobBuildItem	withArguments(List<String> arguments)
KubernetesJobBuildItem	withCommand(List<String> command)
KubernetesJobBuildItem	withEnvVars(Map<String,String> envVars)
KubernetesJobBuildItem	withImage(String image)
KubernetesJobBuildItem	withName(String name)
KubernetesJobBuildItem	withSharedEnvironment(boolean sharedEnvironment)
KubernetesJobBuildItem	withSharedFilesystem(boolean sharedFilesystem)
KubernetesJobBuildItem	withTarget(String target)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.quarkus.kubernetes.spi.Targetable

isActiveFor

Constructor Details

KubernetesJobBuildItem

public KubernetesJobBuildItem(String name,
 String target,
 String image,
 List<String> command,
 List<String> arguments,
 Map<String,String> envVars,
 boolean sharedEnvironment,
 boolean sharedFilesystem)

Method Details

create

public static KubernetesJobBuildItem create(String image)

getName

public String getName()

withName

public KubernetesJobBuildItem withName(String name)

getTarget

public String getTarget()

Specified by:

getTarget in interface Targetable

withTarget

public KubernetesJobBuildItem withTarget(String target)

getImage

public String getImage()

withImage

public KubernetesJobBuildItem withImage(String image)

getCommand

public List<String> getCommand()

withCommand

public KubernetesJobBuildItem withCommand(List<String> command)

getArguments

public List<String> getArguments()

withArguments

public KubernetesJobBuildItem withArguments(List<String> arguments)

getEnvVars

public Map<String,String> getEnvVars()

withEnvVars

public KubernetesJobBuildItem withEnvVars(Map<String,String> envVars)

isSharedEnvironment

public boolean isSharedEnvironment()

Flag for tasks that require access to the environment variables of the application. Often tasks need to access resources, configured via environment variables. This flag expresses that the task should be executed using the same envrironment variables as the application.

Returns:

true when the task is meant to share environment variables with the application.

withSharedEnvironment

public KubernetesJobBuildItem withSharedEnvironment(boolean sharedEnvironment)

isSharedFilesystem

public boolean isSharedFilesystem()

Flag for tasks that need to share filesystem with the application. Often tasks need to access resources, configured via filesystem (e.g. local config files, kubernetes service binding etc). In other cases, tasks may need to produce files needed by the application. This flag expresses that the task should share filesystem with the application.

Returns:

true when the task is meant to share filesystem.

withSharedFilesystem

public KubernetesJobBuildItem withSharedFilesystem(boolean sharedFilesystem)