Class PythonPackageSpec (3.18.0)

public final class PythonPackageSpec extends GeneratedMessageV3 implements PythonPackageSpecOrBuilder

The spec of a Python packaged code.

Protobuf type google.cloud.aiplatform.v1beta1.PythonPackageSpec

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
TypeDescription
int

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTOR_IMAGE_URI_FIELD_NUMBER

public static final int EXECUTOR_IMAGE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

PACKAGE_URIS_FIELD_NUMBER

public static final int PACKAGE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

PYTHON_MODULE_FIELD_NUMBER

public static final int PYTHON_MODULE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PythonPackageSpec getDefaultInstance()
Returns
TypeDescription
PythonPackageSpec

getDescriptor()

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

newBuilder()

public static PythonPackageSpec.Builder newBuilder()
Returns
TypeDescription
PythonPackageSpec.Builder

newBuilder(PythonPackageSpec prototype)

public static PythonPackageSpec.Builder newBuilder(PythonPackageSpec prototype)
Parameter
NameDescription
prototypePythonPackageSpec
Returns
TypeDescription
PythonPackageSpec.Builder

parseDelimitedFrom(InputStream input)

public static PythonPackageSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PythonPackageSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PythonPackageSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PythonPackageSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PythonPackageSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PythonPackageSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PythonPackageSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PythonPackageSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PythonPackageSpec> parser()
Returns
TypeDescription
Parser<PythonPackageSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getArgs(int index)

public String getArgs(int index)

Command line arguments to be passed to the Python task.

repeated string args = 4;

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)

Command line arguments to be passed to the Python task.

repeated string args = 4;

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

Command line arguments to be passed to the Python task.

repeated string args = 4;

Returns
TypeDescription
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

Command line arguments to be passed to the Python task.

repeated string args = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the args.

getDefaultInstanceForType()

public PythonPackageSpec getDefaultInstanceForType()
Returns
TypeDescription
PythonPackageSpec

getEnv(int index)

public EnvVar getEnv(int index)

Environment variables to be passed to the python module. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar

getEnvCount()

public int getEnvCount()

Environment variables to be passed to the python module. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;

Returns
TypeDescription
int

getEnvList()

public List<EnvVar> getEnvList()

Environment variables to be passed to the python module. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;

Returns
TypeDescription
List<EnvVar>

getEnvOrBuilder(int index)

public EnvVarOrBuilder getEnvOrBuilder(int index)

Environment variables to be passed to the python module. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVarOrBuilder

getEnvOrBuilderList()

public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

Environment variables to be passed to the python module. Maximum limit is 100.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;

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

getExecutorImageUri()

public String getExecutorImageUri()

Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of pre-built containers for training. You must use an image from this list.

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

Returns
TypeDescription
String

The executorImageUri.

getExecutorImageUriBytes()

public ByteString getExecutorImageUriBytes()

Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of pre-built containers for training. You must use an image from this list.

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

Returns
TypeDescription
ByteString

The bytes for executorImageUri.

getPackageUris(int index)

public String getPackageUris(int index)

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The packageUris at the given index.

getPackageUrisBytes(int index)

public ByteString getPackageUrisBytes(int index)

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the packageUris at the given index.

getPackageUrisCount()

public int getPackageUrisCount()

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of packageUris.

getPackageUrisList()

public ProtocolStringList getPackageUrisList()

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ProtocolStringList

A list containing the packageUris.

getParserForType()

public Parser<PythonPackageSpec> getParserForType()
Returns
TypeDescription
Parser<PythonPackageSpec>
Overrides

getPythonModule()

public String getPythonModule()

Required. The Python module name to run after installing the packages.

string python_module = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The pythonModule.

getPythonModuleBytes()

public ByteString getPythonModuleBytes()

Required. The Python module name to run after installing the packages.

string python_module = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for pythonModule.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PythonPackageSpec.Builder newBuilderForType()
Returns
TypeDescription
PythonPackageSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PythonPackageSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PythonPackageSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PythonPackageSpec.Builder toBuilder()
Returns
TypeDescription
PythonPackageSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException