Package software.amazon.awscdk.services.kinesisfirehose

Class ParquetOutputFormat.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.ParquetOutputFormat.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ParquetOutputFormat>

Enclosing class:

ParquetOutputFormat

@Stability(Stable)
public static final class ParquetOutputFormat.Builder
extends Object
implements software.amazon.jsii.Builder<ParquetOutputFormat>

A fluent builder for ParquetOutputFormat.

Method Summary

Modifier and Type	Method	Description
ParquetOutputFormat.Builder	blockSize(Size blockSize)	The Hadoop Distributed File System (HDFS) block size.
ParquetOutputFormat	build()
ParquetOutputFormat.Builder	compression(ParquetCompression compression)	The compression code to use over data blocks.
static ParquetOutputFormat.Builder	create()
ParquetOutputFormat.Builder	enableDictionaryCompression(Boolean enableDictionaryCompression)	Indicates whether to enable dictionary compression.
ParquetOutputFormat.Builder	maxPadding(Size maxPadding)	The maximum amount of padding to apply.
ParquetOutputFormat.Builder	pageSize(Size pageSize)	The Parquet page size.
ParquetOutputFormat.Builder	writerVersion(ParquetWriterVersion writerVersion)	Indicates the version of Parquet to output.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static ParquetOutputFormat.Builder create()

Returns:

a new instance of ParquetOutputFormat.Builder.

blockSize

@Stability(Stable)
public ParquetOutputFormat.Builder blockSize(Size blockSize)

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. Firehose uses this value for padding calculations.

Default: `Size.mebibytes(256)`

Parameters:

blockSize - The Hadoop Distributed File System (HDFS) block size. This parameter is required.

Returns:

this

compression

@Stability(Stable)
public ParquetOutputFormat.Builder compression(ParquetCompression compression)

The compression code to use over data blocks.

The possible values are UNCOMPRESSED , SNAPPY , and GZIP. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

Default: `SNAPPY`

Parameters:

compression - The compression code to use over data blocks. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-compression

enableDictionaryCompression

@Stability(Stable)
public ParquetOutputFormat.Builder enableDictionaryCompression(Boolean enableDictionaryCompression)

Indicates whether to enable dictionary compression.

Default: `false`

Parameters:

enableDictionaryCompression - Indicates whether to enable dictionary compression. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-enabledictionarycompression

maxPadding

@Stability(Stable)
public ParquetOutputFormat.Builder maxPadding(Size maxPadding)

The maximum amount of padding to apply.

This is useful if you intend to copy the data from Amazon S3 to HDFS before querying.

Default: no padding is applied

Parameters:

maxPadding - The maximum amount of padding to apply. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-maxpaddingbytes

pageSize

@Stability(Stable)
public ParquetOutputFormat.Builder pageSize(Size pageSize)

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.

Default: `Size.mebibytes(1)`

Parameters:

pageSize - The Parquet page size. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-pagesizebytes

writerVersion

@Stability(Stable)
public ParquetOutputFormat.Builder writerVersion(ParquetWriterVersion writerVersion)

Indicates the version of Parquet to output.

The possible values are V1 and V2

Default: `V1`

Parameters:

writerVersion - Indicates the version of Parquet to output. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-writerversion

build

@Stability(Stable)
public ParquetOutputFormat build()

Specified by:

build in interface software.amazon.jsii.Builder<ParquetOutputFormat>

Returns:

a newly built instance of ParquetOutputFormat.