Struct WorkflowTemplate 

#[non_exhaustive]
pub struct WorkflowTemplate {
    pub id: String,
    pub name: String,
    pub version: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub placement: Option<WorkflowTemplatePlacement>,
    pub jobs: Vec<OrderedJob>,
    pub parameters: Vec<TemplateParameter>,
    pub dag_timeout: Option<Duration>,
    pub encryption_config: Option<EncryptionConfig>,
    /* private fields */
}

A Dataproc workflow template resource.

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.

id: String

name: String

Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

• For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

• For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

version: i32

Optional. Used to perform a consistent read-modify-write.

This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.

create_time: Option<Timestamp>

Output only. The time template was created.

update_time: Option<Timestamp>

Output only. The time template was last updated.

labels: HashMap<String, String>

Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

No more than 32 labels can be associated with a template.

placement: Option<WorkflowTemplatePlacement>

Required. WorkflowTemplate scheduling information.

jobs: Vec<OrderedJob>

Required. The Directed Acyclic Graph of Jobs to submit.

parameters: Vec<TemplateParameter>

Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

dag_timeout: Option<Duration>

Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes (“600s”) to 24 hours (“86400s”). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.

encryption_config: Option<EncryptionConfig>

Optional. Encryption settings for encrypting workflow template job arguments.

Implementations

impl WorkflowTemplate

pub fn new() -> Self

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

Sets the value of id.

Example

let x = WorkflowTemplate::new().set_id("example");

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

Sets the value of name.

Example

let x = WorkflowTemplate::new().set_name("example");

pub fn set_version<T: Into<i32>>(self, v: T) -> Self

Sets the value of version.

Example

let x = WorkflowTemplate::new().set_version(42);

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

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

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

where T: Into<WorkflowTemplatePlacement>,

Sets the value of placement.

Example

use google_cloud_dataproc_v1::model::WorkflowTemplatePlacement;
let x = WorkflowTemplate::new().set_placement(WorkflowTemplatePlacement::default()/* use setters */);

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

where T: Into<WorkflowTemplatePlacement>,

Sets or clears the value of placement.

Example

use google_cloud_dataproc_v1::model::WorkflowTemplatePlacement;
let x = WorkflowTemplate::new().set_or_clear_placement(Some(WorkflowTemplatePlacement::default()/* use setters */));
let x = WorkflowTemplate::new().set_or_clear_placement(None::<WorkflowTemplatePlacement>);

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

where T: IntoIterator<Item = V>, V: Into<OrderedJob>,

Sets the value of jobs.

Example

use google_cloud_dataproc_v1::model::OrderedJob;
let x = WorkflowTemplate::new()
    .set_jobs([
        OrderedJob::default()/* use setters */,
        OrderedJob::default()/* use (different) setters */,
    ]);

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

where T: IntoIterator<Item = V>, V: Into<TemplateParameter>,

Sets the value of parameters.

Example

use google_cloud_dataproc_v1::model::TemplateParameter;
let x = WorkflowTemplate::new()
    .set_parameters([
        TemplateParameter::default()/* use setters */,
        TemplateParameter::default()/* use (different) setters */,
    ]);

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

where T: Into<Duration>,

Sets the value of dag_timeout.

Example

use wkt::Duration;
let x = WorkflowTemplate::new().set_dag_timeout(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of dag_timeout.

Example

use wkt::Duration;
let x = WorkflowTemplate::new().set_or_clear_dag_timeout(Some(Duration::default()/* use setters */));
let x = WorkflowTemplate::new().set_or_clear_dag_timeout(None::<Duration>);

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

where T: Into<EncryptionConfig>,

Sets the value of encryption_config.

Example

use google_cloud_dataproc_v1::model::workflow_template::EncryptionConfig;
let x = WorkflowTemplate::new().set_encryption_config(EncryptionConfig::default()/* use setters */);

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

where T: Into<EncryptionConfig>,

Sets or clears the value of encryption_config.

Example

use google_cloud_dataproc_v1::model::workflow_template::EncryptionConfig;
let x = WorkflowTemplate::new().set_or_clear_encryption_config(Some(EncryptionConfig::default()/* use setters */));
let x = WorkflowTemplate::new().set_or_clear_encryption_config(None::<EncryptionConfig>);

Trait Implementations

impl Clone for WorkflowTemplate

fn clone(&self) -> WorkflowTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowTemplate

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

Formats the value using the given formatter.

impl Default for WorkflowTemplate

fn default() -> WorkflowTemplate

Returns the “default value” for a type.

impl Message for WorkflowTemplate

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WorkflowTemplate

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