Interface Coder<T>

This is the base interface for coders, which are responsible in Apache Beam to encode and decode elements of a PCollection.

Type Parameters

  • T

Hierarchy

  • Coder

Implemented by

Methods

  • Decode an element from an incoming stream of bytes.

    Parameters

    • reader: Reader

      a reader that interfaces the coder with the input byte stream

    • context: Context

      the context within which the element should be encoded

    Returns T

  • Encode an element into a stream of bytes.

    Parameters

    • element: T

      an element within a PCollection

    • writer: Writer

      a writer that interfaces the coder with the output byte stream.

    • context: Context

      the context within which the element should be encoded.

    Returns any

  • Convert this coder into its protocol buffer representation for the Runner API. A coder in protobuf format can be shared with other components such as Beam runners, SDK workers; and reconstructed into its runtime representation if necessary.

    Parameters

    • pipelineContext: ProtoContext

      a context that holds relevant pipeline attributes such as other coders already in the pipeline.

    Returns Coder

Generated using TypeDoc