Package org.apache.beam.runners.dataflow.internal

Class IsmFormat.MetadataKeyCoder<K>

java.lang.Object
org.apache.beam.sdk.coders.Coder<K>
org.apache.beam.sdk.coders.StructuredCoder<K>
org.apache.beam.runners.dataflow.internal.IsmFormat.MetadataKeyCoder<K>
All Implemented Interfaces:
Serializable
Enclosing class:
IsmFormat
public static class IsmFormat.MetadataKeyCoder<K> extends StructuredCoder<K>
A coder for metadata key component. Can be used to wrap key component coder allowing for the metadata key component to be used as a place holder instead of an actual key.
See Also:

  • Method Details

    • of

      public static <K> IsmFormat.MetadataKeyCoder<K> of(Coder<K> keyCoder)

    • getKeyCoder

      public Coder<K> getKeyCoder()

    • encode

      public void encode(K value, OutputStream outStream) throws CoderException, IOException
      Description copied from class: Coder
      Encodes the given value of type T onto the given output stream. Multiple elements can be encoded next to each other on the output stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      encode in class Coder<K>
      Throws:
      CoderException - if the value could not be encoded for some reason
      IOException - if writing to the OutputStream fails for some reason

    • decode

      public K decode(InputStream inStream) throws CoderException, IOException
      Description copied from class: Coder
      Decodes a value of type T from the given input stream in the given context. Returns the decoded value. Multiple elements can be encoded next to each other on the input stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      decode in class Coder<K>
      Throws:
      CoderException - if the value could not be decoded for some reason
      IOException - if reading from the InputStream fails for some reason

    • getCoderArguments

      public List<Coder<?>> getCoderArguments()
      Description copied from class: Coder
      If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list.
      Specified by:
      getCoderArguments in class Coder<K>

    • verifyDeterministic

      public void verifyDeterministic() throws Coder.NonDeterministicException
      Description copied from class: Coder
      Throw Coder.NonDeterministicException if the coding is not deterministic.

      In order for a Coder to be considered deterministic, the following must be true:

      • two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
      • the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.
      Specified by:
      verifyDeterministic in class Coder<K>
      Throws:
      Coder.NonDeterministicException - if this coder is not deterministic.