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

ProjectsLocationsWorkflows

class ProjectsLocationsWorkflows extends Resource (View source)

The "workflows" collection of methods.

Typical usage is:

 $workflowsService = new Google\Service\Workflows(...);
 $workflows = $workflowsService->projects_locations_workflows;

Methods

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

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error. (workflows.create)

Operation
delete(string $name, array $optParams = [])

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow. (workflows.delete)

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

Gets details of a single workflow. (workflows.get)

ListWorkflowsResponse
listProjectsLocationsWorkflows(string $parent, array $optParams = [])

Lists workflows in a given project and location. The default order is not specified. (workflows.listProjectsLocationsWorkflows)

ListWorkflowRevisionsResponse
listRevisions(string $name, array $optParams = [])

Lists revisions for a given workflow. (workflows.listRevisions)

Operation
patch(string $name, Workflow $postBody, array $optParams = [])

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions. (workflows.patch)

Details

at line 53
Operation create(string $parent, Workflow $postBody, array $optParams = [])

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error. (workflows.create)

Parameters

string $parent

Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}
Workflow $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 69
Operation delete(string $name, array $optParams = [])

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow. (workflows.delete)

Parameters

string $name

Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 91
Workflow get(string $name, array $optParams = [])

Gets details of a single workflow. (workflows.get)

Parameters

string $name

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

Optional parameters.

Return Value

Workflow

Exceptions

Exception

at line 124
ListWorkflowsResponse listProjectsLocationsWorkflows(string $parent, array $optParams = [])

Lists workflows in a given project and location. The default order is not specified. (workflows.listProjectsLocationsWorkflows)

Parameters

string $parent

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

ListWorkflowsResponse

Exceptions

Exception

at line 145
ListWorkflowRevisionsResponse listRevisions(string $name, array $optParams = [])

Lists revisions for a given workflow. (workflows.listRevisions)

Parameters

string $name

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

Optional parameters.

Return Value

ListWorkflowRevisionsResponse

Exceptions

Exception

at line 168
Operation patch(string $name, Workflow $postBody, array $optParams = [])

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions. (workflows.patch)

Parameters

string $name

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.
Workflow $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception