ContainerSpec.Builder (proto-google-cloud-aiplatform-v1 3.44.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>
    - - com.google.cloud.aiplatform.v1.ContainerSpec.Builder

All Implemented Interfaces:

ContainerSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ContainerSpec
```
public static final class ContainerSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>
implements ContainerSpecOrBuilder
```
```
 The spec of a Container.
 
```
Protobuf type google.cloud.aiplatform.v1.ContainerSpec

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerSpec.Builder`	`addAllArgs(Iterable<String> values)` The arguments to be passed when starting the container.
`ContainerSpec.Builder`	`addAllCommand(Iterable<String> values)` The command to be invoked when the container is started.
`ContainerSpec.Builder`	`addAllEnv(Iterable<? extends EnvVar> values)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`addArgs(String value)` The arguments to be passed when starting the container.
`ContainerSpec.Builder`	`addArgsBytes(com.google.protobuf.ByteString value)` The arguments to be passed when starting the container.
`ContainerSpec.Builder`	`addCommand(String value)` The command to be invoked when the container is started.
`ContainerSpec.Builder`	`addCommandBytes(com.google.protobuf.ByteString value)` The command to be invoked when the container is started.
`ContainerSpec.Builder`	`addEnv(EnvVar.Builder builderForValue)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`addEnv(EnvVar value)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`addEnv(int index, EnvVar.Builder builderForValue)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`addEnv(int index, EnvVar value)` Environment variables to be passed to the container.
`EnvVar.Builder`	`addEnvBuilder()` Environment variables to be passed to the container.
`EnvVar.Builder`	`addEnvBuilder(int index)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ContainerSpec`	`build()`
`ContainerSpec`	`buildPartial()`
`ContainerSpec.Builder`	`clear()`
`ContainerSpec.Builder`	`clearArgs()` The arguments to be passed when starting the container.
`ContainerSpec.Builder`	`clearCommand()` The command to be invoked when the container is started.
`ContainerSpec.Builder`	`clearEnv()` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ContainerSpec.Builder`	`clearImageUri()` Required.
`ContainerSpec.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ContainerSpec.Builder`	`clone()`
`String`	`getArgs(int index)` The arguments to be passed when starting the container.
`com.google.protobuf.ByteString`	`getArgsBytes(int index)` The arguments to be passed when starting the container.
`int`	`getArgsCount()` The arguments to be passed when starting the container.
`com.google.protobuf.ProtocolStringList`	`getArgsList()` The arguments to be passed when starting the container.
`String`	`getCommand(int index)` The command to be invoked when the container is started.
`com.google.protobuf.ByteString`	`getCommandBytes(int index)` The command to be invoked when the container is started.
`int`	`getCommandCount()` The command to be invoked when the container is started.
`com.google.protobuf.ProtocolStringList`	`getCommandList()` The command to be invoked when the container is started.
`ContainerSpec`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`EnvVar`	`getEnv(int index)` Environment variables to be passed to the container.
`EnvVar.Builder`	`getEnvBuilder(int index)` Environment variables to be passed to the container.
`List<EnvVar.Builder>`	`getEnvBuilderList()` Environment variables to be passed to the container.
`int`	`getEnvCount()` Environment variables to be passed to the container.
`List<EnvVar>`	`getEnvList()` Environment variables to be passed to the container.
`EnvVarOrBuilder`	`getEnvOrBuilder(int index)` Environment variables to be passed to the container.
`List<? extends EnvVarOrBuilder>`	`getEnvOrBuilderList()` Environment variables to be passed to the container.
`String`	`getImageUri()` Required.
`com.google.protobuf.ByteString`	`getImageUriBytes()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ContainerSpec.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ContainerSpec.Builder`	`mergeFrom(ContainerSpec other)`
`ContainerSpec.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ContainerSpec.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ContainerSpec.Builder`	`removeEnv(int index)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`setArgs(int index, String value)` The arguments to be passed when starting the container.
`ContainerSpec.Builder`	`setCommand(int index, String value)` The command to be invoked when the container is started.
`ContainerSpec.Builder`	`setEnv(int index, EnvVar.Builder builderForValue)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`setEnv(int index, EnvVar value)` Environment variables to be passed to the container.
`ContainerSpec.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ContainerSpec.Builder`	`setImageUri(String value)` Required.
`ContainerSpec.Builder`	`setImageUriBytes(com.google.protobuf.ByteString value)` Required.
`ContainerSpec.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ContainerSpec.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

clear
```
public ContainerSpec.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

getDefaultInstanceForType
```
public ContainerSpec getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ContainerSpec build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ContainerSpec buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ContainerSpec.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

setField

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

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

clearField
```
public ContainerSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

clearOneof
```
public ContainerSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

setRepeatedField

public ContainerSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

addRepeatedField

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

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

mergeFrom
```
public ContainerSpec.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ContainerSpec.Builder>

mergeFrom

public ContainerSpec.Builder mergeFrom(ContainerSpec other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ContainerSpec.Builder>

mergeFrom
```
public ContainerSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ContainerSpec.Builder>

Throws:

IOException

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];
Specified by:

getImageUri in interface ContainerSpecOrBuilder

Returns:

The imageUri.

getImageUriBytes
```
public com.google.protobuf.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];
Specified by:

getImageUriBytes in interface ContainerSpecOrBuilder

Returns:

The bytes for imageUri.

setImageUri

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];

