Struct PipelineJob 

#[non_exhaustive]
pub struct PipelineJob {

    pub name: String,
    pub display_name: String,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub pipeline_spec: Option<Struct>,
    pub state: PipelineState,
    pub job_detail: Option<PipelineJobDetail>,
    pub error: Option<Status>,
    pub labels: HashMap<String, String>,
    pub runtime_config: Option<RuntimeConfig>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub service_account: String,
    pub network: String,
    pub reserved_ip_ranges: Vec<String>,
    pub psc_interface_config: Option<PscInterfaceConfig>,
    pub template_uri: String,
    pub template_metadata: Option<PipelineTemplateMetadata>,
    pub schedule_name: String,
    pub preflight_validations: bool,
    /* private fields */
}

Available on crate features pipeline-service or schedule-service only.

An instance of a machine learning PipelineJob.

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.

name: String

Output only. The resource name of the PipelineJob.

display_name: String

The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.

create_time: Option<Timestamp>

Output only. Pipeline creation time.

start_time: Option<Timestamp>

Output only. Pipeline start time.

end_time: Option<Timestamp>

Output only. Pipeline end time.

update_time: Option<Timestamp>

Output only. Timestamp when this PipelineJob was most recently updated.

pipeline_spec: Option<Struct>

The spec of the pipeline.

state: PipelineState

Output only. The detailed state of the job.

job_detail: Option<PipelineJobDetail>

Output only. The details of pipeline run. Not available in the list view.

error: Option<Status>

Output only. The error that occurred during pipeline execution. Only populated when the pipeline’s state is FAILED or CANCELLED.

labels: HashMap<String, String>

The labels with user-defined metadata to organize PipelineJob.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

Note there is some reserved label key for Vertex AI Pipelines.

• vertex-ai-pipelines-run-billing-id, user set value will get overrided.

runtime_config: Option<RuntimeConfig>

Runtime config of the pipeline.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.

service_account: String

The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account

Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.

network: String

The full name of the Compute Engine network to which the Pipeline Job’s workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.

Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.

reserved_ip_ranges: Vec<String>

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job’s workload.

If set, we will deploy the Pipeline Job’s workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: [‘vertex-ai-ip-range’].

psc_interface_config: Option<PscInterfaceConfig>

Optional. Configuration for PSC-I for PipelineJob.

template_uri: String

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.

template_metadata: Option<PipelineTemplateMetadata>

Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.

schedule_name: String

Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.

preflight_validations: bool

Optional. Whether to do component level validations before job creation.

Implementations

impl PipelineJob

pub fn new() -> Self

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

Sets the value of name.

Example

let x = PipelineJob::new().set_name("example");

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

Sets the value of display_name.

Example

