public final class PythonPackageSpec extends GeneratedMessageV3 implements PythonPackageSpecOrBuilder
The spec of a Python packaged code.
Protobuf type google.cloud.aiplatform.v1beta1.PythonPackageSpec
Static Fields
public static final int ARGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENV_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXECUTOR_IMAGE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PACKAGE_URIS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PYTHON_MODULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static PythonPackageSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PythonPackageSpec.Builder newBuilder()
public static PythonPackageSpec.Builder newBuilder(PythonPackageSpec prototype)
public static PythonPackageSpec parseDelimitedFrom(InputStream input)
public static PythonPackageSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PythonPackageSpec parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static PythonPackageSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PythonPackageSpec parseFrom(ByteString data)
public static PythonPackageSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PythonPackageSpec parseFrom(CodedInputStream input)
public static PythonPackageSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PythonPackageSpec parseFrom(InputStream input)
public static PythonPackageSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PythonPackageSpec parseFrom(ByteBuffer data)
public static PythonPackageSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PythonPackageSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public String getArgs(int index)
Command line arguments to be passed to the Python task.
repeated string args = 4;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The args at the given index.
|
public ByteString getArgsBytes(int index)
Command line arguments to be passed to the Python task.
repeated string args = 4;
| 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.
|
public int getArgsCount()
Command line arguments to be passed to the Python task.
repeated string args = 4;
| Returns |
|---|
| Type | Description |
int | The count of args.
|
public ProtocolStringList getArgsList()
Command line arguments to be passed to the Python task.
repeated string args = 4;
public PythonPackageSpec getDefaultInstanceForType()
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 |
|---|
| Name | Description |
index | int
|
Environment variables to be passed to the python module.
Maximum limit is 100.
repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;
| Returns |
|---|
| Type | Description |
int | |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.EnvVarOrBuilder> | |
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 |
|---|
| Type | Description |
String | The executorImageUri.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for executorImageUri.
|
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 |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The packageUris at the given 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 |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the packageUris at the given index.
|
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 |
|---|
| Type | Description |
int | The count of packageUris.
|
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];
public Parser<PythonPackageSpec> getParserForType()
Overrides
public String getPythonModule()
Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The pythonModule.
|
public ByteString getPythonModuleBytes()
Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pythonModule.
|
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public PythonPackageSpec.Builder newBuilderForType()
protected PythonPackageSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public PythonPackageSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
