Package org.apache.beam.runners.fnexecution.wire

Class ByteStringCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
org.apache.beam.sdk.coders.StructuredCoder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
org.apache.beam.sdk.coders.AtomicCoder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
org.apache.beam.runners.fnexecution.wire.ByteStringCoder
All Implemented Interfaces:
Serializable
@Internal public class ByteStringCoder extends AtomicCoder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
A duplicate of ByteStringCoder that uses the Apache Beam vendored protobuf.

For internal use only, no backwards-compatibility guarantees.

See Also:

  • Method Details

    • of

      public static ByteStringCoder of()

    • encode

      public void encode(org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString value, OutputStream outStream) throws IOException, CoderException
      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<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
      Throws:
      IOException - if writing to the OutputStream fails for some reason
      CoderException - if the value could not be encoded for some reason

    • encode

      public void encode(org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString value, OutputStream outStream, Coder.Context context) throws IOException, CoderException
      Description copied from class: Coder
      Encodes the given value of type T onto the given output stream in the given context.
      Overrides:
      encode in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
      Throws:
      IOException - if writing to the OutputStream fails for some reason
      CoderException - if the value could not be encoded for some reason

    • decode

      public org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString decode(InputStream inStream) 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<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
      Throws:
      IOException - if reading from the InputStream fails for some reason

    • decode

      public org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString decode(InputStream inStream, Coder.Context context) 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.
      Overrides:
      decode in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
      Throws:
      IOException - if reading from the InputStream fails for some reason

    • getEncodedElementByteSize

      protected long getEncodedElementByteSize(org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString value) throws Exception
      Description copied from class: Coder
      Returns the size in bytes of the encoded value using this coder.
      Overrides:
      getEncodedElementByteSize in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>
      Throws:
      Exception

    • verifyDeterministic

      public void verifyDeterministic()
      Description copied from class: AtomicCoder
      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.
      .

      Unless overridden, does not throw. An AtomicCoder is presumed to be deterministic

      Overrides:
      verifyDeterministic in class AtomicCoder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>

    • consistentWithEquals

      public boolean consistentWithEquals()
      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.

      Returns true; the encoded output of two invocations of ByteStringCoder in the same Coder.Context will be identical if and only if the original ByteString objects are equal according to Object.equals(java.lang.Object).

      Overrides:
      consistentWithEquals in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString value)
      Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).

      Not intended to be called by user code, but instead by PipelineRunner implementations.

      By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) implementation invokes Coder.getEncodedElementByteSize(T) which requires re-encoding an element unless it is overridden. This is considered expensive.

      Returns true. ByteString.size() returns the size of an array and a VarInt.

      Overrides:
      isRegisterByteSizeObserverCheap in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>

    • getEncodedTypeDescriptor

      public TypeDescriptor<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString> getEncodedTypeDescriptor()
      Description copied from class: Coder
      Returns the TypeDescriptor for the type encoded.
      Overrides:
      getEncodedTypeDescriptor in class Coder<org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString>