Google Cloud Workflows V1 Client - Class Workflow (1.1.0)

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

Workflow program to be executed by Workflows.

Generated from protobuf message google.cloud.workflows.v1.Workflow

Namespace

Google \ Cloud \ Workflows \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
↳ description string

Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
↳ state int

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 - Workflow code to be executed 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 Google\Protobuf\Timestamp

Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
↳ revision_create_time Google\Protobuf\Timestamp

Output only. The timestamp for the latest revision of the workflow's creation.
↳ labels array|Google\Protobuf\Internal\MapField

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. This is a workflow-wide field and is not tied to a specific revision.
↳ 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.
↳ source_contents string

Workflow code to be executed. The size limit is 128KB.
↳ 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 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.
↳ call_log_level int

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 array|Google\Protobuf\Internal\MapField

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

Optional. Describes the execution history level to apply to this workflow.
↳ all_kms_keys array

Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
↳ all_kms_keys_versions array

Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
↳ crypto_key_version string

Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
↳ tags array|Google\Protobuf\Internal\MapField

Optional. Input only. Immutable. Tags associated with this workflow.

getName

The resource name of the workflow.

Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.

Returns
Type Description
string

setName

The resource name of the workflow.

Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Description of the workflow provided by the user.

Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.

Returns
Type Description
string

setDescription

Description of the workflow provided by the user.

Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. State of the workflow deployment.

Returns
Type Description
int

setState

Output only. State of the workflow deployment.

Parameter
Name Description
var int
Returns
Type Description
$this

getRevisionId

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 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.
Returns
Type Description
string

setRevisionId

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 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.
Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

This is a workflow-wide field and is not tied to a specific revision.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

This is a workflow-wide field and is not tied to a specific revision.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

This is a workflow-wide field and is not tied to a specific revision.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

This is a workflow-wide field and is not tied to a specific revision.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRevisionCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRevisionCreateTime

clearRevisionCreateTime

setRevisionCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

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. This is a workflow-wide field and is not tied to a specific revision.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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. This is a workflow-wide field and is not tied to a specific revision.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getServiceAccount

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
Type Description
string

setServiceAccount

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceContents

Workflow code to be executed. The size limit is 128KB.

Returns
Type Description
string

hasSourceContents

setSourceContents

Workflow code to be executed. The size limit is 128KB.

Parameter
Name Description
var string
Returns
Type Description
$this

getCryptoKeyName

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
Type Description
string

setCryptoKeyName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getStateError

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.

Returns
Type Description
Workflow\StateError|null

hasStateError

clearStateError

setStateError

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.

Parameter
Name Description
var Workflow\StateError
Returns
Type Description
$this

getCallLogLevel

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
Type Description
int

setCallLogLevel

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getUserEnvVars

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setUserEnvVars

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getExecutionHistoryLevel

Optional. Describes the execution history level to apply to this workflow.

Returns
Type Description
int

setExecutionHistoryLevel

Optional. Describes the execution history level to apply to this workflow.

Parameter
Name Description
var int
Returns
Type Description
$this

getAllKmsKeys

Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAllKmsKeys

Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAllKmsKeysVersions

Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAllKmsKeysVersions

Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCryptoKeyVersion

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

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

Returns
Type Description
string

setCryptoKeyVersion

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTags

Optional. Input only. Immutable. Tags associated with this workflow.

Returns
Type Description
Google\Protobuf\Internal\MapField

setTags

Optional. Input only. Immutable. Tags associated with this workflow.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getSourceCode

Returns
Type Description
string