Class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceStub (4.10.0)

public static final class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceStub extends AbstractAsyncStub<WorkflowTemplateServiceGrpc.WorkflowTemplateServiceStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > WorkflowTemplateServiceGrpc.WorkflowTemplateServiceStub

Methods

build(Channel channel, CallOptions callOptions)

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

createWorkflowTemplate(CreateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

public void createWorkflowTemplate(CreateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

Creates new workflow template.

Parameters
NameDescription
requestCreateWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<WorkflowTemplate>

deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, StreamObserver<Empty> responseObserver)

public void deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getWorkflowTemplate(GetWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

public void getWorkflowTemplate(GetWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

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

Parameters
NameDescription
requestGetWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<WorkflowTemplate>

instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

public void instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
NameDescription
requestInstantiateInlineWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

public void instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
NameDescription
requestInstantiateWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

listWorkflowTemplates(ListWorkflowTemplatesRequest request, StreamObserver<ListWorkflowTemplatesResponse> responseObserver)

public void listWorkflowTemplates(ListWorkflowTemplatesRequest request, StreamObserver<ListWorkflowTemplatesResponse> responseObserver)

Lists workflows that match the specified filter in the request.

Parameters
NameDescription
requestListWorkflowTemplatesRequest
responseObserverio.grpc.stub.StreamObserver<ListWorkflowTemplatesResponse>

updateWorkflowTemplate(UpdateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

public void updateWorkflowTemplate(UpdateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

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

Parameters
NameDescription
requestUpdateWorkflowTemplateRequest
responseObserverio.grpc.stub.StreamObserver<WorkflowTemplate>