Class GlobalWindowCoder

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

Hierarchy

GlobalWindowCoder

Implements

Coder<GlobalWindow>

Index

Constructors

Properties

Methods

decode encode toProto

Constructors

constructor

new GlobalWindowCoder(): GlobalWindowCoder
Returns GlobalWindowCoder

Properties

`Static` INSTANCE

INSTANCE: GlobalWindowCoder = ...

`Static` URN

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

Methods

decode

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

encode

encode(value: GlobalWindow, writer: Writer, context: Context): void
Encode an element into a stream of bytes.
Parameters
- value: GlobalWindow
  
  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/required_coders.ts:454

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/required_coders.ts:460

Generated using TypeDoc