Struct PythonPackageSpec 

#[non_exhaustive]
pub struct PythonPackageSpec {
    pub executor_image_uri: String,
    pub package_uris: Vec<String>,
    pub python_module: String,
    pub args: Vec<String>,
    pub env: Vec<EnvVar>,
    /* private fields */
}

Available on crate feature job-service only.

The spec of a Python packaged code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 of pre-built containers for training. You must use an image from this list.

package_uris: Vec<String>

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: Vec<String>

Command line arguments to be passed to the Python task.

env: Vec<EnvVar>

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

Implementations

impl PythonPackageSpec

pub fn new() -> Self

Creates a new default instance.

pub fn set_executor_image_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of executor_image_uri.

Example

let x = PythonPackageSpec::new().set_executor_image_uri("example");

pub fn set_package_uris<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of package_uris.

Example

let x = PythonPackageSpec::new().set_package_uris(["a", "b", "c"]);

pub fn set_python_module<T: Into<String>>(self, v: T) -> Self

Sets the value of python_module.

Example

let x = PythonPackageSpec::new().set_python_module("example");

pub fn set_args<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of args.

Example

let x = PythonPackageSpec::new().set_args(["a", "b", "c"]);

pub fn set_env<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EnvVar>,

Sets the value of env.

Example

use google_cloud_aiplatform_v1::model::EnvVar;
let x = PythonPackageSpec::new()
    .set_env([
        EnvVar::default()/* use setters */,
        EnvVar::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for PythonPackageSpec

fn clone(&self) -> PythonPackageSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PythonPackageSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PythonPackageSpec

fn default() -> PythonPackageSpec

Returns the “default value” for a type.

impl Message for PythonPackageSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PythonPackageSpec

fn eq(&self, other: &PythonPackageSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PythonPackageSpec