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

Class JobApi

java.lang.Object

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

public final class JobApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobApi.CancelJobRequest Cancel is a synchronus request that returns a job state back Throws error GRPC_STATUS_UNAVAILABLE if server is down Throws error NOT_FOUND if the jobId is not found
static interface	JobApi.CancelJobRequestOrBuilder
static class	JobApi.CancelJobResponse Valid responses include any terminal state or CANCELLING
static interface	JobApi.CancelJobResponseOrBuilder
static class	JobApi.GetJobStateRequest GetState is a synchronus request that returns a job state back Throws error GRPC_STATUS_UNAVAILABLE if server is down Throws error NOT_FOUND if the jobId is not found
static interface	JobApi.GetJobStateRequestOrBuilder
static class	JobApi.GetJobStateResponse Protobuf type org.apache.beam.runner_api.v1.GetJobStateResponse
static interface	JobApi.GetJobStateResponseOrBuilder
static class	JobApi.JobMessage Protobuf type org.apache.beam.runner_api.v1.JobMessage
static interface	JobApi.JobMessageOrBuilder
static class	JobApi.JobMessagesRequest GetJobMessages is a streaming api for streaming job messages from the service One request will connect you to the job and you'll get a stream of job state and job messages back; one is used for logging and the other for detecting the job ended.
static interface	JobApi.JobMessagesRequestOrBuilder
static class	JobApi.JobMessagesResponse Protobuf type org.apache.beam.runner_api.v1.JobMessagesResponse
static interface	JobApi.JobMessagesResponseOrBuilder
static class	JobApi.JobState Enumeration of all JobStates
static interface	JobApi.JobStateOrBuilder
static class	JobApi.PrepareJobRequest Prepare is a synchronous request that returns a preparationId back Throws error GRPC_STATUS_UNAVAILABLE if server is down Throws error ALREADY_EXISTS if the jobName is reused.
static interface	JobApi.PrepareJobRequestOrBuilder
static class	JobApi.PrepareJobResponse Protobuf type org.apache.beam.runner_api.v1.PrepareJobResponse
static interface	JobApi.PrepareJobResponseOrBuilder
static class	JobApi.RunJobRequest Run is a synchronous request that returns a jobId back.
static interface	JobApi.RunJobRequestOrBuilder
static class	JobApi.RunJobResponse Protobuf type org.apache.beam.runner_api.v1.RunJobResponse
static interface	JobApi.RunJobResponseOrBuilder

Method Summary

Modifier and Type	Method and Description
static com.google.protobuf.Descriptors.FileDescriptor	getDescriptor()
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

Methods inherited from class java.lang.Object

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

Method Detail

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)

getDescriptor

public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()