org.apache.parquet.crypto

Class ColumnEncryptionProperties.Builder

java.lang.Object

org.apache.parquet.crypto.ColumnEncryptionProperties.Builder

Enclosing class:

ColumnEncryptionProperties

public static class ColumnEncryptionProperties.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
ColumnEncryptionProperties	build()
ColumnEncryptionProperties.Builder	withKey(byte[] columnKey) Set a column-specific key.
ColumnEncryptionProperties.Builder	withKeyID(String keyId) Set a key retrieval metadata (converted from String).
ColumnEncryptionProperties.Builder	withKeyMetaData(byte[] keyMetaData) Set a key retrieval metadata.

Methods inherited from class java.lang.Object

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

Method Detail

withKey

public ColumnEncryptionProperties.Builder withKey(byte[] columnKey)

Set a column-specific key. If key is not set on an encrypted column, the column will be encrypted with the footer key.

Parameters:

columnKey - Key length must be either 16, 24 or 32 bytes.

Returns:

Builder

withKeyMetaData

public ColumnEncryptionProperties.Builder withKeyMetaData(byte[] keyMetaData)

Set a key retrieval metadata. use either withKeyMetaData or withKeyID, not both.

Parameters:

keyMetaData - arbitrary byte array with encryption key metadata

Returns:

Builder

withKeyID

public ColumnEncryptionProperties.Builder withKeyID(String keyId)

Set a key retrieval metadata (converted from String). use either withKeyMetaData or withKeyID, not both.

Parameters:

keyId - will be converted to metadata (UTF-8 array).

Returns:

Builder

build

public ColumnEncryptionProperties build()