Interface Runnable.ContainerOrBuilder (0.28.0)

Version 0.28.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.1

public static interface Runnable.ContainerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBlockExternalNetwork()

public abstract boolean getBlockExternalNetwork()

If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.

bool block_external_network = 9;

Returns
Type	Description
boolean	The blockExternalNetwork.

getCommands(int index)

public abstract String getCommands(int index)

Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.

repeated string commands = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The commands at the given index.

getCommandsBytes(int index)

public abstract ByteString getCommandsBytes(int index)

Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.

repeated string commands = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the commands at the given index.

getCommandsCount()

public abstract int getCommandsCount()

Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.

repeated string commands = 2;

Returns
Type	Description
int	The count of commands.

getCommandsList()

public abstract List<String> getCommandsList()

Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.

repeated string commands = 2;

Returns
Type	Description
List<String>	A list containing the commands.

getEnableImageStreaming()

public abstract boolean getEnableImageStreaming()

Optional. Not yet implemented. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored.

bool enable_image_streaming = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableImageStreaming.

getEntrypoint()

public abstract String getEntrypoint()

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Returns
Type	Description
String	The entrypoint.

getEntrypointBytes()

public abstract ByteString getEntrypointBytes()

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Returns
Type	Description
ByteString	The bytes for entrypoint.

getImageUri()

public abstract String getImageUri()

The URI to pull the container image from.

string image_uri = 1;

Returns
Type	Description
String	The imageUri.

getImageUriBytes()

public abstract ByteString getImageUriBytes()

The URI to pull the container image from.

string image_uri = 1;

Returns
Type	Description
ByteString	The bytes for imageUri.

getOptions()

public abstract String getOptions()

Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

string options = 8;

Returns
Type	Description
String	The options.

getOptionsBytes()

public abstract ByteString getOptionsBytes()

Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

string options = 8;

Returns
Type	Description
ByteString	The bytes for options.

getPassword()

public abstract String getPassword()

Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;

string password = 11;

Returns
Type	Description
String	The password.

getPasswordBytes()

public abstract ByteString getPasswordBytes()

Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;

string password = 11;

Returns
Type	Description
ByteString	The bytes for password.

getUsername()

public abstract String getUsername()

Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.

string username = 10;

Returns
Type	Description
String	The username.

getUsernameBytes()

public abstract ByteString getUsernameBytes()

Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.

string username = 10;

Returns
Type	Description
ByteString	The bytes for username.

getVolumes(int index)

public abstract String getVolumes(int index)

Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

repeated string volumes = 7;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The volumes at the given index.

getVolumesBytes(int index)

public abstract ByteString getVolumesBytes(int index)

Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

repeated string volumes = 7;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the volumes at the given index.

getVolumesCount()

public abstract int getVolumesCount()

Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

repeated string volumes = 7;

Returns
Type	Description
int	The count of volumes.

getVolumesList()

public abstract List<String> getVolumesList()

Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

repeated string volumes = 7;

Returns
Type	Description
List<String>	A list containing the volumes.