Parameters:: value - The imageUri to set.
Returns:: This builder for chaining.

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:: This builder for chaining.

setImageUriBytes

public ContainerSpec.Builder setImageUriBytes(com.google.protobuf.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];

Parameters:: value - The bytes for imageUri to set.
Returns:: This builder for chaining.

getCommandList

public com.google.protobuf.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;

Specified by:: getCommandList in interface ContainerSpecOrBuilder
Returns:: A list containing the command.

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;

Specified by:: getCommandCount in interface ContainerSpecOrBuilder
Returns:: The count of command.

getCommand
```
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;
Specified by:

getCommand in interface ContainerSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The command at the given index.

getCommandBytes
```
public com.google.protobuf.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;
Specified by:

getCommandBytes in interface ContainerSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the command at the given index.

setCommand

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:: index - The index to set the value at.; value - The command to set.
Returns:: This builder for chaining.

addCommand

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;

Parameters:: value - The command to add.
Returns:: This builder for chaining.

addAllCommand

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;

Parameters:: values - The command to add.
Returns:: 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:: This builder for chaining.

addCommandBytes

public ContainerSpec.Builder addCommandBytes(com.google.protobuf.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;

Parameters:: value - The bytes of the command to add.
Returns:: This builder for chaining.

getArgsList
```
public com.google.protobuf.ProtocolStringList getArgsList()
```
```
 The arguments to be passed when starting the container.
 
```
repeated string args = 3;
Specified by:

getArgsList in interface ContainerSpecOrBuilder

Returns:

A list containing the args.

getArgsCount
```
public int getArgsCount()
```
```
 The arguments to be passed when starting the container.
 
```
repeated string args = 3;
Specified by:

getArgsCount in interface ContainerSpecOrBuilder

Returns:

The count of args.

getArgs
```
public String getArgs(int index)
```
```
 The arguments to be passed when starting the container.
 
```
repeated string args = 3;
Specified by:

getArgs in interface ContainerSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The args at the given index.

getArgsBytes
```
public com.google.protobuf.ByteString getArgsBytes(int index)
```
```
 The arguments to be passed when starting the container.
 
```
repeated string args = 3;
Specified by:

getArgsBytes in interface ContainerSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the args at the given index.

setArgs

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

 The arguments to be passed when starting the container.

repeated string args = 3;

Parameters:: index - The index to set the value at.; value - The args to set.
Returns:: This builder for chaining.

addArgs

public ContainerSpec.Builder addArgs(String value)

 The arguments to be passed when starting the container.

repeated string args = 3;

Parameters:: value - The args to add.
Returns:: This builder for chaining.

addAllArgs

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

 The arguments to be passed when starting the container.

repeated string args = 3;

Parameters:: values - The args to add.
Returns:: This builder for chaining.

clearArgs

public ContainerSpec.Builder clearArgs()

 The arguments to be passed when starting the container.

repeated string args = 3;

Returns:: This builder for chaining.

addArgsBytes

public ContainerSpec.Builder addArgsBytes(com.google.protobuf.ByteString value)

 The arguments to be passed when starting the container.

repeated string args = 3;

Parameters:: value - The bytes of the args to add.
Returns:: This builder for chaining.

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;
Specified by:

getEnvList in interface ContainerSpecOrBuilder

getEnvCount
```
public int getEnvCount()
```
```
 Environment variables to be passed to the container.
 Maximum limit is 100.
 
```
repeated .google.cloud.aiplatform.v1.EnvVar env = 4;
Specified by:

getEnvCount in interface ContainerSpecOrBuilder