ColumnChunk (Apache Parquet Format Structures 1.16.0 API)

java.lang.Object
- org.apache.parquet.format.ColumnChunk

All Implemented Interfaces:: Serializable, Cloneable, Comparable<ColumnChunk>, org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>, org.apache.thrift.TSerializable

@Generated(value="Autogenerated by Thrift Compiler (0.22.0)",
           date="2025-08-30")
public class ColumnChunk
extends Object
implements org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>, Serializable, Cloneable, Comparable<ColumnChunk>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ColumnChunk._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`column_index_length` Size of ColumnChunk's ColumnIndex, in bytes *
`long`	`column_index_offset` File offset of ColumnChunk's ColumnIndex *
`ColumnCryptoMetaData`	`crypto_metadata` Crypto metadata of encrypted columns *
`ByteBuffer`	`encrypted_column_metadata` Encrypted column metadata for this chunk *
`long`	`file_offset` Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk.
`String`	`file_path` File where column data is stored.
`ColumnMetaData`	`meta_data` Column metadata for this chunk.
`static Map<ColumnChunk._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`int`	`offset_index_length` Size of ColumnChunk's OffsetIndex, in bytes *
`long`	`offset_index_offset` File offset of ColumnChunk's OffsetIndex *

Constructor Summary

Constructors
Constructor and Description

ColumnChunk()

ColumnChunk(ColumnChunk other)
Performs a deep copy on other.

ColumnChunk(long file_offset)

Constructors
Constructor and Description
`ColumnChunk()`
`ColumnChunk(ColumnChunk other)` Performs a deep copy on other.
`ColumnChunk(long file_offset)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`bufferForEncrypted_column_metadata()`
`void`	`clear()`
`int`	`compareTo(ColumnChunk other)`
`ColumnChunk`	`deepCopy()`
`boolean`	`equals(ColumnChunk that)`
`boolean`	`equals(Object that)`
`ColumnChunk._Fields`	`fieldForId(int fieldId)`
`int`	`getColumn_index_length()` Size of ColumnChunk's ColumnIndex, in bytes *
`long`	`getColumn_index_offset()` File offset of ColumnChunk's ColumnIndex *
`ColumnCryptoMetaData`	`getCrypto_metadata()` Crypto metadata of encrypted columns *
`byte[]`	`getEncrypted_column_metadata()` Encrypted column metadata for this chunk *
`Object`	`getFieldValue(ColumnChunk._Fields field)`
`long`	`getFile_offset()` Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk.
`String`	`getFile_path()` File where column data is stored.
`ColumnMetaData`	`getMeta_data()` Column metadata for this chunk.
`int`	`getOffset_index_length()` Size of ColumnChunk's OffsetIndex, in bytes *
`long`	`getOffset_index_offset()` File offset of ColumnChunk's OffsetIndex *
`int`	`hashCode()`
`boolean`	`isSet(ColumnChunk._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetColumn_index_length()` Returns true if field column_index_length is set (has been assigned a value) and false otherwise
`boolean`	`isSetColumn_index_offset()` Returns true if field column_index_offset is set (has been assigned a value) and false otherwise
`boolean`	`isSetCrypto_metadata()` Returns true if field crypto_metadata is set (has been assigned a value) and false otherwise
`boolean`	`isSetEncrypted_column_metadata()` Returns true if field encrypted_column_metadata is set (has been assigned a value) and false otherwise
`boolean`	`isSetFile_offset()` Returns true if field file_offset is set (has been assigned a value) and false otherwise
`boolean`	`isSetFile_path()` Returns true if field file_path is set (has been assigned a value) and false otherwise
`boolean`	`isSetMeta_data()` Returns true if field meta_data is set (has been assigned a value) and false otherwise
`boolean`	`isSetOffset_index_length()` Returns true if field offset_index_length is set (has been assigned a value) and false otherwise
`boolean`	`isSetOffset_index_offset()` Returns true if field offset_index_offset is set (has been assigned a value) and false otherwise
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`ColumnChunk`	`setColumn_index_length(int column_index_length)` Size of ColumnChunk's ColumnIndex, in bytes *
`void`	`setColumn_index_lengthIsSet(boolean value)`
`ColumnChunk`	`setColumn_index_offset(long column_index_offset)` File offset of ColumnChunk's ColumnIndex *
`void`	`setColumn_index_offsetIsSet(boolean value)`
`ColumnChunk`	`setCrypto_metadata(ColumnCryptoMetaData crypto_metadata)` Crypto metadata of encrypted columns *
`void`	`setCrypto_metadataIsSet(boolean value)`
`ColumnChunk`	`setEncrypted_column_metadata(byte[] encrypted_column_metadata)` Encrypted column metadata for this chunk *
`ColumnChunk`	`setEncrypted_column_metadata(ByteBuffer encrypted_column_metadata)`
`void`	`setEncrypted_column_metadataIsSet(boolean value)`
`void`	`setFieldValue(ColumnChunk._Fields field, Object value)`
`ColumnChunk`	`setFile_offset(long file_offset)` Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk.
`void`	`setFile_offsetIsSet(boolean value)`
`ColumnChunk`	`setFile_path(String file_path)` File where column data is stored.
`void`	`setFile_pathIsSet(boolean value)`
`ColumnChunk`	`setMeta_data(ColumnMetaData meta_data)` Column metadata for this chunk.
`void`	`setMeta_dataIsSet(boolean value)`
`ColumnChunk`	`setOffset_index_length(int offset_index_length)` Size of ColumnChunk's OffsetIndex, in bytes *
`void`	`setOffset_index_lengthIsSet(boolean value)`
`ColumnChunk`	`setOffset_index_offset(long offset_index_offset)` File offset of ColumnChunk's OffsetIndex *
`void`	`setOffset_index_offsetIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetColumn_index_length()`
`void`	`unsetColumn_index_offset()`
`void`	`unsetCrypto_metadata()`
`void`	`unsetEncrypted_column_metadata()`
`void`	`unsetFile_offset()`
`void`	`unsetFile_path()`
`void`	`unsetMeta_data()`
`void`	`unsetOffset_index_length()`
`void`	`unsetOffset_index_offset()`
`void`	`validate()`
`void`	`write(org.apache.thrift.protocol.TProtocol oprot)`

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

