Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PythonPackageSpec.
The spec of a Python packaged code.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.PythonPackageSpec
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ executor_image_uri
string
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 ofpre-built containers for training. You must use an image from this list.
↳ package_uris
array
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.
↳ python_module
string
Required. The Python module name to run after installing the packages.
↳ args
array
Command line arguments to be passed to the Python task.
Environment variables to be passed to the python module. Maximum limit is 100.
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 ofpre-built containers for
training.
You must use an image from this list.
Returns
Type
Description
string
setExecutorImageUri
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 ofpre-built containers for
training.
You must use an image from this list.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPackageUris
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getPythonModule
Required. The Python module name to run after installing the packages.
Returns
Type
Description
string
setPythonModule
Required. The Python module name to run after installing the packages.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getArgs
Command line arguments to be passed to the Python task.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class PythonPackageSpec (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.PythonPackageSpec)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.PythonPackageSpec)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.PythonPackageSpec)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.PythonPackageSpec)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.PythonPackageSpec)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.PythonPackageSpec)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.PythonPackageSpec)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.PythonPackageSpec)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.PythonPackageSpec)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.PythonPackageSpec)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.PythonPackageSpec)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.PythonPackageSpec)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.PythonPackageSpec)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.PythonPackageSpec)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.PythonPackageSpec)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.PythonPackageSpec)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.PythonPackageSpec)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.PythonPackageSpec)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.PythonPackageSpec)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.PythonPackageSpec)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.PythonPackageSpec)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.PythonPackageSpec)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.PythonPackageSpec)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.PythonPackageSpec)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.PythonPackageSpec)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.PythonPackageSpec)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.PythonPackageSpec)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.PythonPackageSpec)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.PythonPackageSpec)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.PythonPackageSpec)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.PythonPackageSpec)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.PythonPackageSpec)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.PythonPackageSpec)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.PythonPackageSpec)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.PythonPackageSpec)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.PythonPackageSpec)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.PythonPackageSpec)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.PythonPackageSpec)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.PythonPackageSpec)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.PythonPackageSpec)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.PythonPackageSpec)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.PythonPackageSpec)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.PythonPackageSpec)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.PythonPackageSpec)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.PythonPackageSpec)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.PythonPackageSpec)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.PythonPackageSpec)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.PythonPackageSpec)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.PythonPackageSpec)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.PythonPackageSpec)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.PythonPackageSpec)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.PythonPackageSpec)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.PythonPackageSpec)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.PythonPackageSpec)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.PythonPackageSpec)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.PythonPackageSpec) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class PythonPackageSpec.\n\nThe spec of a Python packaged code.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.PythonPackageSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getExecutorImageUri\n\nRequired. The URI of a container image in Artifact Registry that will run\nthe provided Python package. Vertex AI provides a wide range of executor\nimages with pre-installed packages to meet users' various use cases. See\nthe list of [pre-built containers for\ntraining](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).\n\nYou must use an image from this list.\n\n### setExecutorImageUri\n\nRequired. The URI of a container image in Artifact Registry that will run\nthe provided Python package. Vertex AI provides a wide range of executor\nimages with pre-installed packages to meet users' various use cases. See\nthe list of [pre-built containers for\ntraining](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).\n\nYou must use an image from this list.\n\n### getPackageUris\n\nRequired. The Google Cloud Storage location of the Python package files\nwhich are the training program and its dependent packages. The maximum\nnumber of package URIs is 100.\n\n### setPackageUris\n\nRequired. The Google Cloud Storage location of the Python package files\nwhich are the training program and its dependent packages. The maximum\nnumber of package URIs is 100.\n\n### getPythonModule\n\nRequired. The Python module name to run after installing the packages.\n\n### setPythonModule\n\nRequired. The Python module name to run after installing the packages.\n\n### getArgs\n\nCommand line arguments to be passed to the Python task.\n\n### setArgs\n\nCommand line arguments to be passed to the Python task.\n\n### getEnv\n\nEnvironment variables to be passed to the python module.\n\nMaximum limit is 100.\n\n### setEnv\n\nEnvironment variables to be passed to the python module.\n\nMaximum limit is 100."]]
