Package org.apache.beam.sdk.io.fs

Class MetadataCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<MatchResult.Metadata>
org.apache.beam.sdk.coders.StructuredCoder<MatchResult.Metadata>
org.apache.beam.sdk.coders.AtomicCoder<MatchResult.Metadata>
org.apache.beam.sdk.io.fs.MetadataCoder
All Implemented Interfaces:
Serializable
public class MetadataCoder extends AtomicCoder<MatchResult.Metadata>
A Coder for MatchResult.Metadata.

The MatchResult.Metadata.lastModifiedMillis() field was added after this coder was already deployed, so this class decodes a default value for backwards compatibility. See MetadataCoderV2 for retaining timestamp information.

See Also:

  • Method Details

    • of

      public static MetadataCoder of()
      Returns the singleton MetadataCoder instance.

    • encode

      public void encode(MatchResult.Metadata value, OutputStream os) throws 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<MatchResult.Metadata>
      Throws:
      IOException - if writing to the OutputStream fails for some reason

    • decode

      public MatchResult.Metadata decode(InputStream is) throws 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<MatchResult.Metadata>
      Throws:
      IOException - if reading from the InputStream fails for some reason

    • consistentWithEquals

      public boolean consistentWithEquals()
      Description copied from class: Coder
      Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

      Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

      This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

      By default, returns false.

      Overrides:
      consistentWithEquals in class Coder<MatchResult.Metadata>