Class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub (2.3.1)

public static final class WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub extends AbstractFutureStub<WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
WorkflowTemplateServiceGrpc.WorkflowTemplateServiceFutureStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createWorkflowTemplate(CreateWorkflowTemplateRequest request)

public ListenableFuture<WorkflowTemplate> createWorkflowTemplate(CreateWorkflowTemplateRequest request)

Creates new workflow template.

Parameter

Name	Description
request	`CreateWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<WorkflowTemplate>

deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request)

public ListenableFuture<Empty> deleteWorkflowTemplate(DeleteWorkflowTemplateRequest request)

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

Parameter

Name	Description
request	`DeleteWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getWorkflowTemplate(GetWorkflowTemplateRequest request)

public ListenableFuture<WorkflowTemplate> getWorkflowTemplate(GetWorkflowTemplateRequest request)

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

Parameter

Name	Description
request	`GetWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<WorkflowTemplate>

instantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest request)

public ListenableFuture<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

Name	Description
request	`InstantiateInlineWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

instantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest request)

public ListenableFuture<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

Name	Description
request	`InstantiateWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listWorkflowTemplates(ListWorkflowTemplatesRequest request)

public ListenableFuture<ListWorkflowTemplatesResponse> listWorkflowTemplates(ListWorkflowTemplatesRequest request)

Lists workflows that match the specified filter in the request.

Parameter

Name	Description
request	`ListWorkflowTemplatesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListWorkflowTemplatesResponse>

updateWorkflowTemplate(UpdateWorkflowTemplateRequest request)

public ListenableFuture<WorkflowTemplate> updateWorkflowTemplate(UpdateWorkflowTemplateRequest request)

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

Parameter

Name	Description
request	`UpdateWorkflowTemplateRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<WorkflowTemplate>