- Field Detail
  - file_path
```
public String file_path
```
    File where column data is stored. If not set, assumed to be same file as metadata. This path is relative to the current file.
  - file_offset
```
public long file_offset
```
    Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk. In many cases, the ColumnMetaData at this location is wrong. This field is now deprecated and should not be used. Writers should set this field to 0 if no ColumnMetaData has been written outside the footer.
  - meta_data
```
public ColumnMetaData meta_data
```
    Column metadata for this chunk. Some writers may also replicate this at the location pointed to by file_path/file_offset. Note: while marked as optional, this field is in fact required by most major Parquet implementations. As such, writers MUST populate this field.
  - offset_index_offset
```
public long offset_index_offset
```
    File offset of ColumnChunk's OffsetIndex *
  - offset_index_length
```
public int offset_index_length
```
    Size of ColumnChunk's OffsetIndex, in bytes *
  - column_index_offset
```
public long column_index_offset
```
    File offset of ColumnChunk's ColumnIndex *
  - column_index_length
```
public int column_index_length
```
    Size of ColumnChunk's ColumnIndex, in bytes *
  - crypto_metadata
```
public ColumnCryptoMetaData crypto_metadata
```
    Crypto metadata of encrypted columns *
  - encrypted_column_metadata
```
public ByteBuffer encrypted_column_metadata
```
    Encrypted column metadata for this chunk *
  - metaDataMap
