Google Cloud Workflows V1 Client - Class GetExecutionRequest (1.2.1)

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

Request for the GetExecution method.

Generated from protobuf message google.cloud.workflows.executions.v1.GetExecutionRequest

Namespace

Google \ Cloud \ Workflows \ Executions \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
↳ view int

Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.

getName

Required. Name of the execution to be retrieved.

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

Returns
Type Description
string

setName

Required. Name of the execution to be retrieved.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.

Returns
Type Description
int Enum of type ExecutionView.

setView

Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.

Parameter
Name Description
var int

Enum of type ExecutionView.

Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} Please see ExecutionsClient::executionName() for help formatting this field.
Returns
Type Description
GetExecutionRequest