Class ProjectsResource.LocationsResource.WorkflowTemplatesResource

The "workflowTemplates" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.WorkflowTemplatesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dataproc.v1

Assembly: Google.Apis.Dataproc.v1.dll

Syntax

public class ProjectsResource.LocationsResource.WorkflowTemplatesResource

Constructors

WorkflowTemplatesResource(IClientService)

Constructs a new resource.

Declaration

public WorkflowTemplatesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(WorkflowTemplate, string)

Creates new workflow template.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.CreateRequest Create(WorkflowTemplate body, string parent)

Parameters

Type	Name	Description
WorkflowTemplate	body	The body of the request.
string	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}

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.CreateRequest

Delete(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	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

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.DeleteRequest

Get(string)

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	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

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
GetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.GetIamPolicyRequest

Instantiate(InstantiateWorkflowTemplateRequest, string)

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.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.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateRequest Instantiate(InstantiateWorkflowTemplateRequest body, string name)

Parameters

Type	Name	Description
InstantiateWorkflowTemplateRequest	body	The body of the request.
string	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}

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateRequest

InstantiateInline(WorkflowTemplate, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateInlineRequest InstantiateInline(WorkflowTemplate body, string parent)

Parameters

Type	Name	Description
WorkflowTemplate	body	The body of the request.
string	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}

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateInlineRequest

List(string)

Lists workflows that match the specified filter in the request.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	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

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.ListRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.TestIamPermissionsRequest

Update(WorkflowTemplate, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.WorkflowTemplatesResource.UpdateRequest Update(WorkflowTemplate body, string name)

Parameters

Type	Name	Description
WorkflowTemplate	body	The body of the request.
string	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}

Returns

Type	Description
ProjectsResource.LocationsResource.WorkflowTemplatesResource.UpdateRequest