- 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 final class Runnable.Container.Builder extends GeneratedMessageV3.Builder<Runnable.Container.Builder> implements Runnable.ContainerOrBuilderContainer runnable.
Protobuf type google.cloud.batch.v1alpha.Runnable.Container
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Runnable.Container.BuilderImplements
Runnable.ContainerOrBuilderStatic 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) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these 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 --volume option for the
docker run command—for example, /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) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe commands to add. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
addCommandsBytes(ByteString value)
public Runnable.Container.Builder addCommandsBytes(ByteString value) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
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 --volume option for the
docker run command—for example, /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 |
StringThe 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 --volume option for the
docker run command—for example, /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 |
ByteStringThe 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 |
|
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() Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these 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() Required for some container images. 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 |
|
clearImageUri()
public Runnable.Container.Builder clearImageUri()Required. 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 |
|
clearOptions()
public Runnable.Container.Builder clearOptions() Required for some container images. Arbitrary additional options to
include in the docker run command when running this container—for
example, --network host. For the --volume option, use the volumes
field for the container.
string options = 8;
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
clearPassword()
public Runnable.Container.Builder clearPassword()Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image.
For security, it is strongly recommended to specify an
encrypted password by using a Secret Manager secret:
projects/*/secrets/*/versions/*.
Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string password = 11;
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
clearUsername()
public Runnable.Container.Builder clearUsername()Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image.
You can either specify the username directly by using plain text or
specify an encrypted username by using a Secret Manager secret:
projects/*/secrets/*/versions/*. However, using a secret is
recommended for enhanced security.
Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead.
Learn more about Secret Manager and using Secret Manager with Batch.
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 --volume option for the
docker run command—for example, /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 |
|
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) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The commands at the given index. |
getCommandsBytes(int index)
public ByteString getCommandsBytes(int index) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the commands at the given index. |
getCommandsCount()
public int getCommandsCount() Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The count of commands. |
getCommandsList()
public ProtocolStringList getCommandsList() Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these 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 |
|
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() Required for some container images. Overrides the ENTRYPOINT specified
in the container.
string entrypoint = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The entrypoint. |
getEntrypointBytes()
public ByteString getEntrypointBytes() Required for some container images. Overrides the ENTRYPOINT specified
in the container.
string entrypoint = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for entrypoint. |
getImageUri()
public String getImageUri()Required. The URI to pull the container image from.
string image_uri = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The imageUri. |
getImageUriBytes()
public ByteString getImageUriBytes()Required. The URI to pull the container image from.
string image_uri = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for imageUri. |
getOptions()
public String getOptions() Required for some container images. Arbitrary additional options to
include in the docker run command when running this container—for
example, --network host. For the --volume option, use the volumes
field for the container.
string options = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The options. |
getOptionsBytes()
public ByteString getOptionsBytes() Required for some container images. Arbitrary additional options to
include in the docker run command when running this container—for
example, --network host. For the --volume option, use the volumes
field for the container.
string options = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for options. |
getPassword()
public String getPassword()Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image.
For security, it is strongly recommended to specify an
encrypted password by using a Secret Manager secret:
projects/*/secrets/*/versions/*.
Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string password = 11;
| Returns | |
|---|---|
| Type | Description |
String |
The password. |
getPasswordBytes()
public ByteString getPasswordBytes()Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image.
For security, it is strongly recommended to specify an
encrypted password by using a Secret Manager secret:
projects/*/secrets/*/versions/*.
Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string password = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for password. |
getUsername()
public String getUsername()Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image.
You can either specify the username directly by using plain text or
specify an encrypted username by using a Secret Manager secret:
projects/*/secrets/*/versions/*. However, using a secret is
recommended for enhanced security.
Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string username = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The username. |
getUsernameBytes()
public ByteString getUsernameBytes()Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image.
You can either specify the username directly by using plain text or
specify an encrypted username by using a Secret Manager secret:
projects/*/secrets/*/versions/*. However, using a secret is
recommended for enhanced security.
Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead.
Learn more about Secret Manager and using Secret Manager with Batch.
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 --volume option for the
docker run command—for example, /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 |
intThe 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 --volume option for the
docker run command—for example, /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 |
intThe 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 --volume option for the
docker run command—for example, /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 --volume option for the
docker run command—for example, /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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| 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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Runnable.Container.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
|
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 |
booleanThe 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) Required for some container images. Overrides the CMD specified in the
container. If there is an ENTRYPOINT (either in the container image or
with the entrypoint field below) then these commands are appended as
arguments to the ENTRYPOINT.
repeated string commands = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe 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 |
booleanThe enableImageStreaming to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setEntrypoint(String value)
public Runnable.Container.Builder setEntrypoint(String value) Required for some container images. Overrides the ENTRYPOINT specified
in the container.
string entrypoint = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe entrypoint to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setEntrypointBytes(ByteString value)
public Runnable.Container.Builder setEntrypointBytes(ByteString value) Required for some container images. Overrides the ENTRYPOINT specified
in the container.
string entrypoint = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
setImageUri(String value)
public Runnable.Container.Builder setImageUri(String value)Required. The URI to pull the container image from.
string image_uri = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe imageUri to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setImageUriBytes(ByteString value)
public Runnable.Container.Builder setImageUriBytes(ByteString value)Required. The URI to pull the container image from.
string image_uri = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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) Required for some container images. Arbitrary additional options to
include in the docker run command when running this container—for
example, --network host. For the --volume option, use the volumes
field for the container.
string options = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe options to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setOptionsBytes(ByteString value)
public Runnable.Container.Builder setOptionsBytes(ByteString value) Required for some container images. Arbitrary additional options to
include in the docker run command when running this container—for
example, --network host. For the --volume option, use the volumes
field for the container.
string options = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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)Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image.
For security, it is strongly recommended to specify an
encrypted password by using a Secret Manager secret:
projects/*/secrets/*/versions/*.
Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string password = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe password to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setPasswordBytes(ByteString value)
public Runnable.Container.Builder setPasswordBytes(ByteString value)Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image.
For security, it is strongly recommended to specify an
encrypted password by using a Secret Manager secret:
projects/*/secrets/*/versions/*.
Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string password = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Runnable.Container.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
|
setUsername(String value)
public Runnable.Container.Builder setUsername(String value)Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image.
You can either specify the username directly by using plain text or
specify an encrypted username by using a Secret Manager secret:
projects/*/secrets/*/versions/*. However, using a secret is
recommended for enhanced security.
Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string username = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe username to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |
setUsernameBytes(ByteString value)
public Runnable.Container.Builder setUsernameBytes(ByteString value)Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image.
You can either specify the username directly by using plain text or
specify an encrypted username by using a Secret Manager secret:
projects/*/secrets/*/versions/*. However, using a secret is
recommended for enhanced security.
Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead.
Learn more about Secret Manager and using Secret Manager with Batch.
string username = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 --volume option for the
docker run command—for example, /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 |
intThe index to set the value at. |
value |
StringThe volumes to set. |
| Returns | |
|---|---|
| Type | Description |
Runnable.Container.Builder |
This builder for chaining. |