ProjectsRegionsWorkflowTemplates
class ProjectsRegionsWorkflowTemplates extends Resource (View source)
The "workflowTemplates" collection of methods.
Typical usage is:
$dataprocService = new Google\Service\Dataproc(...);
$workflowTemplates = $dataprocService->projects_regions_workflowTemplates;
Methods
Creates new workflow template. (workflowTemplates.create)
Deletes a workflow template. It does not cancel in-progress workflows.
Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. (workflowTemplates.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_wo rkflowmetadata).On successful completion, Operation.response will be Empty.
Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google .cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https: //cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowm etadata).On successful completion, Operation.response will be Empty.
Lists workflows that match the specified filter in the request.
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (workflowTemplates.setIamPolicy)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
Updates (replaces) workflow template. The updated template must contain version that matches the current server version. (workflowTemplates.update)
Details
WorkflowTemplate
create(string $parent, WorkflowTemplate $postBody, array $optParams = [])
Creates new workflow template. (workflowTemplates.create)
DataprocEmpty
delete(string $name, array $optParams = [])
Deletes a workflow template. It does not cancel in-progress workflows.
(workflowTemplates.delete)
WorkflowTemplate
get(string $name, array $optParams = [])
Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. (workflowTemplates.get)
Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(workflowTemplates.getIamPolicy)
Operation
instantiate(string $name, InstantiateWorkflowTemplateRequest $postBody, array $optParams = [])
Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rp c/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_wo rkflowmetadata).On successful completion, Operation.response will be Empty.
(workflowTemplates.instantiate)
Operation
instantiateInline(string $parent, WorkflowTemplate $postBody, array $optParams = [])
Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google .cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https: //cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowm etadata).On successful completion, Operation.response will be Empty.
(workflowTemplates.instantiateInline)
ListWorkflowTemplatesResponse
listProjectsRegionsWorkflowTemplates(string $parent, array $optParams = [])
Lists workflows that match the specified filter in the request.
(workflowTemplates.listProjectsRegionsWorkflowTemplates)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (workflowTemplates.setIamPolicy)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning. (workflowTemplates.testIamPermissions)
WorkflowTemplate
update(string $name, WorkflowTemplate $postBody, array $optParams = [])
Updates (replaces) workflow template. The updated template must contain version that matches the current server version. (workflowTemplates.update)