public static final class Runnable.Container extends GeneratedMessageV3 implements Runnable.ContainerOrBuilder
Container runnable.
Protobuf type google.cloud.batch.v1.Runnable.Container
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER
public static final int BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMMANDS_FIELD_NUMBER
public static final int COMMANDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_IMAGE_STREAMING_FIELD_NUMBER
public static final int ENABLE_IMAGE_STREAMING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTRYPOINT_FIELD_NUMBER
public static final int ENTRYPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IMAGE_URI_FIELD_NUMBER
public static final int IMAGE_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PASSWORD_FIELD_NUMBER
public static final int PASSWORD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USERNAME_FIELD_NUMBER
public static final int USERNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VOLUMES_FIELD_NUMBER
public static final int VOLUMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Runnable.Container getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Runnable.Container.Builder newBuilder()
newBuilder(Runnable.Container prototype)
public static Runnable.Container.Builder newBuilder(Runnable.Container prototype)
public static Runnable.Container parseDelimitedFrom(InputStream input)
public static Runnable.Container parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Runnable.Container parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Runnable.Container parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Runnable.Container parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Runnable.Container parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Runnable.Container parseFrom(CodedInputStream input)
public static Runnable.Container parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Runnable.Container parseFrom(InputStream input)
public static Runnable.Container parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Runnable.Container parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Runnable.Container parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Runnable.Container> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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)
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 |
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)
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 |
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()
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;
getDefaultInstanceForType()
public Runnable.Container getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<Runnable.Container> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 |
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 --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 |
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 --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;
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Runnable.Container.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Runnable.Container.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Runnable.Container.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
