Struct WorkflowInvocationAction 

#[non_exhaustive]
pub struct WorkflowInvocationAction {
    pub target: Option<Target>,
    pub canonical_target: Option<Target>,
    pub state: State,
    pub failure_reason: String,
    pub invocation_timing: Option<Interval>,
    pub internal_metadata: Option<String>,
    pub action: Option<Action>,
    /* private fields */
}

Represents a single action in a workflow invocation.

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.

target: Option<Target>

Output only. This action’s identifier. Unique within the workflow invocation.

canonical_target: Option<Target>

Output only. The action’s identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

state: State

Output only. This action’s current state.

failure_reason: String

Output only. If and only if action’s state is FAILED a failure reason is set.

invocation_timing: Option<Interval>

Output only. This action’s timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.

internal_metadata: Option<String>

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

action: Option<Action>

The action’s details.

Implementations

impl WorkflowInvocationAction

pub fn new() -> Self

Creates a new default instance.

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

where T: Into<Target>,

Sets the value of target.

Example

use google_cloud_dataform_v1::model::Target;
let x = WorkflowInvocationAction::new().set_target(Target::default()/* use setters */);

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

where T: Into<Target>,

Sets or clears the value of target.

Example

use google_cloud_dataform_v1::model::Target;
let x = WorkflowInvocationAction::new().set_or_clear_target(Some(Target::default()/* use setters */));
let x = WorkflowInvocationAction::new().set_or_clear_target(None::<Target>);

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

where T: Into<Target>,

Sets the value of canonical_target.

Example

use google_cloud_dataform_v1::model::Target;
let x = WorkflowInvocationAction::new().set_canonical_target(Target::default()/* use setters */);

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

where T: Into<Target>,

Sets or clears the value of canonical_target.

Example

use google_cloud_dataform_v1::model::Target;
let x = WorkflowInvocationAction::new().set_or_clear_canonical_target(Some(Target::default()/* use setters */));
let x = WorkflowInvocationAction::new().set_or_clear_canonical_target(None::<Target>);

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

Sets the value of state.

Example

use google_cloud_dataform_v1::model::workflow_invocation_action::State;
let x0 = WorkflowInvocationAction::new().set_state(State::Running);
let x1 = WorkflowInvocationAction::new().set_state(State::Skipped);
let x2 = WorkflowInvocationAction::new().set_state(State::Disabled);

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

Sets the value of failure_reason.

Example

let x = WorkflowInvocationAction::new().set_failure_reason("example");

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

where T: Into<Interval>,

Sets the value of invocation_timing.

Example

use google_cloud_type::model::Interval;
let x = WorkflowInvocationAction::new().set_invocation_timing(Interval::default()/* use setters */);

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

where T: Into<Interval>,

Sets or clears the value of invocation_timing.

Example

use google_cloud_type::model::Interval;
let x = WorkflowInvocationAction::new().set_or_clear_invocation_timing(Some(Interval::default()/* use setters */));
let x = WorkflowInvocationAction::new().set_or_clear_invocation_timing(None::<Interval>);

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

where T: Into<String>,

Sets the value of internal_metadata.

Example

let x = WorkflowInvocationAction::new().set_internal_metadata("example");

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

where T: Into<String>,

Sets or clears the value of internal_metadata.

Example

let x = WorkflowInvocationAction::new().set_or_clear_internal_metadata(Some("example"));
let x = WorkflowInvocationAction::new().set_or_clear_internal_metadata(None::<String>);

pub fn set_action<T: Into<Option<Action>>>(self, v: T) -> Self

Sets the value of action.

Note that all the setters affecting action are mutually exclusive.

Example

use google_cloud_dataform_v1::model::workflow_invocation_action::BigQueryAction;
let x = WorkflowInvocationAction::new().set_action(Some(
    google_cloud_dataform_v1::model::workflow_invocation_action::Action::BigqueryAction(BigQueryAction::default().into())));

pub fn bigquery_action(&self) -> Option<&Box<BigQueryAction>>

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

pub fn set_bigquery_action<T: Into<Box<BigQueryAction>>>(self, v: T) -> Self

Sets the value of action to hold a BigqueryAction.

Note that all the setters affecting action are mutually exclusive.

Example

use google_cloud_dataform_v1::model::workflow_invocation_action::BigQueryAction;
let x = WorkflowInvocationAction::new().set_bigquery_action(BigQueryAction::default()/* use setters */);
assert!(x.bigquery_action().is_some());
assert!(x.notebook_action().is_none());
assert!(x.data_preparation_action().is_none());

pub fn notebook_action(&self) -> Option<&Box<NotebookAction>>

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

pub fn set_notebook_action<T: Into<Box<NotebookAction>>>(self, v: T) -> Self

Sets the value of action to hold a NotebookAction.

Note that all the setters affecting action are mutually exclusive.

Example

use google_cloud_dataform_v1::model::workflow_invocation_action::NotebookAction;
let x = WorkflowInvocationAction::new().set_notebook_action(NotebookAction::default()/* use setters */);
assert!(x.notebook_action().is_some());
assert!(x.bigquery_action().is_none());
assert!(x.data_preparation_action().is_none());

pub fn data_preparation_action(&self) -> Option<&Box<DataPreparationAction>>

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

pub fn set_data_preparation_action<T: Into<Box<DataPreparationAction>>>( self, v: T, ) -> Self

Sets the value of action to hold a DataPreparationAction.

Note that all the setters affecting action are mutually exclusive.

Example

use google_cloud_dataform_v1::model::workflow_invocation_action::DataPreparationAction;
let x = WorkflowInvocationAction::new().set_data_preparation_action(DataPreparationAction::default()/* use setters */);
assert!(x.data_preparation_action().is_some());
assert!(x.bigquery_action().is_none());
assert!(x.notebook_action().is_none());

Trait Implementations

impl Clone for WorkflowInvocationAction

fn clone(&self) -> WorkflowInvocationAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowInvocationAction

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

Formats the value using the given formatter.

impl Default for WorkflowInvocationAction

fn default() -> WorkflowInvocationAction

Returns the “default value” for a type.

impl Message for WorkflowInvocationAction

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WorkflowInvocationAction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkflowInvocationAction