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

Implements

Runnable.ContainerOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBlockExternalNetwork()

public Runnable.Container.Builder clearBlockExternalNetwork()

If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.

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.

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getBlockExternalNetwork()

public boolean getBlockExternalNetwork()

If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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

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

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

repeated string volumes = 7;

Returns

Type	Description
ProtocolStringList	A list containing the volumes.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Container.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Runnable.Container.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBlockExternalNetwork(boolean value)

public Runnable.Container.Builder setBlockExternalNetwork(boolean value)

If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.

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.

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Container.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Runnable.Container.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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

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.