Class Runnable.Container.Builder (0.35.0) 

public static final class Runnable.Container.Builder extends GeneratedMessageV3.Builder<Runnable.Container.Builder> implements Runnable.ContainerOrBuilder

Container runnable.

Protobuf type google.cloud.batch.v1.Runnable.Container

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Runnable.Container.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCommands(Iterable<String> values)

public Runnable.Container.Builder addAllCommands(Iterable<String> values)

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
values Iterable<String>

The commands to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

addAllVolumes(Iterable<String> values)

public Runnable.Container.Builder addAllVolumes(Iterable<String> values)

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
values Iterable<String>

The volumes to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

addCommands(String value)

public Runnable.Container.Builder addCommands(String value)

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
value String

The commands to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

addCommandsBytes(ByteString value)

public Runnable.Container.Builder addCommandsBytes(ByteString value)

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
value ByteString

The bytes of the commands to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Container.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runnable.Container.Builder
Overrides

addVolumes(String value)

public Runnable.Container.Builder addVolumes(String value)

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
value String

The volumes to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

addVolumesBytes(ByteString value)

public Runnable.Container.Builder addVolumesBytes(ByteString value)

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
value ByteString

The bytes of the volumes to add.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

build()

public Runnable.Container build()
Returns
Type Description
Runnable.Container

buildPartial()

public Runnable.Container buildPartial()
Returns
Type Description
Runnable.Container

clear()

public Runnable.Container.Builder clear()
Returns
Type Description
Runnable.Container.Builder
Overrides

clearBlockExternalNetwork()

public Runnable.Container.Builder clearBlockExternalNetwork()

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
Runnable.Container.Builder

This builder for chaining.

clearCommands()

public Runnable.Container.Builder clearCommands()

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
Runnable.Container.Builder

This builder for chaining.

clearEnableImageStreaming()

public Runnable.Container.Builder clearEnableImageStreaming()

Optional. If set to true, this container runnable uses Image streaming.

Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images.

When enableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored.

For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.

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

Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

clearEntrypoint()

public Runnable.Container.Builder clearEntrypoint()

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Runnable.Container.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Runnable.Container.Builder
Overrides

clearImageUri()

public Runnable.Container.Builder clearImageUri()

The URI to pull the container image from.

string image_uri = 1;

Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Runnable.Container.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Runnable.Container.Builder
Overrides

clearOptions()

public Runnable.Container.Builder clearOptions()

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

string options = 8;

Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

clearPassword()

public Runnable.Container.Builder clearPassword()

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
Runnable.Container.Builder

This builder for chaining.

clearUsername()

public Runnable.Container.Builder clearUsername()

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
Runnable.Container.Builder

This builder for chaining.

clearVolumes()

public Runnable.Container.Builder clearVolumes()

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
Runnable.Container.Builder

This builder for chaining.

clone()

public Runnable.Container.Builder clone()
Returns
Type Description
Runnable.Container.Builder
Overrides

getBlockExternalNetwork()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the commands.

getDefaultInstanceForType()

public Runnable.Container getDefaultInstanceForType()
Returns
Type Description
Runnable.Container

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableImageStreaming()

public boolean getEnableImageStreaming()

Optional. If set to true, this container runnable uses Image streaming.

Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images.

When enableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored.

For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.

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

Returns
Type Description
boolean

The enableImageStreaming.

getEntrypoint()

public String getEntrypoint()

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Returns
Type Description
String

The entrypoint.

getEntrypointBytes()

public ByteString getEntrypointBytes()

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Returns
Type Description
ByteString

The bytes for entrypoint.

getImageUri()

public String getImageUri()

The URI to pull the container image from.

string image_uri = 1;

Returns
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

The URI to pull the container image from.

string image_uri = 1;

Returns
Type Description
ByteString

The bytes for imageUri.

getOptions()

public 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 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 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the volumes.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Runnable.Container other)

public Runnable.Container.Builder mergeFrom(Runnable.Container other)
Parameter
Name Description
other Runnable.Container
Returns
Type Description
Runnable.Container.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Runnable.Container.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runnable.Container.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Runnable.Container.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Runnable.Container.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Container.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runnable.Container.Builder
Overrides

setBlockExternalNetwork(boolean value)

public Runnable.Container.Builder setBlockExternalNetwork(boolean value)

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;

Parameter
Name Description
value boolean

The blockExternalNetwork to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setCommands(int index, String value)

public Runnable.Container.Builder setCommands(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The commands to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setEnableImageStreaming(boolean value)

public Runnable.Container.Builder setEnableImageStreaming(boolean value)

Optional. If set to true, this container runnable uses Image streaming.

Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images.

When enableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored.

For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.

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

Parameter
Name Description
value boolean

The enableImageStreaming to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setEntrypoint(String value)

public Runnable.Container.Builder setEntrypoint(String value)

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Parameter
Name Description
value String

The entrypoint to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setEntrypointBytes(ByteString value)

public Runnable.Container.Builder setEntrypointBytes(ByteString value)

Overrides the ENTRYPOINT specified in the container.

string entrypoint = 3;

Parameter
Name Description
value ByteString

The bytes for entrypoint to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Container.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runnable.Container.Builder
Overrides

setImageUri(String value)

public Runnable.Container.Builder setImageUri(String value)

The URI to pull the container image from.

string image_uri = 1;

Parameter
Name Description
value String

The imageUri to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public Runnable.Container.Builder setImageUriBytes(ByteString value)

The URI to pull the container image from.

string image_uri = 1;

Parameter
Name Description
value ByteString

The bytes for imageUri to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setOptions(String value)

public Runnable.Container.Builder setOptions(String value)

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

string options = 8;

Parameter
Name Description
value String

The options to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setOptionsBytes(ByteString value)

public Runnable.Container.Builder setOptionsBytes(ByteString value)

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

string options = 8;

Parameter
Name Description
value ByteString

The bytes for options to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setPassword(String value)

public Runnable.Container.Builder setPassword(String value)

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;

Parameter
Name Description
value String

The password to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setPasswordBytes(ByteString value)

public Runnable.Container.Builder setPasswordBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for password to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Runnable.Container.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Runnable.Container.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Container.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runnable.Container.Builder
Overrides

setUsername(String value)

public Runnable.Container.Builder setUsername(String value)

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;

Parameter
Name Description
value String

The username to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setUsernameBytes(ByteString value)

public Runnable.Container.Builder setUsernameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for username to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.

setVolumes(int index, String value)

public Runnable.Container.Builder setVolumes(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The volumes to set.
Returns
Type Description
Runnable.Container.Builder

This builder for chaining.