Struct google_api_proto::google::cloud::aiplatform::v1::NotebookExecutionJob

pub struct NotebookExecutionJob {

    pub name: String,
    pub display_name: String,
    pub execution_timeout: Option<Duration>,
    pub schedule_resource_name: String,
    pub job_state: i32,
    pub status: Option<Status>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: BTreeMap<String, String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub notebook_source: Option<NotebookSource>,
    pub environment_spec: Option<EnvironmentSpec>,
    pub execution_sink: Option<ExecutionSink>,
    pub execution_identity: Option<ExecutionIdentity>,
}

NotebookExecutionJob represents an instance of a notebook execution.

Fields

name: String

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

display_name: String

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

execution_timeout: Option<Duration>

Max running time of the execution job in seconds (default 86400s / 24 hrs).

schedule_resource_name: String

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

job_state: i32

Output only. The state of the NotebookExecutionJob.

status: Option<Status>

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

create_time: Option<Timestamp>

Output only. Timestamp when this NotebookExecutionJob was created.

update_time: Option<Timestamp>

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

labels: BTreeMap<String, String>

The labels with user-defined metadata to organize NotebookExecutionJobs.

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. System reserved label keys are prefixed with “aiplatform.googleapis.com/” and are immutable.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.

notebook_source: Option<NotebookSource>

The input notebook.

environment_spec: Option<EnvironmentSpec>

The compute config to use for an execution job.

execution_sink: Option<ExecutionSink>

The location to store the notebook execution result.

execution_identity: Option<ExecutionIdentity>

The identity to run the execution as.

Implementations

impl NotebookExecutionJob

pub fn job_state(&self) -> JobState

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

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

Sets job_state to the provided enum value.

Trait Implementations

impl Clone for NotebookExecutionJob

fn clone(&self) -> NotebookExecutionJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookExecutionJob

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

Formats the value using the given formatter.

impl Default for NotebookExecutionJob

fn default() -> Self

Returns the “default value” for a type.

impl Message for NotebookExecutionJob

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 NotebookExecutionJob

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