com.google.api.services.dataproc.v1beta2

Class Dataproc.Projects.Locations.WorkflowTemplates

java.lang.Object

com.google.api.services.dataproc.v1beta2.Dataproc.Projects.Locations.WorkflowTemplates

Enclosing class:

Dataproc.Projects.Locations

public class Dataproc.Projects.Locations.WorkflowTemplates
extends Object

The "workflowTemplates" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Dataproc.Projects.Locations.WorkflowTemplates.Create
class	Dataproc.Projects.Locations.WorkflowTemplates.Delete
class	Dataproc.Projects.Locations.WorkflowTemplates.Get
class	Dataproc.Projects.Locations.WorkflowTemplates.GetIamPolicy
class	Dataproc.Projects.Locations.WorkflowTemplates.Instantiate
class	Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline
class	Dataproc.Projects.Locations.WorkflowTemplates.List
class	Dataproc.Projects.Locations.WorkflowTemplates.SetIamPolicy
class	Dataproc.Projects.Locations.WorkflowTemplates.TestIamPermissions
class	Dataproc.Projects.Locations.WorkflowTemplates.Update

Constructor Summary

Constructors

Constructor and Description
WorkflowTemplates()

Method Summary

Modifier and Type	Method and Description
Dataproc.Projects.Locations.WorkflowTemplates.Create	create(String parent, WorkflowTemplate content) Creates new workflow template.
Dataproc.Projects.Locations.WorkflowTemplates.Delete	delete(String name) Deletes a workflow template.
Dataproc.Projects.Locations.WorkflowTemplates.Get	get(String name) Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.
Dataproc.Projects.Locations.WorkflowTemplates.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
Dataproc.Projects.Locations.WorkflowTemplates.Instantiate	instantiate(String name, InstantiateWorkflowTemplateRequest content) Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	instantiateInline(String parent, WorkflowTemplate content) 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.
Dataproc.Projects.Locations.WorkflowTemplates.List	list(String parent) Lists workflows that match the specified filter in the request.
Dataproc.Projects.Locations.WorkflowTemplates.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
Dataproc.Projects.Locations.WorkflowTemplates.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
Dataproc.Projects.Locations.WorkflowTemplates.Update	update(String name, WorkflowTemplate content) Updates (replaces) workflow template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowTemplates

public WorkflowTemplates()

Method Detail

create

public Dataproc.Projects.Locations.WorkflowTemplates.Create create(String parent,
                                                                   WorkflowTemplate content)
                                                            throws IOException

Creates new workflow template. Create a request for the method "workflowTemplates.create". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - 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}

content - the WorkflowTemplate

Returns:

the request

Throws:

IOException

delete

public Dataproc.Projects.Locations.WorkflowTemplates.Delete delete(String name)
                                                            throws IOException

Deletes a workflow template. It does not cancel in-progress workflows. Create a request for the method "workflowTemplates.delete". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - 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}

Returns:

the request

Throws:

IOException

get

public Dataproc.Projects.Locations.WorkflowTemplates.Get get(String name)
                                                      throws IOException

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. Create a request for the method "workflowTemplates.get". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - 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}

Returns:

the request

Throws:

IOException

getIamPolicy

public Dataproc.Projects.Locations.WorkflowTemplates.GetIamPolicy getIamPolicy(String resource)
                                                                        throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "workflowTemplates.getIamPolicy". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns:

the request

Throws:

IOException

instantiate

public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate instantiate(String name,
                                                                             InstantiateWorkflowTemplateRequest content)
                                                                      throws IOException

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/rpc/google.cloud.datap roc.v1beta2#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. Create a request for the method "workflowTemplates.instantiate". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - 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}

content - the InstantiateWorkflowTemplateRequest

Returns:

the request

Throws:

IOException

instantiateInline

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline instantiateInline(String parent,
                                                                                         WorkflowTemplate content)
                                                                                  throws IOException

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_workflowmetadata).On successful completion, Operation.response will be Empty. Create a request for the method "workflowTemplates.instantiateInline". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - 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}

content - the WorkflowTemplate

Returns:

the request

Throws:

IOException

list

public Dataproc.Projects.Locations.WorkflowTemplates.List list(String parent)
                                                        throws IOException

Lists workflows that match the specified filter in the request. Create a request for the method "workflowTemplates.list". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - 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}

Returns:

the request

Throws:

IOException

setIamPolicy

public Dataproc.Projects.Locations.WorkflowTemplates.SetIamPolicy setIamPolicy(String resource,
                                                                               SetIamPolicyRequest content)
                                                                        throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Create a request for the method "workflowTemplates.setIamPolicy". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Dataproc.Projects.Locations.WorkflowTemplates.TestIamPermissions testIamPermissions(String resource,
                                                                                           TestIamPermissionsRequest content)
                                                                                    throws IOException

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. Create a request for the method "workflowTemplates.testIamPermissions". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

update

public Dataproc.Projects.Locations.WorkflowTemplates.Update update(String name,
                                                                   WorkflowTemplate content)
                                                            throws IOException

Updates (replaces) workflow template. The updated template must contain version that matches the current server version. Create a request for the method "workflowTemplates.update". This request holds the parameters needed by the dataproc server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - 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}

content - the WorkflowTemplate

Returns:

the request

Throws:

IOException