Interface WorkflowTemplateServiceGrpc.AsyncService (4.44.0)

public static interface WorkflowTemplateServiceGrpc.AsyncService

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

Methods

createWorkflowTemplate(CreateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

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

Creates new workflow template.

Parameters
Name	Description
`request`	`CreateWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<WorkflowTemplate>`

deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, StreamObserver<Empty> responseObserver)

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

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

Parameters
Name	Description
`request`	`DeleteWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getWorkflowTemplate(GetWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

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

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

Parameters
Name	Description
`request`	`GetWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<WorkflowTemplate>`

instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

public default 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
Name	Description
`request`	`InstantiateInlineWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, StreamObserver<Operation> responseObserver)

public default 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
Name	Description
`request`	`InstantiateWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

listWorkflowTemplates(ListWorkflowTemplatesRequest request, StreamObserver<ListWorkflowTemplatesResponse> responseObserver)

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

Lists workflows that match the specified filter in the request.

Parameters
Name	Description
`request`	`ListWorkflowTemplatesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListWorkflowTemplatesResponse>`

updateWorkflowTemplate(UpdateWorkflowTemplateRequest request, StreamObserver<WorkflowTemplate> responseObserver)

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

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

Parameters
Name	Description
`request`	`UpdateWorkflowTemplateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<WorkflowTemplate>`