Class ContainerSpec.Builder (3.33.0)

public static final class ContainerSpec.Builder extends GeneratedMessageV3.Builder<ContainerSpec.Builder> implements ContainerSpecOrBuilder

The spec of a Container.

Protobuf type google.cloud.aiplatform.v1.ContainerSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllArgs(Iterable<String> values)

public ContainerSpec.Builder addAllArgs(Iterable<String> values)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
NameDescription
valuesIterable<String>

The args to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addAllCommand(Iterable<String> values)

public ContainerSpec.Builder addAllCommand(Iterable<String> values)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameter
NameDescription
valuesIterable<String>

The command to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addAllEnv(Iterable<? extends EnvVar> values)

public ContainerSpec.Builder addAllEnv(Iterable<? extends EnvVar> values)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.EnvVar>
Returns
TypeDescription
ContainerSpec.Builder

addArgs(String value)

public ContainerSpec.Builder addArgs(String value)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
NameDescription
valueString

The args to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addArgsBytes(ByteString value)

public ContainerSpec.Builder addArgsBytes(ByteString value)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
NameDescription
valueByteString

The bytes of the args to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addCommand(String value)

public ContainerSpec.Builder addCommand(String value)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameter
NameDescription
valueString

The command to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addCommandBytes(ByteString value)

public ContainerSpec.Builder addCommandBytes(ByteString value)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameter
NameDescription
valueByteString

The bytes of the command to add.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

addEnv(EnvVar value)

public ContainerSpec.Builder addEnv(EnvVar value)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
valueEnvVar
Returns
TypeDescription
ContainerSpec.Builder

addEnv(EnvVar.Builder builderForValue)

public ContainerSpec.Builder addEnv(EnvVar.Builder builderForValue)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
builderForValueEnvVar.Builder
Returns
TypeDescription
ContainerSpec.Builder

addEnv(int index, EnvVar value)

public ContainerSpec.Builder addEnv(int index, EnvVar value)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameters
NameDescription
indexint
valueEnvVar
Returns
TypeDescription
ContainerSpec.Builder

addEnv(int index, EnvVar.Builder builderForValue)

public ContainerSpec.Builder addEnv(int index, EnvVar.Builder builderForValue)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameters
NameDescription
indexint
builderForValueEnvVar.Builder
Returns
TypeDescription
ContainerSpec.Builder

addEnvBuilder()

public EnvVar.Builder addEnvBuilder()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
EnvVar.Builder

addEnvBuilder(int index)

public EnvVar.Builder addEnvBuilder(int index)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ContainerSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ContainerSpec.Builder
Overrides

build()

public ContainerSpec build()
Returns
TypeDescription
ContainerSpec

buildPartial()

public ContainerSpec buildPartial()
Returns
TypeDescription
ContainerSpec

clear()

public ContainerSpec.Builder clear()
Returns
TypeDescription
ContainerSpec.Builder
Overrides

clearArgs()

public ContainerSpec.Builder clearArgs()

The arguments to be passed when starting the container.

repeated string args = 3;

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

clearCommand()

public ContainerSpec.Builder clearCommand()

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

clearEnv()

public ContainerSpec.Builder clearEnv()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
ContainerSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public ContainerSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ContainerSpec.Builder
Overrides

clearImageUri()

public ContainerSpec.Builder clearImageUri()

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ContainerSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ContainerSpec.Builder
Overrides

clone()

public ContainerSpec.Builder clone()
Returns
TypeDescription
ContainerSpec.Builder
Overrides

getArgs(int index)

public String getArgs(int index)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The args at the given index.

getArgsBytes(int index)

public ByteString getArgsBytes(int index)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the args at the given index.

getArgsCount()

public int getArgsCount()

The arguments to be passed when starting the container.

repeated string args = 3;

Returns
TypeDescription
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

The arguments to be passed when starting the container.

repeated string args = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the args.

getCommand(int index)

public String getCommand(int index)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The command at the given index.

getCommandBytes(int index)

public ByteString getCommandBytes(int index)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the command at the given index.

getCommandCount()

public int getCommandCount()

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Returns
TypeDescription
int

The count of command.

getCommandList()

public ProtocolStringList getCommandList()

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the command.

getDefaultInstanceForType()

public ContainerSpec getDefaultInstanceForType()
Returns
TypeDescription
ContainerSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnv(int index)

public EnvVar getEnv(int index)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar

getEnvBuilder(int index)

public EnvVar.Builder getEnvBuilder(int index)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar.Builder

getEnvBuilderList()

public List<EnvVar.Builder> getEnvBuilderList()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
List<Builder>

getEnvCount()

public int getEnvCount()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
int

getEnvList()

public List<EnvVar> getEnvList()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
List<EnvVar>

getEnvOrBuilder(int index)

public EnvVarOrBuilder getEnvOrBuilder(int index)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVarOrBuilder

getEnvOrBuilderList()

public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.EnvVarOrBuilder>

getImageUri()

public String getImageUri()

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for imageUri.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ContainerSpec other)

public ContainerSpec.Builder mergeFrom(ContainerSpec other)
Parameter
NameDescription
otherContainerSpec
Returns
TypeDescription
ContainerSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ContainerSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContainerSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ContainerSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ContainerSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ContainerSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ContainerSpec.Builder
Overrides

removeEnv(int index)

public ContainerSpec.Builder removeEnv(int index)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
ContainerSpec.Builder

setArgs(int index, String value)

public ContainerSpec.Builder setArgs(int index, String value)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The args to set.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

setCommand(int index, String value)

public ContainerSpec.Builder setCommand(int index, String value)

The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.

repeated string command = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The command to set.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

setEnv(int index, EnvVar value)

public ContainerSpec.Builder setEnv(int index, EnvVar value)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameters
NameDescription
indexint
valueEnvVar
Returns
TypeDescription
ContainerSpec.Builder

setEnv(int index, EnvVar.Builder builderForValue)

public ContainerSpec.Builder setEnv(int index, EnvVar.Builder builderForValue)

Environment variables to be passed to the container. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1.EnvVar env = 4;

Parameters
NameDescription
indexint
builderForValueEnvVar.Builder
Returns
TypeDescription
ContainerSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ContainerSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ContainerSpec.Builder
Overrides

setImageUri(String value)

public ContainerSpec.Builder setImageUri(String value)

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The imageUri to set.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public ContainerSpec.Builder setImageUriBytes(ByteString value)

Required. The URI of a container image in the Container Registry that is to be run on each worker replica.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for imageUri to set.

Returns
TypeDescription
ContainerSpec.Builder

This builder for chaining.

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

public ContainerSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ContainerSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ContainerSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ContainerSpec.Builder
Overrides