org.apache.beam.sdk.common.runner.v1

Class JobServiceGrpc.JobServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<JobServiceGrpc.JobServiceBlockingStub>

org.apache.beam.sdk.common.runner.v1.JobServiceGrpc.JobServiceBlockingStub

Enclosing class:

JobServiceGrpc

public static final class JobServiceGrpc.JobServiceBlockingStub
extends io.grpc.stub.AbstractStub<JobServiceGrpc.JobServiceBlockingStub>

 Job Service for running RunnerAPI pipelines
 

Method Summary

Modifier and Type	Method and Description
protected JobServiceGrpc.JobServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
JobApi.CancelJobResponse	cancel(JobApi.CancelJobRequest request) Cancel the job
Iterator<JobApi.JobMessagesResponse>	getMessageStream(JobApi.JobMessagesRequest request) Subscribe to a stream of state changes and messages from the job
JobApi.GetJobStateResponse	getState(JobApi.GetJobStateRequest request) Get the current state of the job
Iterator<JobApi.GetJobStateResponse>	getStateStream(JobApi.GetJobStateRequest request) Subscribe to a stream of state changes of the job, will immediately return the current state of the job as the first response.
JobApi.PrepareJobResponse	prepare(JobApi.PrepareJobRequest request) Prepare a job for execution.
JobApi.RunJobResponse	run(JobApi.RunJobRequest request) Submit the job for execution

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected JobServiceGrpc.JobServiceBlockingStub build(io.grpc.Channel channel,
                                                      io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<JobServiceGrpc.JobServiceBlockingStub>

prepare

public JobApi.PrepareJobResponse prepare(JobApi.PrepareJobRequest request)

 Prepare a job for execution. The job will not be executed until a call is made to run with the
 returned preparationId.
 

run

public JobApi.RunJobResponse run(JobApi.RunJobRequest request)

 Submit the job for execution
 

getState

public JobApi.GetJobStateResponse getState(JobApi.GetJobStateRequest request)

 Get the current state of the job
 

cancel

public JobApi.CancelJobResponse cancel(JobApi.CancelJobRequest request)

 Cancel the job
 

getStateStream

public Iterator<JobApi.GetJobStateResponse> getStateStream(JobApi.GetJobStateRequest request)

 Subscribe to a stream of state changes of the job, will immediately return the current state of the job as the first response.
 

getMessageStream

public Iterator<JobApi.JobMessagesResponse> getMessageStream(JobApi.JobMessagesRequest request)

 Subscribe to a stream of state changes and messages from the job