Struct google_api_proto::google::cloud::workflows::v1::Workflow

pub struct Workflow {

    pub name: String,
    pub description: String,
    pub state: i32,
    pub revision_id: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub revision_create_time: Option<Timestamp>,
    pub labels: BTreeMap<String, String>,
    pub service_account: String,
    pub crypto_key_name: String,
    pub state_error: Option<StateError>,
    pub call_log_level: i32,
    pub user_env_vars: BTreeMap<String, String>,
    pub source_code: Option<SourceCode>,
}

Workflow program to be executed by Workflows.

Fields

name: String

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

description: String

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

state: i32

Output only. State of the workflow deployment.

revision_id: String

Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow:

• [Service account][google.cloud.workflows.v1.Workflow.service_account]
• [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents]

The format is “000001-a4d”, where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.

create_time: Option<Timestamp>

Output only. The timestamp for when the workflow was created.

update_time: Option<Timestamp>

Output only. The timestamp for when the workflow was last updated.

revision_create_time: Option<Timestamp>

Output only. The timestamp for the latest revision of the workflow’s creation.

labels: BTreeMap<String, String>

Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.

service_account: String

The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account}

Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account.

If not provided, workflow will use the project’s default service account. Modifying this field for an existing workflow results in a new workflow revision.

crypto_key_name: String

Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow.

Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

Using - as a wildcard for the {project} or not providing one at all will infer the project from the account.

If not provided, data associated with the workflow will not be CMEK-encrypted.

state_error: Option<StateError>

Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.

call_log_level: i32

Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.

user_env_vars: BTreeMap<String, String>

Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS“.

source_code: Option<SourceCode>

Required. Location of the workflow source code. Modifying this field for an existing workflow results in a new workflow revision.

Implementations

impl Workflow

pub fn state(&self) -> State

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

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn call_log_level(&self) -> CallLogLevel

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

pub fn set_call_log_level(&mut self, value: CallLogLevel)

Sets call_log_level to the provided enum value.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Self

Returns the “default value” for a type.

impl Message for Workflow

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 Workflow

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