```
public static final Map<ColumnChunk._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - ColumnChunk
```
public ColumnChunk()
```
  - ColumnChunk
```
public ColumnChunk(long file_offset)
```
  - ColumnChunk
```
public ColumnChunk(ColumnChunk other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public ColumnChunk deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - getFile_path
```
public String getFile_path()
```
    File where column data is stored. If not set, assumed to be same file as metadata. This path is relative to the current file.
  - setFile_path
```
public ColumnChunk setFile_path(String file_path)
```
    File where column data is stored. If not set, assumed to be same file as metadata. This path is relative to the current file.
  - unsetFile_path
```
public void unsetFile_path()
```
  - isSetFile_path
```
public boolean isSetFile_path()
```
    Returns true if field file_path is set (has been assigned a value) and false otherwise
  - setFile_pathIsSet
```
public void setFile_pathIsSet(boolean value)
```
  - getFile_offset
```
public long getFile_offset()
```
    Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk. In many cases, the ColumnMetaData at this location is wrong. This field is now deprecated and should not be used. Writers should set this field to 0 if no ColumnMetaData has been written outside the footer.
  - setFile_offset
```
public ColumnChunk setFile_offset(long file_offset)
```
    Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk. In many cases, the ColumnMetaData at this location is wrong. This field is now deprecated and should not be used. Writers should set this field to 0 if no ColumnMetaData has been written outside the footer.
  - unsetFile_offset
```
public void unsetFile_offset()
```
  - isSetFile_offset
```
public boolean isSetFile_offset()
```
    Returns true if field file_offset is set (has been assigned a value) and false otherwise
  - setFile_offsetIsSet
```
public void setFile_offsetIsSet(boolean value)
```
  - getMeta_data
```
public ColumnMetaData getMeta_data()
```
    Column metadata for this chunk. Some writers may also replicate this at the location pointed to by file_path/file_offset. Note: while marked as optional, this field is in fact required by most major Parquet implementations. As such, writers MUST populate this field.
  - setMeta_data
```
public ColumnChunk setMeta_data(ColumnMetaData meta_data)
```
    Column metadata for this chunk. Some writers may also replicate this at the location pointed to by file_path/file_offset. Note: while marked as optional, this field is in fact required by most major Parquet implementations. As such, writers MUST populate this field.
  - unsetMeta_data
```
public void unsetMeta_data()
```
  - isSetMeta_data
```
public boolean isSetMeta_data()
```
    Returns true if field meta_data is set (has been assigned a value) and false otherwise
  - setMeta_dataIsSet
```
public void setMeta_dataIsSet(boolean value)
```
  - getOffset_index_offset
```
public long getOffset_index_offset()
```
    File offset of ColumnChunk's OffsetIndex *
  - setOffset_index_offset
```
public ColumnChunk setOffset_index_offset(long offset_index_offset)
```
    File offset of ColumnChunk's OffsetIndex *
  - unsetOffset_index_offset
```
public void unsetOffset_index_offset()
```
  - isSetOffset_index_offset
```
public boolean isSetOffset_index_offset()
```
    Returns true if field offset_index_offset is set (has been assigned a value) and false otherwise
  - setOffset_index_offsetIsSet
```
public void setOffset_index_offsetIsSet(boolean value)
```
  - getOffset_index_length
```
public int getOffset_index_length()
```
    Size of ColumnChunk's OffsetIndex, in bytes *
  - setOffset_index_length
```
public ColumnChunk setOffset_index_length(int offset_index_length)
```
    Size of ColumnChunk's OffsetIndex, in bytes *
  - unsetOffset_index_length
```
public void unsetOffset_index_length()
```
  - isSetOffset_index_length
```
public boolean isSetOffset_index_length()
```
    Returns true if field offset_index_length is set (has been assigned a value) and false otherwise
  - setOffset_index_lengthIsSet
```
public void setOffset_index_lengthIsSet(boolean value)
```
  - getColumn_index_offset
```
public long getColumn_index_offset()
```
    File offset of ColumnChunk's ColumnIndex *
  - setColumn_index_offset
```
public ColumnChunk setColumn_index_offset(long column_index_offset)
```
    File offset of ColumnChunk's ColumnIndex *
  - unsetColumn_index_offset
```
public void unsetColumn_index_offset()
```
  - isSetColumn_index_offset
```
public boolean isSetColumn_index_offset()
```
    Returns true if field column_index_offset is set (has been assigned a value) and false otherwise
  - setColumn_index_offsetIsSet
```
public void setColumn_index_offsetIsSet(boolean value)
```
  - getColumn_index_length
```
public int getColumn_index_length()
```
    Size of ColumnChunk's ColumnIndex, in bytes *
  - setColumn_index_length
```
public ColumnChunk setColumn_index_length(int column_index_length)
```
    Size of ColumnChunk's ColumnIndex, in bytes *
  - unsetColumn_index_length
```
public void unsetColumn_index_length()
```
  - isSetColumn_index_length
```
public boolean isSetColumn_index_length()
```
    Returns true if field column_index_length is set (has been assigned a value) and false otherwise
  - setColumn_index_lengthIsSet
```
public void setColumn_index_lengthIsSet(boolean value)
```
  - getCrypto_metadata
```
public ColumnCryptoMetaData getCrypto_metadata()
```
    Crypto metadata of encrypted columns *
  - setCrypto_metadata
```
public ColumnChunk setCrypto_metadata(ColumnCryptoMetaData crypto_metadata)
```
    Crypto metadata of encrypted columns *
  - unsetCrypto_metadata
```
public void unsetCrypto_metadata()
```
  - isSetCrypto_metadata
```
public boolean isSetCrypto_metadata()
```
    Returns true if field crypto_metadata is set (has been assigned a value) and false otherwise
  - setCrypto_metadataIsSet
```
public void setCrypto_metadataIsSet(boolean value)
```
  - getEncrypted_column_metadata
```
public byte[] getEncrypted_column_metadata()
```
    Encrypted column metadata for this chunk *
  - bufferForEncrypted_column_metadata
```
public ByteBuffer bufferForEncrypted_column_metadata()
```
  - setEncrypted_column_metadata
```
public ColumnChunk setEncrypted_column_metadata(byte[] encrypted_column_metadata)
```
    Encrypted column metadata for this chunk *
  - setEncrypted_column_metadata
```
public ColumnChunk setEncrypted_column_metadata(ByteBuffer encrypted_column_metadata)
```
  - unsetEncrypted_column_metadata
```
public void unsetEncrypted_column_metadata()
```
  - isSetEncrypted_column_metadata
```
public boolean isSetEncrypted_column_metadata()
```
    Returns true if field encrypted_column_metadata is set (has been assigned a value) and false otherwise
  - setEncrypted_column_metadataIsSet
```
public void setEncrypted_column_metadataIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(ColumnChunk._Fields field,
                          Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - getFieldValue
```
public Object getFieldValue(ColumnChunk._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - isSet
```
public boolean isSet(ColumnChunk._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(ColumnChunk that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(ColumnChunk other)
```
    Specified by:
    
    compareTo in interface Comparable<ColumnChunk>
  - fieldForId
```
public ColumnChunk._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<ColumnChunk,ColumnChunk._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.apache.thrift.TSerializable
    
    Throws:
    
    org.apache.thrift.TException
  - write
```
public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
```
    Specified by:
    
    write in interface org.apache.thrift.TSerializable
    
    Throws:
    
    org.apache.thrift.TException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
              throws org.apache.thrift.TException
```
    Throws:
    
    org.apache.thrift.TException

Class ColumnChunk

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

file_path

file_offset

meta_data

offset_index_offset

offset_index_length

column_index_offset

column_index_length

crypto_metadata

encrypted_column_metadata

metaDataMap

Constructor Detail

ColumnChunk

ColumnChunk

ColumnChunk

Method Detail

deepCopy

clear

getFile_path

setFile_path

unsetFile_path

isSetFile_path

setFile_pathIsSet

getFile_offset

setFile_offset

unsetFile_offset

isSetFile_offset

setFile_offsetIsSet

getMeta_data

setMeta_data

unsetMeta_data

isSetMeta_data

setMeta_dataIsSet

getOffset_index_offset

setOffset_index_offset

unsetOffset_index_offset

isSetOffset_index_offset

setOffset_index_offsetIsSet

getOffset_index_length

setOffset_index_length

unsetOffset_index_length

isSetOffset_index_length

setOffset_index_lengthIsSet

getColumn_index_offset

setColumn_index_offset

unsetColumn_index_offset

isSetColumn_index_offset

setColumn_index_offsetIsSet

getColumn_index_length

setColumn_index_length

unsetColumn_index_length

isSetColumn_index_length

setColumn_index_lengthIsSet

getCrypto_metadata

setCrypto_metadata

unsetCrypto_metadata

isSetCrypto_metadata

setCrypto_metadataIsSet

getEncrypted_column_metadata

bufferForEncrypted_column_metadata

setEncrypted_column_metadata

setEncrypted_column_metadata

unsetEncrypted_column_metadata

isSetEncrypted_column_metadata

setEncrypted_column_metadataIsSet

setFieldValue

getFieldValue

isSet

equals

equals

hashCode

compareTo

fieldForId

read