Struct google_api_proto::google::cloud::aiplatform::v1::CustomJob

pub struct CustomJob {

    pub name: String,
    pub display_name: String,
    pub job_spec: Option<CustomJobSpec>,
    pub state: i32,
    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: BTreeMap<String, String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub web_access_uris: BTreeMap<String, String>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
}

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

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: i32

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: BTreeMap<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: BTreeMap<String, String>

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.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 state(&self) -> JobState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: JobState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for CustomJob

fn clone(&self) -> CustomJob

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for CustomJob

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CustomJob

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CustomJob