Workflows V1 API - Class Google::Cloud::Workflows::V1::Workflow (v1.1.0)

Reference documentation and code samples for the Workflows V1 API class Google::Cloud::Workflows::V1::Workflow.

Workflow program to be executed by Workflows.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#call_log_level

def call_log_level() -> ::Google::Cloud::Workflows::V1::Workflow::CallLogLevel

Returns

(::Google::Cloud::Workflows::V1::Workflow::CallLogLevel) — 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.

#call_log_level=

def call_log_level=(value) -> ::Google::Cloud::Workflows::V1::Workflow::CallLogLevel

Parameter

value (::Google::Cloud::Workflows::V1::Workflow::CallLogLevel) — 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.

Returns

(::Google::Cloud::Workflows::V1::Workflow::CallLogLevel) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp for when the workflow was created.

#crypto_key_name

def crypto_key_name() -> ::String

Returns

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

#crypto_key_name=

def crypto_key_name=(value) -> ::String

Parameter

value (::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.

Returns

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

#description

def description() -> ::String

Returns

(::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

Returns

(::String) — Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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.

Returns

(::Google::Protobuf::Map{::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.

#name

def name() -> ::String

Returns

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

#name=

def name=(value) -> ::String

Parameter

value (::String) — The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

Returns

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

#revision_create_time

def revision_create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp for the latest revision of the workflow's creation.

#revision_id

def revision_id() -> ::String

Returns

(::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
- [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.

#service_account

def service_account() -> ::String

Returns

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

#service_account=

def service_account=(value) -> ::String

Parameter

value (::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.

Returns

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

#source_contents

def source_contents() -> ::String

Returns

(::String) — Workflow code to be executed. The size limit is 128KB.

#source_contents=

def source_contents=(value) -> ::String

Parameter

value (::String) — Workflow code to be executed. The size limit is 128KB.

Returns

(::String) — Workflow code to be executed. The size limit is 128KB.

#state

def state() -> ::Google::Cloud::Workflows::V1::Workflow::State

Returns

(::Google::Cloud::Workflows::V1::Workflow::State) — Output only. State of the workflow deployment.

#state_error

def state_error() -> ::Google::Cloud::Workflows::V1::Workflow::StateError

Returns

(::Google::Cloud::Workflows::V1::Workflow::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp for when the workflow was last updated.

#user_env_vars

def user_env_vars() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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".

#user_env_vars=

def user_env_vars=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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".

Returns

(::Google::Protobuf::Map{::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".