CoderProperties (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.testing

Class CoderProperties

• java.lang.Object
• • com.google.cloud.dataflow.sdk.testing.CoderProperties

• ---

  
  

  public class CoderProperties
  extends Object

  Properties for use in Coder tests. These are implemented with junit assertions rather than as predicates for the sake of error messages.

  We serialize and deserialize the coder to make sure that any state information required by the coder is preserved. This causes tests written such that coders that lose information during serialization or change state during encoding/decoding will fail.

• • Field Summary

    Fields 

    Modifier and Type	Field and Description
    static List<Coder.Context>	ALL_CONTEXTS All the contexts, for use in test cases.

  • Constructor Summary

    Constructors 

    Constructor and Description
    CoderProperties()

  • Method Summary

    All Methods Static Methods Concrete Methods 

    Modifier and Type	Method and Description
    static <T> void	coderAllowsEncoding(Coder<T> coder, String encodingId)
    static <T> void	coderConsistentWithEquals(Coder<T> coder, T value1, T value2)
    static <T> void	coderConsistentWithEqualsInContext(Coder<T> coder, Coder.Context context, T value1, T value2)
    static <T,CollectionT extends Collection<T>> void	coderDecodeEncodeContentsEqual(Coder<CollectionT> coder, CollectionT value) Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in any Coder.Context.
    static <T,CollectionT extends Collection<T>> void	coderDecodeEncodeContentsEqualInContext(Coder<CollectionT> coder, Coder.Context context, CollectionT value) Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in the given Coder.Context.
    static <T,IterableT extends Iterable<T>> void	coderDecodeEncodeContentsInSameOrder(Coder<IterableT> coder, IterableT value) Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in any Coder.Context.
    static <T,IterableT extends Iterable<T>> void	coderDecodeEncodeContentsInSameOrderInContext(Coder<IterableT> coder, Coder.Context context, IterableT value) Verifies that for the given Coder<Iterable<T>>, and value of type Iterable<T>, encoding followed by decoding yields an equal value of type Collection<T>, in the given Coder.Context.
    static <T> void	coderDecodeEncodeEqual(Coder<T> coder, T value) Verifies that for the given Coder<T>, and value of type T, encoding followed by decoding yields an equal value of type T, in any Coder.Context.
    static <T> void	coderDecodeEncodeEqualInContext(Coder<T> coder, Coder.Context context, T value) Verifies that for the given Coder<T>, Coder.Context, and value of type T, encoding followed by decoding yields an equal value of type T.
    static <T> void	coderDecodesBase64(Coder<T> coder, List<String> base64Encodings, List<T> values)
    static <T> void	coderDecodesBase64(Coder<T> coder, String base64Encoding, T value)
    static <T,IterableT extends Iterable<T>> void	coderDecodesBase64ContentsEqual(Coder<IterableT> coder, List<String> base64Encodings, List<IterableT> expected)
    static <T,IterableT extends Iterable<T>> void	coderDecodesBase64ContentsEqual(Coder<IterableT> coder, String base64Encoding, IterableT expected)
    static <T> void	coderDeterministic(Coder<T> coder, T value1, T value2) Verifies that for the given Coder<T>, and values of type T, if the values are equal then the encoded bytes are equal, in any Coder.Context.
    static <T> void	coderDeterministicInContext(Coder<T> coder, Coder.Context context, T value1, T value2) Verifies that for the given Coder<T>, Coder.Context, and values of type T, if the values are equal then the encoded bytes are equal.
    static <T> void	coderEncodesBase64(Coder<T> coder, List<T> values, List<String> base64Encodings)
    static <T> void	coderEncodesBase64(Coder<T> coder, T value, String base64Encoding)
    static <T> void	coderHasEncodingId(Coder<T> coder, String encodingId)
    static <T> void	coderSerializable(Coder<T> coder)
    static <T> void	structuralValueConsistentWithEquals(Coder<T> coder, T value1, T value2)
    static <T> void	structuralValueConsistentWithEqualsInContext(Coder<T> coder, Coder.Context context, T value1, T value2)

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • Field Detail

    • ALL_CONTEXTS

      public static final List<Coder.Context> ALL_CONTEXTS

      All the contexts, for use in test cases.

  • Constructor Detail

    • CoderProperties

      public CoderProperties()

  • Method Detail

    • coderDeterministic

      public static <T> void coderDeterministic(Coder<T> coder,
                                                T value1,
                                                T value2)
                                         throws Exception

      Verifies that for the given Coder<T>, and values of type T, if the values are equal then the encoded bytes are equal, in any Coder.Context.

      Throws:

      Exception

    • coderDeterministicInContext

      public static <T> void coderDeterministicInContext(Coder<T> coder,
                                                         Coder.Context context,
                                                         T value1,
                                                         T value2)
                                                  throws Exception

      Verifies that for the given Coder<T>, Coder.Context, and values of type T, if the values are equal then the encoded bytes are equal.

      Throws:

      Exception

    • coderDecodeEncodeEqual

      public static <T> void coderDecodeEncodeEqual(Coder<T> coder,
                                                    T value)
                                             throws Exception

      Verifies that for the given Coder<T>, and value of type T, encoding followed by decoding yields an equal value of type T, in any Coder.Context.

      Throws:

      Exception

    • coderDecodeEncodeEqualInContext

      public static <T> void coderDecodeEncodeEqualInContext(Coder<T> coder,
                                                             Coder.Context context,
                                                             T value)
                                                      throws Exception

      Verifies that for the given Coder<T>, Coder.Context, and value of type T, encoding followed by decoding yields an equal value of type T.

      Throws:

      Exception

    • coderDecodeEncodeContentsEqual

      public static <T,CollectionT extends Collection<T>> void coderDecodeEncodeContentsEqual(Coder<CollectionT> coder,
                                                                                              CollectionT value)
                                                                                       throws Exception

      Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in any Coder.Context.

      Throws:

      Exception

    • coderDecodeEncodeContentsEqualInContext

      public static <T,CollectionT extends Collection<T>> void coderDecodeEncodeContentsEqualInContext(Coder<CollectionT> coder,
                                                                                                       Coder.Context context,
                                                                                                       CollectionT value)
                                                                                                throws Exception

      Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in the given Coder.Context.

      Throws:

      Exception

    • coderDecodeEncodeContentsInSameOrder

      public static <T,IterableT extends Iterable<T>> void coderDecodeEncodeContentsInSameOrder(Coder<IterableT> coder,
                                                                                                IterableT value)
                                                                                         throws Exception

      Verifies that for the given Coder<Collection<T>>, and value of type Collection<T>, encoding followed by decoding yields an equal value of type Collection<T>, in any Coder.Context.

      Throws:

      Exception

    • coderDecodeEncodeContentsInSameOrderInContext

      public static <T,IterableT extends Iterable<T>> void coderDecodeEncodeContentsInSameOrderInContext(Coder<IterableT> coder,
                                                                                                         Coder.Context context,
                                                                                                         IterableT value)
                                                                                                  throws Exception

      Verifies that for the given Coder<Iterable<T>>, and value of type Iterable<T>, encoding followed by decoding yields an equal value of type Collection<T>, in the given Coder.Context.

      Throws:

      Exception

    • coderSerializable

      public static <T> void coderSerializable(Coder<T> coder)

    • coderConsistentWithEquals

      public static <T> void coderConsistentWithEquals(Coder<T> coder,
                                                       T value1,
                                                       T value2)
                                                throws Exception

      Throws:

      Exception

    • coderConsistentWithEqualsInContext

      public static <T> void coderConsistentWithEqualsInContext(Coder<T> coder,
                                                                Coder.Context context,
                                                                T value1,
                                                                T value2)
                                                         throws Exception

      Throws:

      Exception

    • coderHasEncodingId

      public static <T> void coderHasEncodingId(Coder<T> coder,
                                                String encodingId)
                                         throws Exception

      Throws:

      Exception

    • coderAllowsEncoding

      public static <T> void coderAllowsEncoding(Coder<T> coder,
                                                 String encodingId)
                                          throws Exception

      Throws:

      Exception

    • structuralValueConsistentWithEquals

      public static <T> void structuralValueConsistentWithEquals(Coder<T> coder,
                                                                 T value1,
                                                                 T value2)
                                                          throws Exception

      Throws:

      Exception

    • structuralValueConsistentWithEqualsInContext

      public static <T> void structuralValueConsistentWithEqualsInContext(Coder<T> coder,
                                                                          Coder.Context context,
                                                                          T value1,
                                                                          T value2)
                                                                   throws Exception

      Throws:

      Exception

    • coderDecodesBase64

      public static <T> void coderDecodesBase64(Coder<T> coder,
                                                String base64Encoding,
                                                T value)
                                         throws Exception

      Throws:

      Exception

    • coderDecodesBase64

      public static <T> void coderDecodesBase64(Coder<T> coder,
                                                List<String> base64Encodings,
                                                List<T> values)
                                         throws Exception

      Throws:

      Exception

    • coderEncodesBase64

      public static <T> void coderEncodesBase64(Coder<T> coder,
                                                T value,
                                                String base64Encoding)
                                         throws Exception

      Throws:

      Exception

    • coderEncodesBase64

      public static <T> void coderEncodesBase64(Coder<T> coder,
                                                List<T> values,
                                                List<String> base64Encodings)
                                         throws Exception

      Throws:

      Exception

    • coderDecodesBase64ContentsEqual

      public static <T,IterableT extends Iterable<T>> void coderDecodesBase64ContentsEqual(Coder<IterableT> coder,
                                                                                           String base64Encoding,
                                                                                           IterableT expected)
                                                                                    throws Exception

      Throws:

      Exception

    • coderDecodesBase64ContentsEqual

      public static <T,IterableT extends Iterable<T>> void coderDecodesBase64ContentsEqual(Coder<IterableT> coder,
                                                                                           List<String> base64Encodings,
                                                                                           List<IterableT> expected)
                                                                                    throws Exception

      Throws:

      Exception