apache_beam.portability.api package

Submodules

apache_beam.portability.api.beam_fn_api_pb2 module

class apache_beam.portability.api.beam_fn_api_pb2.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.

class apache_beam.portability.api.beam_fn_api_pb2.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

class apache_beam.portability.api.beam_fn_api_pb2.BeamFnDataServicer[source]

Bases: object

Stable

Data(request_iterator, context)[source]

Used to send data between harnesses.

class apache_beam.portability.api.beam_fn_api_pb2.BeamFnDataStub(channel)[source]

Bases: object

Stable

class apache_beam.portability.api.beam_fn_api_pb2.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.

class apache_beam.portability.api.beam_fn_api_pb2.BeamFnLoggingStub(channel)[source]

Bases: object

Stable

class apache_beam.portability.api.beam_fn_api_pb2.BeamFnStateServicer[source]

Bases: object

State(request_iterator, context)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BeamFnStateStub(channel)[source]

Bases: object

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnControlServicer[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Control(request_iterator, context)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnControlStub[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Control(request_iterator, timeout, metadata=None, with_call=False, protocol_options=None)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnDataServicer[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Data(request_iterator, context)[source]

Used to send data between harnesses.

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnDataStub[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Data(request_iterator, timeout, metadata=None, with_call=False, protocol_options=None)[source]

Used to send data between harnesses.

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnLoggingServicer[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Logging(request_iterator, context)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnLoggingStub[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

Logging(request_iterator, timeout, metadata=None, with_call=False, protocol_options=None)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnStateServicer[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

State(request_iterator, context)[source]

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

class apache_beam.portability.api.beam_fn_api_pb2.BetaBeamFnStateStub[source]

Bases: object

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This class was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0.

State(request_iterator, timeout, metadata=None, with_call=False, protocol_options=None)[source]

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

apache_beam.portability.api.beam_fn_api_pb2.add_BeamFnControlServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2.add_BeamFnDataServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2.add_BeamFnLoggingServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2.add_BeamFnStateServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnControl_server(servicer, pool=None, pool_size=None, default_timeout=None, maximum_timeout=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnControl_stub(channel, host=None, metadata_transformer=None, pool=None, pool_size=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnData_server(servicer, pool=None, pool_size=None, default_timeout=None, maximum_timeout=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnData_stub(channel, host=None, metadata_transformer=None, pool=None, pool_size=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnLogging_server(servicer, pool=None, pool_size=None, default_timeout=None, maximum_timeout=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnLogging_stub(channel, host=None, metadata_transformer=None, pool=None, pool_size=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnState_server(servicer, pool=None, pool_size=None, default_timeout=None, maximum_timeout=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2.beta_create_BeamFnState_stub(channel, host=None, metadata_transformer=None, pool=None, pool_size=None)[source]

The Beta API is deprecated for 0.15.0 and later.

It is recommended to use the GA API (classes and functions in this file not marked beta) for all further purposes. This function was generated only to ease transition from grpcio<0.15.0 to grpcio>=0.15.0

apache_beam.portability.api.beam_fn_api_pb2_grpc module

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.

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

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.

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

Bases: object

Stable

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.

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

Bases: object

Stable

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.

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

Bases: object

apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnControlServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnDataServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnLoggingServicer_to_server(servicer, server)[source]
apache_beam.portability.api.beam_fn_api_pb2_grpc.add_BeamFnStateServicer_to_server(servicer, server)[source]

apache_beam.portability.api.beam_runner_api_pb2 module

apache_beam.portability.api.beam_runner_api_pb2_grpc module

apache_beam.portability.api.standard_window_fns_pb2 module

apache_beam.portability.api.standard_window_fns_pb2_grpc module

Module contents

For internal use only; no backwards-compatibility guarantees.

Automatically generated when running setup.py sdist or build[_py].