Class ContainerSpec (3.43.0)

public final class ContainerSpec extends GeneratedMessageV3 implements ContainerSpecOrBuilder

The spec of a Container.

Protobuf type google.cloud.aiplatform.v1.ContainerSpec

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
Type Description
int

COMMAND_FIELD_NUMBER

public static final int COMMAND_FIELD_NUMBER
Field Value
Type Description
int

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ContainerSpec getDefaultInstance()
Returns
Type Description
ContainerSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ContainerSpec.Builder newBuilder()
Returns
Type Description
ContainerSpec.Builder

newBuilder(ContainerSpec prototype)

public static ContainerSpec.Builder newBuilder(ContainerSpec prototype)
Parameter
Name Description
prototype ContainerSpec
Returns
Type Description
ContainerSpec.Builder

parseDelimitedFrom(InputStream input)

public static ContainerSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ContainerSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ContainerSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ContainerSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ContainerSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ContainerSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ContainerSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ContainerSpec> parser()
Returns
Type Description
Parser<ContainerSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

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.

getParserForType()

public Parser<ContainerSpec> getParserForType()
Returns
Type Description
Parser<ContainerSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ContainerSpec.Builder newBuilderForType()
Returns
Type Description
ContainerSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ContainerSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ContainerSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ContainerSpec.Builder toBuilder()
Returns
Type Description
ContainerSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException