apache_beam.portability.api.beam_fn_api_pb2_grpc module

class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnControlStub(channel)[source]

Bases: object

Control Plane API

Progress reporting and splitting still need further vetting. Also, this may change with the addition of new types of instructions/responses related to metrics.

An API that describes the work that a SDK harness is meant to do. Stable

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnControlServicer[source]

Bases: object

Control Plane API

Progress reporting and splitting still need further vetting. Also, this may change with the addition of new types of instructions/responses related to metrics.

An API that describes the work that a SDK harness is meant to do. Stable

Control(request_iterator, context)[source]

Instructions sent by the runner to the SDK requesting different types of work.

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnControlServicer_to_server(servicer, server)[source]
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnDataStub(channel)[source]

Bases: object

Stable

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnDataServicer[source]

Bases: object

Stable

Data(request_iterator, context)[source]

Used to send data between harnesses.

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnDataServicer_to_server(servicer, server)[source]
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnStateStub(channel)[source]

Bases: object

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnStateServicer[source]

Bases: object

State(request_iterator, context)[source]

Used to get/append/clear state stored by the runner on behalf of the SDK.

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnStateServicer_to_server(servicer, server)[source]
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnLoggingStub(channel)[source]

Bases: object

Stable

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnLoggingServicer[source]

Bases: object

Stable

Logging(request_iterator, context)[source]

Allows for the SDK to emit log entries which the runner can associate with the active job.

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnLoggingServicer_to_server(servicer, server)[source]
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnExternalWorkerPoolStub(channel)[source]

Bases: object

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnExternalWorkerPoolServicer[source]

Bases: object

StartWorker(request, context)[source]

Start the SDK worker with the given ID.

StopWorker(request, context)[source]

Stop the SDK worker.

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnExternalWorkerPoolServicer_to_server(servicer, server)[source]
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnWorkerStatusStub(channel)[source]

Bases: object

API for SDKs to report debug-related statuses to runner during pipeline execution.

Constructor.

Parameters:channel – A grpc.Channel.
class apache_beam.portability.api.beam_fn_api_pb2_grpc.BeamFnWorkerStatusServicer[source]

Bases: object

API for SDKs to report debug-related statuses to runner during pipeline execution.

WorkerStatus(request_iterator, context)[source]
apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnWorkerStatusServicer_to_server(servicer, server)[source]