Class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub (2.3.1)

public static final class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub extends AbstractBlockingStub<WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub>

The API interface for managing Workflow Templates in the Dataproc API.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
WorkflowTemplateServiceGrpc.WorkflowTemplateServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createWorkflowTemplate(CreateWorkflowTemplateRequest request)

public WorkflowTemplate createWorkflowTemplate(CreateWorkflowTemplateRequest request)

Creates new workflow template.

Parameter
NameDescription
requestCreateWorkflowTemplateRequest
Returns
TypeDescription
WorkflowTemplate

deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request)

public Empty deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request)

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

Parameter
NameDescription
requestDeleteWorkflowTemplateRequest
Returns
TypeDescription
Empty

getWorkflowTemplate(GetWorkflowTemplateRequest request)

public WorkflowTemplate getWorkflowTemplate(GetWorkflowTemplateRequest request)

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

Parameter
NameDescription
requestGetWorkflowTemplateRequest
Returns
TypeDescription
WorkflowTemplate

instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request)

public Operation instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request)

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. Also see Using WorkflowMetadata. On successful completion, Operation.response will be Empty.

Parameter
NameDescription
requestInstantiateInlineWorkflowTemplateRequest
Returns
TypeDescription
Operation

instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request)

public Operation instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request)

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. Also see Using WorkflowMetadata. On successful completion, Operation.response will be Empty.

Parameter
NameDescription
requestInstantiateWorkflowTemplateRequest
Returns
TypeDescription
Operation

listWorkflowTemplates(ListWorkflowTemplatesRequest request)

public ListWorkflowTemplatesResponse listWorkflowTemplates(ListWorkflowTemplatesRequest request)

Lists workflows that match the specified filter in the request.

Parameter
NameDescription
requestListWorkflowTemplatesRequest
Returns
TypeDescription
ListWorkflowTemplatesResponse

updateWorkflowTemplate(UpdateWorkflowTemplateRequest request)

public WorkflowTemplate updateWorkflowTemplate(UpdateWorkflowTemplateRequest request)

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

Parameter
NameDescription
requestUpdateWorkflowTemplateRequest
Returns
TypeDescription
WorkflowTemplate