Struct CustomJob 

#[non_exhaustive]
pub struct CustomJob {

    pub name: String,
    pub display_name: String,
    pub job_spec: Option<CustomJobSpec>,
    pub state: JobState,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub error: Option<Status>,
    pub labels: HashMap<String, String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub web_access_uris: HashMap<String, String>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

Available on crate feature job-service only.

Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).

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. Resource name of a CustomJob.

display_name: String

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

job_spec: Option<CustomJobSpec>

Required. Job spec.

state: JobState

Output only. The detailed state of the job.

create_time: Option<Timestamp>

Output only. Time when the CustomJob was created.

start_time: Option<Timestamp>

Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.

end_time: Option<Timestamp>

Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

update_time: Option<Timestamp>

Output only. Time when the CustomJob was most recently updated.

error: Option<Status>

Output only. Only populated when job’s state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

labels: HashMap<String, String>

The labels with user-defined metadata to organize CustomJobs.

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.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.

web_access_uris: HashMap<String, String>

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is true.

The keys are names of each node in the training job; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool.

The values are the URIs for each node’s interactive shell.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl CustomJob

pub fn new() -> Self

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

Sets the value of name.

Example

let x = CustomJob::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 = CustomJob::new().set_display_name("example");

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

where T: Into<CustomJobSpec>,

Sets the value of job_spec.

Example

use google_cloud_aiplatform_v1::model::CustomJobSpec;
let x = CustomJob::new().set_job_spec(CustomJobSpec::default()/* use setters */);

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

where T: Into<CustomJobSpec>,

Sets or clears the value of job_spec.

Example

use google_cloud_aiplatform_v1::model::CustomJobSpec;
let x = CustomJob::new().set_or_clear_job_spec(Some(CustomJobSpec::default()/* use setters */));
let x = CustomJob::new().set_or_clear_job_spec(None::<CustomJobSpec>);

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

Sets the value of state.

Example

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

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 = CustomJob::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 = CustomJob::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = CustomJob::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 = CustomJob::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 = CustomJob::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = CustomJob::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 = CustomJob::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 = CustomJob::new().set_or_clear_end_time(Some(Timestamp::default()/* use setters */));
let x = CustomJob::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 = CustomJob::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 = CustomJob::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = CustomJob::new().set_or_clear_update_time(None::<Timestamp>);

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 = CustomJob::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 = CustomJob::new().set_or_clear_error(Some(Status::default()/* use setters */));
let x = CustomJob::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 = CustomJob::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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 = CustomJob::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 = CustomJob::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = CustomJob::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

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

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

Sets the value of web_access_uris.

Example

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

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

Sets the value of satisfies_pzs.

Example

let x = CustomJob::new().set_satisfies_pzs(true);

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

Sets the value of satisfies_pzi.

Example

let x = CustomJob::new().set_satisfies_pzi(true);

Trait Implementations

impl Clone for CustomJob

fn clone(&self) -> CustomJob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomJob

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

Formats the value using the given formatter.

impl Default for CustomJob

fn default() -> CustomJob

Returns the “default value” for a type.

impl Message for CustomJob

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CustomJob

fn eq(&self, other: &CustomJob) -> 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 CustomJob