Package software.amazon.awscdk.services.kinesisfirehose

Class OrcOutputFormat.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.OrcOutputFormat.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OrcOutputFormat>

Enclosing class:

OrcOutputFormat

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

A fluent builder for OrcOutputFormat.

Method Summary

Modifier and Type	Method	Description
OrcOutputFormat.Builder	blockSize(Size blockSize)	The Hadoop Distributed File System (HDFS) block size.
OrcOutputFormat.Builder	bloomFilterColumns(List<String> bloomFilterColumns)	The column names for which you want Firehose to create bloom filters.
OrcOutputFormat.Builder	bloomFilterFalsePositiveProbability(Number bloomFilterFalsePositiveProbability)	The Bloom filter false positive probability (FPP).
OrcOutputFormat	build()
OrcOutputFormat.Builder	compression(OrcCompression compression)	The compression code to use over data blocks.
static OrcOutputFormat.Builder	create()
OrcOutputFormat.Builder	dictionaryKeyThreshold(Number dictionaryKeyThreshold)	Determines whether dictionary encoding should be applied to a column.
OrcOutputFormat.Builder	enablePadding(Boolean enablePadding)	Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries.
OrcOutputFormat.Builder	formatVersion(OrcFormatVersion formatVersion)	The version of the ORC format to write.
OrcOutputFormat.Builder	paddingTolerance(Number paddingTolerance)	A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
OrcOutputFormat.Builder	rowIndexStride(Number rowIndexStride)	The number of rows between index entries.
OrcOutputFormat.Builder	stripeSize(Size stripeSize)	The number of bytes in each stripe.

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 OrcOutputFormat.Builder create()

Returns:

a new instance of OrcOutputFormat.Builder.

blockSize

@Stability(Stable)
public OrcOutputFormat.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

bloomFilterColumns

@Stability(Stable)
public OrcOutputFormat.Builder bloomFilterColumns(List<String> bloomFilterColumns)

The column names for which you want Firehose to create bloom filters.

Default: no bloom filters are created

Parameters:

bloomFilterColumns - The column names for which you want Firehose to create bloom filters. This parameter is required.

Returns:

this

See Also:

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

bloomFilterFalsePositiveProbability

@Stability(Stable)
public OrcOutputFormat.Builder bloomFilterFalsePositiveProbability(Number bloomFilterFalsePositiveProbability)

The Bloom filter false positive probability (FPP).

The lower the FPP, the bigger the bloom filter.

Default: `0.05`

Parameters:

bloomFilterFalsePositiveProbability - The Bloom filter false positive probability (FPP). This parameter is required.

Returns:

this

See Also:

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

compression

@Stability(Stable)
public OrcOutputFormat.Builder compression(OrcCompression compression)

The compression code to use over data blocks.

The possible values are NONE , SNAPPY , and ZLIB. 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/TemplateReference/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-compression

dictionaryKeyThreshold

@Stability(Stable)
public OrcOutputFormat.Builder dictionaryKeyThreshold(Number dictionaryKeyThreshold)

Determines whether dictionary encoding should be applied to a column.

If the number of distinct keys (unique values) in a column exceeds this fraction of the total non-null rows in that column, dictionary encoding will be turned off for that specific column.

To turn off dictionary encoding, set this threshold to 0. To always use dictionary encoding, set this threshold to 1.

Default: `0.8`

Parameters:

dictionaryKeyThreshold - Determines whether dictionary encoding should be applied to a column. This parameter is required.

Returns:

this

See Also:

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

enablePadding

@Stability(Stable)
public OrcOutputFormat.Builder enablePadding(Boolean enablePadding)

Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries.

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

Default: `false`

Parameters:

enablePadding - Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This parameter is required.

Returns:

this

See Also:

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

formatVersion

@Stability(Stable)
public OrcOutputFormat.Builder formatVersion(OrcFormatVersion formatVersion)

The version of the ORC format to write.

The possible values are V0_11 and V0_12.

Default: `V0_12`

Parameters:

formatVersion - The version of the ORC format to write. This parameter is required.

Returns:

this

See Also:

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

paddingTolerance

@Stability(Stable)
public OrcOutputFormat.Builder paddingTolerance(Number paddingTolerance)

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.

The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when EnablePadding is false .

Default: `0.05` if `enablePadding` is `true`

Parameters:

paddingTolerance - A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. This parameter is required.

Returns:

this

See Also:

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

rowIndexStride

@Stability(Stable)
public OrcOutputFormat.Builder rowIndexStride(Number rowIndexStride)

The number of rows between index entries.

Default: 10000

Parameters:

rowIndexStride - The number of rows between index entries. This parameter is required.

Returns:

this

See Also:

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

stripeSize

@Stability(Stable)
public OrcOutputFormat.Builder stripeSize(Size stripeSize)

The number of bytes in each stripe.

The default is 64 MiB and the minimum is 8 MiB.

Default: `Size.mebibytes(64)`

Parameters:

stripeSize - The number of bytes in each stripe. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public OrcOutputFormat build()

Specified by:

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

Returns:

a newly built instance of OrcOutputFormat.