OrcSerDe (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.OrcSerDe

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OrcSerDe
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OrcSerDe()

Constructors
Constructor and Description
`OrcSerDe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrcSerDe`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBlockSizeBytes()` The Hadoop Distributed File System (HDFS) block size.
`List<String>`	`getBloomFilterColumns()` The column names for which you want Kinesis Data Firehose to create bloom filters.
`Double`	`getBloomFilterFalsePositiveProbability()` The Bloom filter false positive probability (FPP).
`String`	`getCompression()` The compression code to use over data blocks.
`Double`	`getDictionaryKeyThreshold()` Represents the fraction of the total number of non-null rows.
`Boolean`	`getEnablePadding()` Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries.
`String`	`getFormatVersion()` The version of the file to write.
`Double`	`getPaddingTolerance()` A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
`Integer`	`getRowIndexStride()` The number of rows between index entries.
`Integer`	`getStripeSizeBytes()` The number of bytes in each stripe.
`int`	`hashCode()`
`Boolean`	`isEnablePadding()` Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBlockSizeBytes(Integer blockSizeBytes)` The Hadoop Distributed File System (HDFS) block size.
`void`	`setBloomFilterColumns(Collection<String> bloomFilterColumns)` The column names for which you want Kinesis Data Firehose to create bloom filters.
`void`	`setBloomFilterFalsePositiveProbability(Double bloomFilterFalsePositiveProbability)` The Bloom filter false positive probability (FPP).
`void`	`setCompression(String compression)` The compression code to use over data blocks.
`void`	`setDictionaryKeyThreshold(Double dictionaryKeyThreshold)` Represents the fraction of the total number of non-null rows.
`void`	`setEnablePadding(Boolean enablePadding)` Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries.
`void`	`setFormatVersion(String formatVersion)` The version of the file to write.
`void`	`setPaddingTolerance(Double paddingTolerance)` A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
`void`	`setRowIndexStride(Integer rowIndexStride)` The number of rows between index entries.
`void`	`setStripeSizeBytes(Integer stripeSizeBytes)` The number of bytes in each stripe.
`String`	`toString()` Returns a string representation of this object.
`OrcSerDe`	`withBlockSizeBytes(Integer blockSizeBytes)` The Hadoop Distributed File System (HDFS) block size.
`OrcSerDe`	`withBloomFilterColumns(Collection<String> bloomFilterColumns)` The column names for which you want Kinesis Data Firehose to create bloom filters.
`OrcSerDe`	`withBloomFilterColumns(String... bloomFilterColumns)` The column names for which you want Kinesis Data Firehose to create bloom filters.
`OrcSerDe`	`withBloomFilterFalsePositiveProbability(Double bloomFilterFalsePositiveProbability)` The Bloom filter false positive probability (FPP).
`OrcSerDe`	`withCompression(OrcCompression compression)` The compression code to use over data blocks.
`OrcSerDe`	`withCompression(String compression)` The compression code to use over data blocks.
`OrcSerDe`	`withDictionaryKeyThreshold(Double dictionaryKeyThreshold)` Represents the fraction of the total number of non-null rows.
`OrcSerDe`	`withEnablePadding(Boolean enablePadding)` Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries.
`OrcSerDe`	`withFormatVersion(OrcFormatVersion formatVersion)` The version of the file to write.
`OrcSerDe`	`withFormatVersion(String formatVersion)` The version of the file to write.
`OrcSerDe`	`withPaddingTolerance(Double paddingTolerance)` A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size.
`OrcSerDe`	`withRowIndexStride(Integer rowIndexStride)` The number of rows between index entries.
`OrcSerDe`	`withStripeSizeBytes(Integer stripeSizeBytes)` The number of bytes in each stripe.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OrcSerDe
```
public OrcSerDe()
```
- Method Detail
  - setStripeSizeBytes
```
public void setStripeSizeBytes(Integer stripeSizeBytes)
```
    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
    
    Parameters:
    
    stripeSizeBytes - The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
  - getStripeSizeBytes
```
public Integer getStripeSizeBytes()
```
    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
    
    Returns:
    
    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
  - withStripeSizeBytes
```
public OrcSerDe withStripeSizeBytes(Integer stripeSizeBytes)
```
    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
    
    Parameters:
    
    stripeSizeBytes - The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBlockSizeBytes
```
public void setBlockSizeBytes(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. Kinesis Data Firehose uses this value for padding calculations.
    
    Parameters:
    
    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. Kinesis Data Firehose uses this value for padding calculations.
  - getBlockSizeBytes
```
public Integer getBlockSizeBytes()
```
    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. Kinesis Data 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. Kinesis Data Firehose uses this value for padding calculations.
  - withBlockSizeBytes
```
public OrcSerDe withBlockSizeBytes(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. Kinesis Data Firehose uses this value for padding calculations.
    
    Parameters:
    
    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. Kinesis Data Firehose uses this value for padding calculations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRowIndexStride
```
public void setRowIndexStride(Integer rowIndexStride)
```
    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
    
    Parameters:
    
    rowIndexStride - The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
  - getRowIndexStride
```
public Integer getRowIndexStride()
```
    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
    
    Returns:
    
    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
  - withRowIndexStride
```
public OrcSerDe withRowIndexStride(Integer rowIndexStride)
```
    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
    
    Parameters:
    
    rowIndexStride - The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnablePadding
```
public void setEnablePadding(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. The default is false.
    
    Parameters:
    
    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. The default is false.
  - getEnablePadding
```
public Boolean getEnablePadding()
```
    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. The default is false.
    
    Returns:
    
    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. The default is false.
  - withEnablePadding
```
public OrcSerDe withEnablePadding(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. The default is false.
    
    Parameters:
    
    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. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnablePadding
```
public Boolean isEnablePadding()
```
    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. The default is false.
    
    Returns:
    
    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. The default is false.
  - setPaddingTolerance
```
public void setPaddingTolerance(Double 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 OrcSerDe$EnablePadding is false.
    
    Parameters:
    
    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 OrcSerDe$EnablePadding is false.
  - getPaddingTolerance
```
public Double getPaddingTolerance()
```
    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 OrcSerDe$EnablePadding is false.
    
    Returns:
    
    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 OrcSerDe$EnablePadding is false.
  - withPaddingTolerance
```
public OrcSerDe withPaddingTolerance(Double 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 OrcSerDe$EnablePadding is false.
    
    Parameters:
    
    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 OrcSerDe$EnablePadding is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompression
```
public void setCompression(String compression)
```
    The compression code to use over data blocks. The default is SNAPPY.
    
    Parameters:
    
    compression - The compression code to use over data blocks. The default is SNAPPY.
    
    See Also:
    
    OrcCompression
  - getCompression
```
public String getCompression()
```
    The compression code to use over data blocks. The default is SNAPPY.
    
    Returns:
    
    The compression code to use over data blocks. The default is SNAPPY.
    
    See Also:
    
    OrcCompression
  - withCompression
```
public OrcSerDe withCompression(String compression)
```
    The compression code to use over data blocks. The default is SNAPPY.
    
    Parameters:
    
    compression - The compression code to use over data blocks. The default is SNAPPY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrcCompression
  - withCompression
```
public OrcSerDe withCompression(OrcCompression compression)
```
    The compression code to use over data blocks. The default is SNAPPY.
    
    Parameters:
    
    compression - The compression code to use over data blocks. The default is SNAPPY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrcCompression
  - getBloomFilterColumns
```
public List<String> getBloomFilterColumns()
```
    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    Returns:
    
    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
  - setBloomFilterColumns
```
public void setBloomFilterColumns(Collection<String> bloomFilterColumns)
```
    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    Parameters:
    
    bloomFilterColumns - The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
  - withBloomFilterColumns
```
public OrcSerDe withBloomFilterColumns(String... bloomFilterColumns)
```
    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    NOTE: This method appends the values to the existing list (if any). Use setBloomFilterColumns(java.util.Collection) or withBloomFilterColumns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    bloomFilterColumns - The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBloomFilterColumns
```
public OrcSerDe withBloomFilterColumns(Collection<String> bloomFilterColumns)
```
    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    Parameters:
    
    bloomFilterColumns - The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBloomFilterFalsePositiveProbability
```
public void setBloomFilterFalsePositiveProbability(Double bloomFilterFalsePositiveProbability)
```
    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
    
    Parameters:
    
    bloomFilterFalsePositiveProbability - The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
  - getBloomFilterFalsePositiveProbability
```
public Double getBloomFilterFalsePositiveProbability()
```
    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
    
    Returns:
    
    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
  - withBloomFilterFalsePositiveProbability
```
public OrcSerDe withBloomFilterFalsePositiveProbability(Double bloomFilterFalsePositiveProbability)
```
    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
    
    Parameters:
    
    bloomFilterFalsePositiveProbability - The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDictionaryKeyThreshold
```
public void setDictionaryKeyThreshold(Double dictionaryKeyThreshold)
```
    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
    
    Parameters:
    
    dictionaryKeyThreshold - Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
  - getDictionaryKeyThreshold
```
public Double getDictionaryKeyThreshold()
```
    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
    
    Returns:
    
    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
  - withDictionaryKeyThreshold
```
public OrcSerDe withDictionaryKeyThreshold(Double dictionaryKeyThreshold)
```
    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
    
    Parameters:
    
    dictionaryKeyThreshold - Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFormatVersion
```
public void setFormatVersion(String formatVersion)
```
    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Parameters:
    
    formatVersion - The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    See Also:
    
    OrcFormatVersion
  - getFormatVersion
```
public String getFormatVersion()
```
    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Returns:
    
    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    See Also:
    
    OrcFormatVersion
  - withFormatVersion
```
public OrcSerDe withFormatVersion(String formatVersion)
```
    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Parameters:
    
    formatVersion - The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrcFormatVersion
  - withFormatVersion
```
public OrcSerDe withFormatVersion(OrcFormatVersion formatVersion)
```
    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Parameters:
    
    formatVersion - The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrcFormatVersion
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OrcSerDe clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class OrcSerDe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrcSerDe

Method Detail

setStripeSizeBytes

getStripeSizeBytes

withStripeSizeBytes

setBlockSizeBytes

getBlockSizeBytes

withBlockSizeBytes

setRowIndexStride

getRowIndexStride

withRowIndexStride

setEnablePadding

getEnablePadding

withEnablePadding

isEnablePadding

setPaddingTolerance

getPaddingTolerance

withPaddingTolerance

setCompression

getCompression

withCompression

withCompression

getBloomFilterColumns

setBloomFilterColumns

withBloomFilterColumns

withBloomFilterColumns

setBloomFilterFalsePositiveProbability

getBloomFilterFalsePositiveProbability

withBloomFilterFalsePositiveProbability

setDictionaryKeyThreshold

getDictionaryKeyThreshold

withDictionaryKeyThreshold

setFormatVersion

getFormatVersion

withFormatVersion

withFormatVersion

toString

equals

hashCode

clone

marshall