Package com.google.cloud.dataproc.v1
Interface WorkflowTemplateServiceGrpc.AsyncService
-
- All Known Implementing Classes:
WorkflowTemplateServiceGrpc.WorkflowTemplateServiceImplBase
- Enclosing class:
- WorkflowTemplateServiceGrpc
public static interface WorkflowTemplateServiceGrpc.AsyncService
The API interface for managing Workflow Templates in the Dataproc API.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default void
createWorkflowTemplate(CreateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Creates new workflow template.default void
deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a workflow template.default void
getWorkflowTemplate(GetWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Retrieves the latest workflow template.default void
instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Instantiates a template and begins execution.default void
instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Instantiates a template and begins execution.default void
listWorkflowTemplates(ListWorkflowTemplatesRequest request, io.grpc.stub.StreamObserver<ListWorkflowTemplatesResponse> responseObserver)
Lists workflows that match the specified filter in the request.default void
updateWorkflowTemplate(UpdateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Updates (replaces) workflow template.
-
-
-
Method Detail
-
createWorkflowTemplate
default void createWorkflowTemplate(CreateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Creates new workflow template.
-
getWorkflowTemplate
default void getWorkflowTemplate(GetWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Retrieves the latest workflow template. Can retrieve previously instantiated template by specifying optional version parameter.
-
instantiateWorkflowTemplate
default void instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
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](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][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].
-
instantiateInlineWorkflowTemplate
default void instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
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](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][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].
-
updateWorkflowTemplate
default void updateWorkflowTemplate(UpdateWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<WorkflowTemplate> responseObserver)
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
-
listWorkflowTemplates
default void listWorkflowTemplates(ListWorkflowTemplatesRequest request, io.grpc.stub.StreamObserver<ListWorkflowTemplatesResponse> responseObserver)
Lists workflows that match the specified filter in the request.
-
deleteWorkflowTemplate
default void deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a workflow template. It does not cancel in-progress workflows.
-
-