apache_beam.portability.api.beam_job_api_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class apache_beam.portability.api.beam_job_api_pb2_grpc.JobServiceStub(channel)

Bases: object

Job Service for running RunnerAPI pipelines

Constructor.

Parameters:channel – A grpc.Channel.

class apache_beam.portability.api.beam_job_api_pb2_grpc.JobServiceServicer

Bases: object

Job Service for running RunnerAPI pipelines

Prepare(request, context)

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

Run(request, context)

Submit the job for execution

GetJobs(request, context)

Get a list of all invoked jobs

GetState(request, context)

Get the current state of the job

GetPipeline(request, context)

Get the job’s pipeline

Cancel(request, context)

Cancel the job

GetStateStream(request, context)

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

GetMessageStream(request, context)

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

GetJobMetrics(request, context)

Fetch metrics for a given job

DescribePipelineOptions(request, context)

Get the supported pipeline options of the runner

apache_beam.portability.api.beam_job_api_pb2_grpc.add_JobServiceServicer_to_server(servicer, server)

class apache_beam.portability.api.beam_job_api_pb2_grpc.JobService

Bases: object

Job Service for running RunnerAPI pipelines

static Prepare(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Run(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetJobs(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetState(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetPipeline(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Cancel(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetStateStream(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetMessageStream(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetJobMetrics(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static DescribePipelineOptions(request, target, options=(), channel_credentials=None, call_credentials=None, compression=None, wait_for_ready=None, timeout=None, metadata=None)