Class NullableCoder<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

NullableCoder

Implements

Coder<T | undefined>

Index

Constructors

Properties

elementCoder type URN

Methods

decode encode toProto

Constructors

constructor

new NullableCoder<T>(elementCoder: Coder<T>): NullableCoder<T>
Type Parameters
- T
Parameters
- elementCoder: Coder<T>
Returns NullableCoder<T>
- Defined in src/apache_beam/coders/standard_coders.ts:166

Properties

elementCoder

elementCoder: Coder<T>

type

type: string = "nullablecoder"

`Static` URN

URN: string = "beam:coder:nullable:v1"

Methods

decode

decode(reader: Reader, context: Context): undefined | T
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 undefined | T
Implementation of Coder.decode
- Defined in src/apache_beam/coders/standard_coders.ts:179

encode

encode(element: undefined | T, writer: Writer, context: Context): void
Encode an element into a stream of bytes.
Parameters
- element: undefined | 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 void
Implementation of Coder.encode
- Defined in src/apache_beam/coders/standard_coders.ts:170

toProto

toProto(pipelineContext: ProtoContext): Coder
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
Implementation of Coder.toProto
- Defined in src/apache_beam/coders/standard_coders.ts:187

Generated using TypeDoc