Class FileDecryptionPropertiesBuilder

Namespace

ParquetSharp

Assembly

ParquetSharp.dll

Builder pattern for creating and configuring a FileDecryptionProperties object. Provides a fluent API for setting the decryption properties (footer key, encryption algorithm, etc.) for a Parquet file.

public sealed class FileDecryptionPropertiesBuilder : IDisposable

Inheritance

object

FileDecryptionPropertiesBuilder

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FileDecryptionPropertiesBuilder()

Create a new FileDecryptionPropertiesBuilder.

public FileDecryptionPropertiesBuilder()

Methods

AadPrefix(string)

Set the additional authenticated data (AAD) prefix.

public FileDecryptionPropertiesBuilder AadPrefix(string aadPrefix)

Parameters

aadPrefix string

A string representing the AAD prefix.

Returns

FileDecryptionPropertiesBuilder

This builder instance.

AadPrefixVerifier(AadPrefixVerifier)

Set the prefix verifier used to verify the additional authenticated data (AAD) prefix.

public FileDecryptionPropertiesBuilder AadPrefixVerifier(AadPrefixVerifier aadPrefixVerifier)

Parameters

aadPrefixVerifier AadPrefixVerifier

An AadPrefixVerifier object that provides a callback to verify the AAD prefix.

Returns

FileDecryptionPropertiesBuilder

This builder instance.

Build()

Build the FileDecryptionProperties object.

public FileDecryptionProperties Build()

Returns

FileDecryptionProperties

The configured FileDecryptionProperties object.

ColumnKeys(ColumnDecryptionProperties[])

Set the keys used to decrypt the columns.

public FileDecryptionPropertiesBuilder ColumnKeys(ColumnDecryptionProperties[] columnDecryptionProperties)

Parameters

columnDecryptionProperties ColumnDecryptionProperties[]

An array of ColumnDecryptionProperties objects.

Returns

FileDecryptionPropertiesBuilder

This builder instance.

DisableFooterSignatureVerification()

Disable footer signature verification.

public FileDecryptionPropertiesBuilder DisableFooterSignatureVerification()

Returns

FileDecryptionPropertiesBuilder

This builder instance.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

FooterKey(byte[])

Set the footer key used to decrypt the file.

public FileDecryptionPropertiesBuilder FooterKey(byte[] footerKey)

Parameters

footerKey byte[]

An array of bytes used to decrypt the footer.

Returns

FileDecryptionPropertiesBuilder

This builder instance.

KeyRetriever(DecryptionKeyRetriever)

Set the key retriever used to retrieve the decryption keys.

public FileDecryptionPropertiesBuilder KeyRetriever(DecryptionKeyRetriever keyRetriever)

Parameters

keyRetriever DecryptionKeyRetriever

A DecryptionKeyRetriever object that provides a callback to retrieve the decryption keys.

Returns

FileDecryptionPropertiesBuilder

This builder instance.

PlaintextFilesAllowed()

Allow plaintext (unencrypted) files.

public FileDecryptionPropertiesBuilder PlaintextFilesAllowed()

Returns

FileDecryptionPropertiesBuilder

This builder instance.