apache_beam.transforms.environments module

Environments concepts.

For internal use only. No backwards compatibility guarantees.

class apache_beam.transforms.environments.Environment(capabilities=(), artifacts=(), resource_hints=None)

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()

to_runner_api_parameter(context)

capabilities()

resource_hints()

classmethod register_urn(urn, parameter_type, constructor=None)

classmethod get_env_cls_from_urn(urn)

to_runner_api(context)

classmethod from_runner_api(proto, context)

classmethod from_options(options)

Creates an Environment object from PortableOptions.

Parameters:options – The PortableOptions object.

class apache_beam.transforms.environments.DefaultEnvironment(capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

Used as a stub when context is missing a default environment.

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

class apache_beam.transforms.environments.DockerEnvironment(container_image=None, capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

classmethod from_options(options)

classmethod from_container_image(container_image, artifacts=(), resource_hints=None)

static default_docker_image()

class apache_beam.transforms.environments.ProcessEnvironment(command, os='', arch='', env=None, capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

static parse_environment_variables(variables)

classmethod from_options(options)

class apache_beam.transforms.environments.ExternalEnvironment(url, params=None, capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

classmethod from_options(options)

class apache_beam.transforms.environments.EmbeddedPythonEnvironment(capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(unused_payload, capabilities, artifacts, resource_hints, context)

classmethod from_options(options)

classmethod default()

class apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment(state_cache_size=None, data_buffer_time_limit_ms=None, capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

classmethod from_options(options)

static parse_config(s)

classmethod default()

class apache_beam.transforms.environments.SubprocessSDKEnvironment(command_string, capabilities=(), artifacts=(), resource_hints=None)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

classmethod from_options(options)

classmethod from_command_string(command_string)

class apache_beam.transforms.environments.AnyOfEnvironment(environments)

Bases: apache_beam.transforms.environments.Environment

to_runner_api_parameter(context)

static from_runner_api_parameter(payload, capabilities, artifacts, resource_hints, context)

static create_proto(environments: Iterable[org.apache.beam.model.pipeline.v1.beam_runner_api_pb2.Environment]) → org.apache.beam.model.pipeline.v1.beam_runner_api_pb2.Environment

class apache_beam.transforms.environments.PyPIArtifactRegistry

Bases: object

classmethod register_artifact(name, version)

classmethod get_artifacts()