Documentation

Google_Service_Dataproc_Resource_ProjectsRegionsWorkflowTemplates extends Google_Service_Resource
in package

Application

The "workflowTemplates" collection of methods.

Typical usage is: $dataprocService = new Google_Service_Dataproc(...); $workflowTemplates = $dataprocService->workflowTemplates;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Dataproc_WorkflowTemplate: Creates new workflow template. (workflowTemplates.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Dataproc_DataprocEmpty: Deletes a workflow template. It does not cancel in-progress workflows.
get() : Google_Service_Dataproc_WorkflowTemplate: Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. (workflowTemplates.get)
getIamPolicy() : Google_Service_Dataproc_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
instantiate() : Google_Service_Dataproc_Operation: 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.
instantiateInline() : Google_Service_Dataproc_Operation: 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.
listProjectsRegionsWorkflowTemplates() : Google_Service_Dataproc_ListWorkflowTemplatesResponse: Lists workflows that match the specified filter in the request.
setIamPolicy() : Google_Service_Dataproc_Policy: 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)
testIamPermissions() : Google_Service_Dataproc_TestIamPermissionsResponse: 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.
update() : Google_Service_Dataproc_WorkflowTemplate: Updates (replaces) workflow template. The updated template must contain version that matches the current server version. (workflowTemplates.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates new workflow template. (workflowTemplates.create)


    public
                create(string $parent, Google_Service_Dataproc_WorkflowTemplate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_WorkflowTemplate

Parameters

$parent : string: Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}
$postBody : Google_Service_Dataproc_WorkflowTemplate
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_WorkflowTemplate —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a workflow template. It does not cancel in-progress workflows.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_DataprocEmpty

(workflowTemplates.delete)

Parameters

$name : string: Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_DataprocEmpty —

get()

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. (workflowTemplates.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_WorkflowTemplate

Parameters

$name : string: Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_WorkflowTemplate —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.


    public
                getIamPolicy(string $resource, Google_Service_Dataproc_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

(workflowTemplates.getIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

instantiate()

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.


    public
                instantiate(string $name, Google_Service_Dataproc_InstantiateWorkflowTemplateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation

(workflowTemplates.instantiate)

Parameters

$name : string: Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
$postBody : Google_Service_Dataproc_InstantiateWorkflowTemplateRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Operation —

instantiateInline()

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.


    public
                instantiateInline(string $parent, Google_Service_Dataproc_WorkflowTemplate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation

(workflowTemplates.instantiateInline)

Parameters

$parent : string: Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
$postBody : Google_Service_Dataproc_WorkflowTemplate
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Operation —

listProjectsRegionsWorkflowTemplates()

Lists workflows that match the specified filter in the request.


    public
                listProjectsRegionsWorkflowTemplates(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_ListWorkflowTemplatesResponse

(workflowTemplates.listProjectsRegionsWorkflowTemplates)

Parameters

$parent : string: Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_ListWorkflowTemplatesResponse —

setIamPolicy()

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)


    public
                setIamPolicy(string $resource, Google_Service_Dataproc_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

testIamPermissions()

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.


    public
                testIamPermissions(string $resource, Google_Service_Dataproc_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_TestIamPermissionsResponse

This operation may "fail open" without warning. (workflowTemplates.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_TestIamPermissionsResponse —

update()

Updates (replaces) workflow template. The updated template must contain version that matches the current server version. (workflowTemplates.update)


    public
                update(string $name, Google_Service_Dataproc_WorkflowTemplate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_WorkflowTemplate

Parameters

$name : string: Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
$postBody : Google_Service_Dataproc_WorkflowTemplate
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_WorkflowTemplate —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —