Class ParquetSerDe

java.lang.Object
software.amazon.awssdk.services.firehose.model.ParquetSerDe
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParquetSerDe.Builder,ParquetSerDe>
@Generated("software.amazon.awssdk:codegen") public final class ParquetSerDe extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParquetSerDe.Builder,ParquetSerDe>

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

See Also:

  • Method Details

    • blockSizeBytes

      public final Integer blockSizeBytes()

      The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

      Returns:
      The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

    • pageSizeBytes

      public final Integer pageSizeBytes()

      The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

      Returns:
      The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

    • compression

      public final ParquetCompression compression()

      The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

      If the service returns an enum value that is not available in the current SDK version, compression will return ParquetCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

      Returns:
      The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
      See Also:

    • compressionAsString

      public final String compressionAsString()

      The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

      If the service returns an enum value that is not available in the current SDK version, compression will return ParquetCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

      Returns:
      The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
      See Also:

    • enableDictionaryCompression

      public final Boolean enableDictionaryCompression()

      Indicates whether to enable dictionary compression.

      Returns:
      Indicates whether to enable dictionary compression.

    • maxPaddingBytes

      public final Integer maxPaddingBytes()

      The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

      Returns:
      The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

    • writerVersion

      public final ParquetWriterVersion writerVersion()

      Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

      If the service returns an enum value that is not available in the current SDK version, writerVersion will return ParquetWriterVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from writerVersionAsString().

      Returns:
      Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.
      See Also:

    • writerVersionAsString

      public final String writerVersionAsString()

      Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

      If the service returns an enum value that is not available in the current SDK version, writerVersion will return ParquetWriterVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from writerVersionAsString().

      Returns:
      Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.
      See Also:

    • toBuilder

      public ParquetSerDe.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParquetSerDe.Builder,ParquetSerDe>
      Returns:
      a builder for type T

    • builder

      public static ParquetSerDe.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParquetSerDe.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.