Struct Task 

#[non_exhaustive]
pub struct Task {
    pub name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub description: String,
    pub display_name: String,
    pub state: State,
    pub labels: HashMap<String, String>,
    pub trigger_spec: Option<TriggerSpec>,
    pub execution_spec: Option<ExecutionSpec>,
    pub execution_status: Option<ExecutionStatus>,
    pub config: Option<Config>,
    /* private fields */
}

A task represents a user-visible job.

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 relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.

uid: String

Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name.

create_time: Option<Timestamp>

Output only. The time when the task was created.

update_time: Option<Timestamp>

Output only. The time when the task was last updated.

description: String

Optional. Description of the task.

display_name: String

Optional. User friendly display name.

state: State

Output only. Current state of the task.

labels: HashMap<String, String>

Optional. User-defined labels for the task.

trigger_spec: Option<TriggerSpec>

Required. Spec related to how often and when a task should be triggered.

execution_spec: Option<ExecutionSpec>

Required. Spec related to how a task is executed.

execution_status: Option<ExecutionStatus>

Output only. Status of the latest task executions.

config: Option<Config>

Task template specific user-specified config.

Implementations

impl Task

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Task::new().set_name(format!("projects/{project_id}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}"));

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

Sets the value of uid.

Example

let x = Task::new().set_uid("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 = Task::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 = Task::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Task::new().set_or_clear_create_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 = Task::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 = Task::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Task::new().set_or_clear_update_time(None::<Timestamp>);

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

Sets the value of description.

Example

let x = Task::new().set_description("example");

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

Sets the value of display_name.

Example

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

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

Sets the value of state.

Example

use google_cloud_dataplex_v1::model::State;
let x0 = Task::new().set_state(State::Active);
let x1 = Task::new().set_state(State::Creating);
let x2 = Task::new().set_state(State::Deleting);

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 = Task::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<TriggerSpec>,

Sets the value of trigger_spec.

Example

use google_cloud_dataplex_v1::model::task::TriggerSpec;
let x = Task::new().set_trigger_spec(TriggerSpec::default()/* use setters */);

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

where T: Into<TriggerSpec>,

Sets or clears the value of trigger_spec.

Example

use google_cloud_dataplex_v1::model::task::TriggerSpec;
let x = Task::new().set_or_clear_trigger_spec(Some(TriggerSpec::default()/* use setters */));
let x = Task::new().set_or_clear_trigger_spec(None::<TriggerSpec>);

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

where T: Into<ExecutionSpec>,

Sets the value of execution_spec.

Example

use google_cloud_dataplex_v1::model::task::ExecutionSpec;
let x = Task::new().set_execution_spec(ExecutionSpec::default()/* use setters */);

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

where T: Into<ExecutionSpec>,

Sets or clears the value of execution_spec.

Example

use google_cloud_dataplex_v1::model::task::ExecutionSpec;
let x = Task::new().set_or_clear_execution_spec(Some(ExecutionSpec::default()/* use setters */));
let x = Task::new().set_or_clear_execution_spec(None::<ExecutionSpec>);

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

where T: Into<ExecutionStatus>,

Sets the value of execution_status.

Example

use google_cloud_dataplex_v1::model::task::ExecutionStatus;
let x = Task::new().set_execution_status(ExecutionStatus::default()/* use setters */);

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

where T: Into<ExecutionStatus>,

Sets or clears the value of execution_status.

Example

use google_cloud_dataplex_v1::model::task::ExecutionStatus;
let x = Task::new().set_or_clear_execution_status(Some(ExecutionStatus::default()/* use setters */));
let x = Task::new().set_or_clear_execution_status(None::<ExecutionStatus>);

pub fn set_config<T: Into<Option<Config>>>(self, v: T) -> Self

Sets the value of config.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::task::SparkTaskConfig;
let x = Task::new().set_config(Some(
    google_cloud_dataplex_v1::model::task::Config::Spark(SparkTaskConfig::default().into())));

pub fn spark(&self) -> Option<&Box<SparkTaskConfig>>

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

pub fn set_spark<T: Into<Box<SparkTaskConfig>>>(self, v: T) -> Self

Sets the value of config to hold a Spark.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::task::SparkTaskConfig;
let x = Task::new().set_spark(SparkTaskConfig::default()/* use setters */);
assert!(x.spark().is_some());
assert!(x.notebook().is_none());

pub fn notebook(&self) -> Option<&Box<NotebookTaskConfig>>

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

pub fn set_notebook<T: Into<Box<NotebookTaskConfig>>>(self, v: T) -> Self

Sets the value of config to hold a Notebook.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_dataplex_v1::model::task::NotebookTaskConfig;
let x = Task::new().set_notebook(NotebookTaskConfig::default()/* use setters */);
assert!(x.notebook().is_some());
assert!(x.spark().is_none());

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl Default for Task

fn default() -> Task

Returns the “default value” for a type.

impl Message for Task

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Task

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Task