VarIntCoder (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. After August 12, 2020, Dataflow will not run jobs using Dataflow 1.x and below. See Migrating from Dataflow SDK 1.x for Java for migration guidance.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk.coders

Class VarIntCoder

• java.lang.Object
• • com.google.cloud.dataflow.sdk.coders.StandardCoder<T>
  • • com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder<T>
    • • com.google.cloud.dataflow.sdk.coders.AtomicCoder<Integer>
      • • com.google.cloud.dataflow.sdk.coders.VarIntCoder

• All Implemented Interfaces:

  Coder<Integer>, Serializable

  ---

  
  

  public class VarIntCoder
  extends AtomicCoder<Integer>

  A Coder that encodes Integers using between 1 and 5 bytes. Negative numbers always take 5 bytes, so BigEndianIntegerCoder may be preferable for integers that are known to often be large or negative.

  See Also:

  Serialized Form

• • Nested Class Summary

    • Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

      Coder.Context, Coder.NonDeterministicException

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    boolean	consistentWithEquals() Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
    Integer	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
    void	encode(Integer value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
    protected long	getEncodedElementByteSize(Integer value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
    boolean	isRegisterByteSizeObserverCheap(Integer value, Coder.Context context) Returns whether Coder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context) 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).
    static VarIntCoder	of()

    • Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder

      getCoderArguments, getInstanceComponents

    • Methods inherited from class com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder

      verifyDeterministic

    • Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder

      asCloudObject, equals, getAllowedEncodings, getComponents, getEncodingId, hashCode, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic

    • Methods inherited from class java.lang.Object

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

• • Method Detail

    • of

      public static VarIntCoder of()

    • encode

      public void encode(Integer value,
                         OutputStream outStream,
                         Coder.Context context)
                  throws IOException,
                         CoderException

      Description copied from interface: Coder
      Encodes the given value of type T onto the given output stream in the given context.

      Throws:

      IOException - if writing to the OutputStream fails for some reason

      CoderException - if the value could not be encoded for some reason

    • decode

      public Integer decode(InputStream inStream,
                            Coder.Context context)
                     throws IOException,
                            CoderException

      Description copied from interface: Coder
      Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

      Throws:

      IOException - if reading from the InputStream fails for some reason

      CoderException - if the value could not be decoded for some reason

    • 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.

      Specified by:

      consistentWithEquals in interface Coder<Integer>

      Overrides:

      consistentWithEquals in class StandardCoder<Integer>

      Returns:

      true. VarIntCoder is injective.

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(Integer value,
                                                     Coder.Context context)

      Returns whether Coder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context) 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.

      Specified by:

      isRegisterByteSizeObserverCheap in interface Coder<Integer>

      Overrides:

      isRegisterByteSizeObserverCheap in class StandardCoder<Integer>

      Returns:

      true. getEncodedElementByteSize(java.lang.Integer, com.google.cloud.dataflow.sdk.coders.Coder.Context) is cheap.

    • getEncodedElementByteSize

      protected long getEncodedElementByteSize(Integer value,
                                               Coder.Context context)
                                        throws Exception

      Description copied from class: StandardCoder
      Returns the size in bytes of the encoded value using this coder.

      Overrides:

      getEncodedElementByteSize in class StandardCoder<Integer>

      Throws:

      Exception