1. class
  2. Google
  3. \
  4. Service
  5. \
  6. WorkflowExecutions
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsWorkflowsExecutions

ProjectsLocationsWorkflowsExecutions

class ProjectsLocationsWorkflowsExecutions extends Resource (View source)

The "executions" collection of methods.

Typical usage is:

 $workflowexecutionsService = new Google\Service\WorkflowExecutions(...);
 $executions = $workflowexecutionsService->projects_locations_workflows_executions;

Methods

Execution
cancel(string $name, CancelExecutionRequest $postBody, array $optParams = [])

Cancels an execution of the given name. (executions.cancel)

Execution
create(string $parent, Execution $postBody, array $optParams = [])

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow. (executions.create)

ExportDataResponse
exportData(string $name, array $optParams = [])

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods. (executions.exportData)

Execution
get(string $name, array $optParams = [])

Returns an execution of the given name. (executions.get)

ListExecutionsResponse
listProjectsLocationsWorkflowsExecutions(string $parent, array $optParams = [])

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Details

at line 46
Execution cancel(string $name, CancelExecutionRequest $postBody, array $optParams = [])

Cancels an execution of the given name. (executions.cancel)

Parameters

string $name

Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec ution}
CancelExecutionRequest $postBody
array $optParams

Optional parameters.

Return Value

Execution

Exceptions

Exception

at line 65
Execution create(string $parent, Execution $postBody, array $optParams = [])

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow. (executions.create)

Parameters

string $parent

Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
Execution $postBody
array $optParams

Optional parameters.

Return Value

Execution

Exceptions

Exception

at line 82
ExportDataResponse exportData(string $name, array $optParams = [])

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods. (executions.exportData)

Parameters

string $name

Required. Name of the execution for which data is to be exported. Format: projects/{project}/locations/{location}/workflows/{workflow }/executions/{execution}
array $optParams

Optional parameters.

Return Value

ExportDataResponse

Exceptions

Exception

at line 101
Execution get(string $name, array $optParams = [])

Returns an execution of the given name. (executions.get)

Parameters

string $name

Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec ution}
array $optParams

Optional parameters.

Return Value

Execution

Exceptions

Exception

at line 146
ListExecutionsResponse listProjectsLocationsWorkflowsExecutions(string $parent, array $optParams = [])

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

(executions.listProjectsLocationsWorkflowsExecutions)

Parameters

string $parent

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
array $optParams

Optional parameters.

Return Value

ListExecutionsResponse

Exceptions

Exception