apache_beam.transforms.environments module

Environments concepts.

For internal use only. No backwards compatibility guarantees.

class apache_beam.transforms.environments.Environment(capabilities, artifacts)[source]

Bases: object

Abstract base class for environments.

Represents a type and configuration of environment. Each type of Environment should have a unique urn.

For internal use only. No backwards compatibility guarantees.

artifacts()[source]
to_runner_api_parameter(context)[source]
capabilities()[source]
classmethod register_urn(urn, parameter_type, constructor=None)[source]
classmethod get_env_cls_from_urn(urn)[source]
to_runner_api(context)[source]
classmethod from_runner_api(proto, context)[source]
classmethod from_options(options)[source]

Creates an Environment object from PipelineOptions.

Parameters:options – The PipelineOptions object.
class apache_beam.transforms.environments.DockerEnvironment(container_image=None, capabilities=(), artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
classmethod from_container_image(container_image, artifacts=())[source]
static default_docker_image()[source]
class apache_beam.transforms.environments.ProcessEnvironment(command, os='', arch='', env=None, capabilities=(), artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
class apache_beam.transforms.environments.ExternalEnvironment(url, params=None, capabilities=(), artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
class apache_beam.transforms.environments.EmbeddedPythonEnvironment(capabilities=None, artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(unused_payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
class apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment(state_cache_size=None, data_buffer_time_limit_ms=None, capabilities=(), artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
static parse_config(s)[source]
class apache_beam.transforms.environments.SubprocessSDKEnvironment(command_string, capabilities=(), artifacts=())[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)[source]
static from_runner_api_parameter(payload, capabilities, artifacts, context)[source]
classmethod from_options(options)[source]
class apache_beam.transforms.environments.RunnerAPIEnvironmentHolder(proto)[source]

Bases: apache_beam.transforms.environments.Environment

to_runner_api(context)[source]
capabilities()[source]