Interface PythonPackageSpecOrBuilder (3.5.0)

Version 3.5.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface PythonPackageSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArgs(int index)

public abstract 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.

getArgsBytes(int index)

public abstract 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.

getArgsCount()

public abstract int getArgsCount()

Command line arguments to be passed to the Python task.

repeated string args = 4;

Returns

Type	Description
int	The count of args.

getArgsList()

public abstract List<String> getArgsList()

Command line arguments to be passed to the Python task.

repeated string args = 4;

Returns

Type	Description
List<String>	A list containing the args.

getEnv(int index)

public abstract 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

Returns

Type	Description
EnvVar

getEnvCount()

public abstract int getEnvCount()

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

getEnvList()

public abstract 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

Type	Description
List<EnvVar>

getEnvOrBuilder(int index)

public abstract 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

Returns

Type	Description
EnvVarOrBuilder

getEnvOrBuilderList()

public abstract 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>

getExecutorImageUri()

public abstract 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.

getExecutorImageUriBytes()

public abstract 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.

getPackageUris(int index)

public abstract 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.

getPackageUrisBytes(int index)

public abstract 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.

getPackageUrisCount()

public abstract 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.

getPackageUrisList()

public abstract List<String> 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

Type	Description
List<String>	A list containing the packageUris.

getPythonModule()

public abstract 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.

getPythonModuleBytes()

public abstract 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.