Package org.apache.beam.sdk.extensions.protobuf

Class ByteStringCoder

  • All Implemented Interfaces:
    java.io.Serializable
    public class ByteStringCoder
extends org.apache.beam.sdk.coders.AtomicCoder<com.google.protobuf.ByteString>
    A Coder for ByteString objects based on their encoded Protocol Buffer form.

    When this code is used in a nested Coder.Context, the serialized ByteString objects are first delimited by their size.

    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

        org.apache.beam.sdk.coders.Coder.Context, org.apache.beam.sdk.coders.Coder.NonDeterministicException

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean consistentWithEquals()
      com.google.protobuf.ByteString decode​(java.io.InputStream inStream)  
      com.google.protobuf.ByteString decode​(java.io.InputStream inStream, org.apache.beam.sdk.coders.Coder.Context context)  
      void encode​(com.google.protobuf.ByteString value, java.io.OutputStream outStream)  
      void encode​(com.google.protobuf.ByteString value, java.io.OutputStream outStream, org.apache.beam.sdk.coders.Coder.Context context)  
      protected long getEncodedElementByteSize​(com.google.protobuf.ByteString value)  
      org.apache.beam.sdk.values.TypeDescriptor<com.google.protobuf.ByteString> getEncodedTypeDescriptor()  
      boolean isRegisterByteSizeObserverCheap​(com.google.protobuf.ByteString value)
      static ByteStringCoder of()  
      void verifyDeterministic()  

      • Methods inherited from class org.apache.beam.sdk.coders.AtomicCoder

        equals, getCoderArguments, getComponents, hashCode

      • Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder

        toString

      • Methods inherited from class org.apache.beam.sdk.coders.Coder

        registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • encode

        public void encode​(com.google.protobuf.ByteString value,
                   java.io.OutputStream outStream)
            throws java.io.IOException,
                   org.apache.beam.sdk.coders.CoderException
        Specified by:
        encode in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>
        Throws:
        java.io.IOException
        org.apache.beam.sdk.coders.CoderException

      • encode

        public void encode​(com.google.protobuf.ByteString value,
                   java.io.OutputStream outStream,
                   org.apache.beam.sdk.coders.Coder.Context context)
            throws java.io.IOException,
                   org.apache.beam.sdk.coders.CoderException
        Overrides:
        encode in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>
        Throws:
        java.io.IOException
        org.apache.beam.sdk.coders.CoderException

      • decode

        public com.google.protobuf.ByteString decode​(java.io.InputStream inStream)
                                      throws java.io.IOException
        Specified by:
        decode in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>
        Throws:
        java.io.IOException

      • decode

        public com.google.protobuf.ByteString decode​(java.io.InputStream inStream,
                                             org.apache.beam.sdk.coders.Coder.Context context)
                                      throws java.io.IOException
        Overrides:
        decode in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>
        Throws:
        java.io.IOException

      • getEncodedElementByteSize

        protected long getEncodedElementByteSize​(com.google.protobuf.ByteString value)
                                  throws java.lang.Exception
        Overrides:
        getEncodedElementByteSize in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>
        Throws:
        java.lang.Exception

      • verifyDeterministic

        public void verifyDeterministic()
        Overrides:
        verifyDeterministic in class org.apache.beam.sdk.coders.AtomicCoder<com.google.protobuf.ByteString>

      • consistentWithEquals

        public boolean consistentWithEquals()

        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 org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>

      • isRegisterByteSizeObserverCheap

        public boolean isRegisterByteSizeObserverCheap​(com.google.protobuf.ByteString value)

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

        Overrides:
        isRegisterByteSizeObserverCheap in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>

      • getEncodedTypeDescriptor

        public org.apache.beam.sdk.values.TypeDescriptor<com.google.protobuf.ByteString> getEncodedTypeDescriptor()
        Overrides:
        getEncodedTypeDescriptor in class org.apache.beam.sdk.coders.Coder<com.google.protobuf.ByteString>