StringUtf8Coder (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, you can use unsupported SDKs temporarily while you upgrade your pipelines. For more information, see Using an unsupported SDK.

For information on migrating from the 1.x SDK, see Migrating from Dataflow SDK 1.x for Java.

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 StringUtf8Coder

• 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<String>
      • • com.google.cloud.dataflow.sdk.coders.StringUtf8Coder

• All Implemented Interfaces:

  Coder<String>, Serializable

  ---

  
  

  public class StringUtf8Coder
  extends AtomicCoder<String>

  A Coder that encodes Strings in UTF-8 encoding. If in a nested context, prefixes the string with an integer length field, encoded via a VarIntCoder.

  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).
    String	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
    void	encode(String 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(String value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
    static StringUtf8Coder	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, isRegisterByteSizeObserverCheap, 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 StringUtf8Coder of()

    • encode

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

      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 String decode(InputStream inStream,
                           Coder.Context context)
                    throws IOException

      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<String>

      Overrides:

      consistentWithEquals in class StandardCoder<String>

      Returns:

      true. This coder is injective.

    • getEncodedElementByteSize

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

      Returns the size in bytes of the encoded value using this coder.

      Overrides:

      getEncodedElementByteSize in class StandardCoder<String>

      Returns:

      the byte size of the UTF-8 encoding of the a string or, in a nested context, the byte size of the encoding plus the encoded length prefix.

      Throws:

      Exception