Google Cloud Dataproc v1 API - Class WorkflowTemplateService.WorkflowTemplateServiceBase (5.7.0)

[BindServiceMethod(typeof(WorkflowTemplateService), "BindService")]
public abstract class WorkflowTemplateService.WorkflowTemplateServiceBase

Reference documentation and code samples for the Google Cloud Dataproc v1 API class WorkflowTemplateService.WorkflowTemplateServiceBase.

Base class for server-side implementations of WorkflowTemplateService

Inheritance

object > WorkflowTemplateService.WorkflowTemplateServiceBase

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Methods

CreateWorkflowTemplate(CreateWorkflowTemplateRequest, ServerCallContext)

public virtual Task<WorkflowTemplate> CreateWorkflowTemplate(CreateWorkflowTemplateRequest request, ServerCallContext context)

Creates new workflow template.

Parameters
NameDescription
requestCreateWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskWorkflowTemplate

The response to send back to the client (wrapped by a task).

DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest, ServerCallContext)

public virtual Task<Empty> DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestDeleteWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

GetWorkflowTemplate(GetWorkflowTemplateRequest, ServerCallContext)

public virtual Task<WorkflowTemplate> GetWorkflowTemplate(GetWorkflowTemplateRequest request, ServerCallContext context)

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Parameters
NameDescription
requestGetWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskWorkflowTemplate

The response to send back to the client (wrapped by a task).

InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest, ServerCallContext)

public virtual Task<Operation> InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, ServerCallContext context)

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate].

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
NameDescription
requestInstantiateInlineWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest, ServerCallContext)

public virtual Task<Operation> InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, ServerCallContext context)

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The [Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].

Parameters
NameDescription
requestInstantiateWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

ListWorkflowTemplates(ListWorkflowTemplatesRequest, ServerCallContext)

public virtual Task<ListWorkflowTemplatesResponse> ListWorkflowTemplates(ListWorkflowTemplatesRequest request, ServerCallContext context)

Lists workflows that match the specified filter in the request.

Parameters
NameDescription
requestListWorkflowTemplatesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListWorkflowTemplatesResponse

The response to send back to the client (wrapped by a task).

UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest, ServerCallContext)

public virtual Task<WorkflowTemplate> UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestUpdateWorkflowTemplateRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskWorkflowTemplate

The response to send back to the client (wrapped by a task).