Class ContainerSpec.Builder (3.24.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ContainerSpec.Builder

Implements

ContainerSpecOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

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)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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

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
Name	Description
`values`	`Iterable<String>` The args to add.

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<String>` The command to add.

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<? extends com.google.cloud.aiplatform.v1.EnvVar>`

Returns
Type	Description
`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
Name	Description
`value`	`String` The args to add.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes of the args to add.

Returns
Type	Description
`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
Name	Description
`value`	`String` The command to add.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes of the command to add.

Returns
Type	Description
`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
Name	Description
`value`	`EnvVar`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`EnvVar.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`EnvVar`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`EnvVar.Builder`

Returns
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`EnvVar.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ContainerSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

build()

public ContainerSpec build()

Returns
Type	Description
`ContainerSpec`

buildPartial()

public ContainerSpec buildPartial()

Returns
Type	Description
`ContainerSpec`

clear()

public ContainerSpec.Builder clear()

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArgs()

public ContainerSpec.Builder clearArgs()

The arguments to be passed when starting the container.

repeated string args = 3;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`ContainerSpec.Builder`

clearField(Descriptors.FieldDescriptor field)

public ContainerSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

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
Type	Description
`ContainerSpec.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ContainerSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

clone()

public ContainerSpec.Builder clone()

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getArgs(int index)

public String getArgs(int index)

The arguments to be passed when starting the container.

repeated string args = 3;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`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
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`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
Type	Description
`int`	The count of args.

getArgsList()

public ProtocolStringList getArgsList()

The arguments to be passed when starting the container.

repeated string args = 3;

Returns
Type	Description
`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
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`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
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`ProtocolStringList`	A list containing the command.

getDefaultInstanceForType()

public ContainerSpec getDefaultInstanceForType()

Returns
Type	Description
`ContainerSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`ByteString`	The bytes for imageUri.

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(ContainerSpec other)

public ContainerSpec.Builder mergeFrom(ContainerSpec other)

Parameter
Name	Description
`other`	`ContainerSpec`

Returns
Type	Description
`ContainerSpec.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ContainerSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ContainerSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ContainerSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The args to set.

Returns
Type	Description
`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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The command to set.

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`EnvVar`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`EnvVar.Builder`

Returns
Type	Description
`ContainerSpec.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ContainerSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

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
Name	Description
`value`	`String` The imageUri to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for imageUri to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final ContainerSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ContainerSpec.Builder`

Overrides

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