Class ColumnEncryptionPropertiesBuilder

Namespace

ParquetSharp

Assembly

ParquetSharp.dll

Builder pattern for creating and configuring ColumnEncryptionProperties objects. Provides a fluent API for setting the encryption properties for a column in a Parquet file.

public sealed class ColumnEncryptionPropertiesBuilder : IDisposable

Inheritance

object

ColumnEncryptionPropertiesBuilder

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ColumnEncryptionPropertiesBuilder(ColumnPath)

Initializes a new instance of the ColumnEncryptionPropertiesBuilder class for a column specified by path.

public ColumnEncryptionPropertiesBuilder(ColumnPath columnPath)

Parameters

columnPath ColumnPath

The ColumnPath object representing the column to encrypt.

ColumnEncryptionPropertiesBuilder(string)

Initializes a new instance of the ColumnEncryptionPropertiesBuilder class for a column specified by name.

public ColumnEncryptionPropertiesBuilder(string columnName)

Parameters

columnName string

The name of the column to encrypt.

Methods

Build()

Builds the ColumnEncryptionProperties object.

public ColumnEncryptionProperties Build()

Returns

ColumnEncryptionProperties

The configured ColumnEncryptionProperties object.

Dispose()

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

public void Dispose()

Key(byte[])

Set the encryption key for the column.

public ColumnEncryptionPropertiesBuilder Key(byte[] key)

Parameters

key byte[]

A byte array containing the AES encryption key.

Returns

ColumnEncryptionPropertiesBuilder

This builder instance.

KeyId(string)

Set the key ID associated with the column's encryption key.

public ColumnEncryptionPropertiesBuilder KeyId(string keyId)

Parameters

keyId string

An identifier for the encryption key.

Returns

ColumnEncryptionPropertiesBuilder

This builder instance.

KeyMetadata(string)

Set the metadata associated with the encryption key for the column.

public ColumnEncryptionPropertiesBuilder KeyMetadata(string keyMetadata)

Parameters

keyMetadata string

A string containing the metadata associated with the encryption key.

Returns

ColumnEncryptionPropertiesBuilder

This builder instance.