let x = PipelineJob::new().set_display_name("example");

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_start_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_end_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_end_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_or_clear_end_time(Some(Timestamp::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_end_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = PipelineJob::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_update_time(None::<Timestamp>);

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

where T: Into<Struct>,

Sets the value of pipeline_spec.

Example

use wkt::Struct;
let x = PipelineJob::new().set_pipeline_spec(Struct::default()/* use setters */);

pub fn set_or_clear_pipeline_spec<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of pipeline_spec.

Example

use wkt::Struct;
let x = PipelineJob::new().set_or_clear_pipeline_spec(Some(Struct::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_pipeline_spec(None::<Struct>);

pub fn set_state<T: Into<PipelineState>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_aiplatform_v1::model::PipelineState;
let x0 = PipelineJob::new().set_state(PipelineState::Queued);
let x1 = PipelineJob::new().set_state(PipelineState::Pending);
let x2 = PipelineJob::new().set_state(PipelineState::Running);

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

where T: Into<PipelineJobDetail>,

Sets the value of job_detail.

Example

use google_cloud_aiplatform_v1::model::PipelineJobDetail;
let x = PipelineJob::new().set_job_detail(PipelineJobDetail::default()/* use setters */);

pub fn set_or_clear_job_detail<T>(self, v: Option<T>) -> Self

where T: Into<PipelineJobDetail>,

Sets or clears the value of job_detail.

Example

use google_cloud_aiplatform_v1::model::PipelineJobDetail;
let x = PipelineJob::new().set_or_clear_job_detail(Some(PipelineJobDetail::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_job_detail(None::<PipelineJobDetail>);

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

where T: Into<Status>,

Sets the value of error.

Example

use rpc::model::Status;
let x = PipelineJob::new().set_error(Status::default()/* use setters */);

pub fn set_or_clear_error<T>(self, v: Option<T>) -> Self

where T: Into<Status>,

Sets or clears the value of error.

Example

use rpc::model::Status;
let x = PipelineJob::new().set_or_clear_error(Some(Status::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_error(None::<Status>);

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

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

Sets the value of labels.

Example

let x = PipelineJob::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<RuntimeConfig>,

Sets the value of runtime_config.

Example

use google_cloud_aiplatform_v1::model::pipeline_job::RuntimeConfig;
let x = PipelineJob::new().set_runtime_config(RuntimeConfig::default()/* use setters */);

pub fn set_or_clear_runtime_config<T>(self, v: Option<T>) -> Self

where T: Into<RuntimeConfig>,

Sets or clears the value of runtime_config.

Example

use google_cloud_aiplatform_v1::model::pipeline_job::RuntimeConfig;
let x = PipelineJob::new().set_or_clear_runtime_config(Some(RuntimeConfig::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_runtime_config(None::<RuntimeConfig>);

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

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = PipelineJob::new().set_encryption_spec(EncryptionSpec::default()/* use setters */);

pub fn set_or_clear_encryption_spec<T>(self, v: Option<T>) -> Self

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = PipelineJob::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

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

Sets the value of service_account.

Example

let x = PipelineJob::new().set_service_account("example");

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

Sets the value of network.

Example

let x = PipelineJob::new().set_network("example");

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

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

Sets the value of reserved_ip_ranges.

Example

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

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

where T: Into<PscInterfaceConfig>,

Sets the value of psc_interface_config.

Example

use google_cloud_aiplatform_v1::model::PscInterfaceConfig;
let x = PipelineJob::new().set_psc_interface_config(PscInterfaceConfig::default()/* use setters */);

pub fn set_or_clear_psc_interface_config<T>(self, v: Option<T>) -> Self

where T: Into<PscInterfaceConfig>,

Sets or clears the value of psc_interface_config.

Example

use google_cloud_aiplatform_v1::model::PscInterfaceConfig;
let x = PipelineJob::new().set_or_clear_psc_interface_config(Some(PscInterfaceConfig::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_psc_interface_config(None::<PscInterfaceConfig>);

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

Sets the value of template_uri.

Example

let x = PipelineJob::new().set_template_uri("example");

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

where T: Into<PipelineTemplateMetadata>,

Sets the value of template_metadata.

Example

use google_cloud_aiplatform_v1::model::PipelineTemplateMetadata;
let x = PipelineJob::new().set_template_metadata(PipelineTemplateMetadata::default()/* use setters */);

pub fn set_or_clear_template_metadata<T>(self, v: Option<T>) -> Self

where T: Into<PipelineTemplateMetadata>,

Sets or clears the value of template_metadata.

Example

use google_cloud_aiplatform_v1::model::PipelineTemplateMetadata;
let x = PipelineJob::new().set_or_clear_template_metadata(Some(PipelineTemplateMetadata::default()/* use setters */));
let x = PipelineJob::new().set_or_clear_template_metadata(None::<PipelineTemplateMetadata>);

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

Sets the value of schedule_name.

Example

let x = PipelineJob::new().set_schedule_name("example");

pub fn set_preflight_validations<T: Into<bool>>(self, v: T) -> Self

Sets the value of preflight_validations.

Example

let x = PipelineJob::new().set_preflight_validations(true);

Trait Implementations

impl Clone for PipelineJob

fn clone(&self) -> PipelineJob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineJob

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

Formats the value using the given formatter.

impl Default for PipelineJob

fn default() -> PipelineJob

Returns the “default value” for a type.

impl Message for PipelineJob

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PipelineJob

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipelineJob