Struct NotebookExecutionJob 

#[non_exhaustive]
pub struct NotebookExecutionJob {

    pub name: String,
    pub display_name: String,
    pub execution_timeout: Option<Duration>,
    pub schedule_resource_name: String,
    pub job_state: JobState,
    pub status: Option<Status>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub kernel_name: 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>,
    pub runtime_environment: Option<RuntimeEnvironment>,
    /* private fields */
}

NotebookExecutionJob represents an instance of a notebook execution.

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

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

job_state: JobState

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: HashMap<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.

kernel_name: String

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the 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.

runtime_environment: Option<RuntimeEnvironment>

Runtime environment for the notebook execution job. If unspecified, the default runtime of Colab is used.

Implementations

impl NotebookExecutionJob

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of display_name.

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

where T: Into<Duration>,

Sets the value of execution_timeout.

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

where T: Into<Duration>,

Sets or clears the value of execution_timeout.

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

Sets the value of schedule_resource_name.

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

Sets the value of job_state.

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

where T: Into<Status>,

Sets the value of status.

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

where T: Into<Status>,

Sets or clears the value of status.

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

where T: Into<Timestamp>,

Sets the value of create_time.

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.

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

where T: Into<Timestamp>,

Sets the value of update_time.

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.

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.

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

Sets the value of kernel_name.

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

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

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.

pub fn set_notebook_source<T: Into<Option<NotebookSource>>>(self, v: T) -> Self

Sets the value of notebook_source.

Note that all the setters affecting notebook_source are mutually exclusive.

pub fn dataform_repository_source( &self, ) -> Option<&Box<DataformRepositorySource>>

The value of notebook_source if it holds a DataformRepositorySource, None if the field is not set or holds a different branch.

pub fn set_dataform_repository_source<T: Into<Box<DataformRepositorySource>>>( self, v: T, ) -> Self

Sets the value of notebook_source to hold a DataformRepositorySource.

Note that all the setters affecting notebook_source are mutually exclusive.

pub fn gcs_notebook_source(&self) -> Option<&Box<GcsNotebookSource>>

The value of notebook_source if it holds a GcsNotebookSource, None if the field is not set or holds a different branch.

pub fn set_gcs_notebook_source<T: Into<Box<GcsNotebookSource>>>( self, v: T, ) -> Self

Sets the value of notebook_source to hold a GcsNotebookSource.

Note that all the setters affecting notebook_source are mutually exclusive.

pub fn direct_notebook_source(&self) -> Option<&Box<DirectNotebookSource>>

The value of notebook_source if it holds a DirectNotebookSource, None if the field is not set or holds a different branch.

pub fn set_direct_notebook_source<T: Into<Box<DirectNotebookSource>>>( self, v: T, ) -> Self

Sets the value of notebook_source to hold a DirectNotebookSource.

Note that all the setters affecting notebook_source are mutually exclusive.

pub fn set_environment_spec<T: Into<Option<EnvironmentSpec>>>( self, v: T, ) -> Self

Sets the value of environment_spec.

Note that all the setters affecting environment_spec are mutually exclusive.

pub fn notebook_runtime_template_resource_name(&self) -> Option<&String>

The value of environment_spec if it holds a NotebookRuntimeTemplateResourceName, None if the field is not set or holds a different branch.

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

Sets the value of environment_spec to hold a NotebookRuntimeTemplateResourceName.

Note that all the setters affecting environment_spec are mutually exclusive.

pub fn custom_environment_spec(&self) -> Option<&Box<CustomEnvironmentSpec>>

The value of environment_spec if it holds a CustomEnvironmentSpec, None if the field is not set or holds a different branch.

pub fn set_custom_environment_spec<T: Into<Box<CustomEnvironmentSpec>>>( self, v: T, ) -> Self

Sets the value of environment_spec to hold a CustomEnvironmentSpec.

Note that all the setters affecting environment_spec are mutually exclusive.

pub fn set_execution_sink<T: Into<Option<ExecutionSink>>>(self, v: T) -> Self

Sets the value of execution_sink.

Note that all the setters affecting execution_sink are mutually exclusive.

pub fn gcs_output_uri(&self) -> Option<&String>

The value of execution_sink if it holds a GcsOutputUri, None if the field is not set or holds a different branch.

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

Sets the value of execution_sink to hold a GcsOutputUri.

Note that all the setters affecting execution_sink are mutually exclusive.

pub fn set_execution_identity<T: Into<Option<ExecutionIdentity>>>( self, v: T, ) -> Self

Sets the value of execution_identity.

Note that all the setters affecting execution_identity are mutually exclusive.

pub fn execution_user(&self) -> Option<&String>

The value of execution_identity if it holds a ExecutionUser, None if the field is not set or holds a different branch.

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

Sets the value of execution_identity to hold a ExecutionUser.

Note that all the setters affecting execution_identity are mutually exclusive.

pub fn service_account(&self) -> Option<&String>

The value of execution_identity if it holds a ServiceAccount, None if the field is not set or holds a different branch.

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

Sets the value of execution_identity to hold a ServiceAccount.

Note that all the setters affecting execution_identity are mutually exclusive.

pub fn set_runtime_environment<T: Into<Option<RuntimeEnvironment>>>( self, v: T, ) -> Self

Sets the value of runtime_environment.

Note that all the setters affecting runtime_environment are mutually exclusive.

pub fn workbench_runtime(&self) -> Option<&Box<WorkbenchRuntime>>

The value of runtime_environment if it holds a WorkbenchRuntime, None if the field is not set or holds a different branch.

pub fn set_workbench_runtime<T: Into<Box<WorkbenchRuntime>>>(self, v: T) -> Self

Sets the value of runtime_environment to hold a WorkbenchRuntime.

Note that all the setters affecting runtime_environment are mutually exclusive.

Trait Implementations

impl Clone for NotebookExecutionJob

fn clone(&self) -> NotebookExecutionJob

Returns a duplicate 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() -> NotebookExecutionJob

Returns the “default value” for a type.

impl Message for NotebookExecutionJob

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NotebookExecutionJob

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