Google Cloud Workflows V1beta Client - Class Workflow (1.0.0-RC1)

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

Workflow program to be executed by Workflows.

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

Namespace

Google \ Cloud \ Workflows \ V1beta

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}
↳ description string

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
↳ 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 fields of a workflow: - source_code - service_account The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp of when the workflow was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The last update timestamp of the workflow.
↳ revision_create_time Google\Protobuf\Timestamp

Output only. The timestamp that the latest revision of the workflow was created.
↳ 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.
↳ service_account string

Name of 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} Using - as a wildcard for the {project} 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 32KB.

getName

The resource name of the workflow.

Format: projects/{project}/locations/{location}/workflows/{workflow}

Returns
Type Description
string

setName

The resource name of the workflow.

Format: projects/{project}/locations/{location}/workflows/{workflow}

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.

Returns
Type Description
string

setDescription

Description of the workflow provided by the user.

Must be at most 1000 unicode characters long.

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 fields of a workflow:

  • source_code
  • service_account The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 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 fields of a workflow:

  • source_code
  • service_account The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

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

getUpdateTime

Output only. The last update timestamp of the workflow.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update timestamp of the workflow.

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

getRevisionCreateTime

Output only. The timestamp that the latest revision of the workflow was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRevisionCreateTime

clearRevisionCreateTime

setRevisionCreateTime

Output only. The timestamp that the latest revision of the workflow was created.

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.

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.

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

getServiceAccount

Name of 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} Using - as a wildcard for the {project} 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

Name of 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} Using - as a wildcard for the {project} 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 32KB.

Returns
Type Description
string

hasSourceContents

setSourceContents

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceCode

Returns
Type Description
string