Skip to content

Commit

Permalink
Moving docstring in parquet_encryption_config.h to correct position.
Browse files Browse the repository at this point in the history
  • Loading branch information
tolleybot committed Oct 6, 2023
1 parent 6a69ae1 commit c3fe65a
Showing 1 changed file with 34 additions and 34 deletions.
68 changes: 34 additions & 34 deletions cpp/src/arrow/dataset/parquet_encryption_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,50 +29,50 @@ struct DecryptionConfiguration;
namespace arrow {
namespace dataset {

/// \brief Core configuration class encapsulating parameters for high-level encryption
/// within Parquet framework.
///
/// ParquetEncryptionConfig serves as a bridge, passing encryption-related
/// parameters to appropriate components within the Parquet library. It holds references
/// to objects defining encryption strategy, Key Management Service (KMS) configuration,
/// and specific encryption configurations for Parquet data.
///
/// \property crypto_factory
/// Shared pointer to CryptoFactory object, responsible for reating cryptographic
/// components like encryptors and decryptors.
/// \property kms_connection_config
/// Shared pointer to KmsConnectionConfig object, holding configuration parameters for
/// connecting to a Key Management Service (KMS).
/// \property encryption_config
/// Shared pointer to EncryptionConfiguration object, defining specific encryption
/// settings for Parquet data, like keys for different columns.
struct ARROW_DS_EXPORT ParquetEncryptionConfig {
std::shared_ptr<parquet::encryption::CryptoFactory> crypto_factory;
std::shared_ptr<parquet::encryption::KmsConnectionConfig> kms_connection_config;
std::shared_ptr<parquet::encryption::EncryptionConfiguration> encryption_config;
/// \brief Core configuration class encapsulating parameters for high-level encryption
/// within Parquet framework.
///
/// ParquetEncryptionConfig serves as a bridge, passing encryption-related
/// parameters to appropriate components within the Parquet library. It holds references
/// to objects defining encryption strategy, Key Management Service (KMS) configuration,
/// and specific encryption configurations for Parquet data.
///
/// \property crypto_factory
/// Shared pointer to CryptoFactory object, responsible for reating cryptographic
/// components like encryptors and decryptors.
/// \property kms_connection_config
/// Shared pointer to KmsConnectionConfig object, holding configuration parameters for
/// connecting to a Key Management Service (KMS).
/// \property encryption_config
/// Shared pointer to EncryptionConfiguration object, defining specific encryption
/// settings for Parquet data, like keys for different columns.
};

/// \brief Core configuration class encapsulating parameters for high-level decryption
/// within Parquet framework.
///
/// ParquetDecryptionConfig is designed to pass decryption-related parameters to
/// appropriate decryption components within Parquet library. It holds references to
/// objects defining decryption strategy, Key Management Service (KMS) configuration,
/// and specific decryption configurations for reading encrypted Parquet data.
///
/// \property crypto_factory
/// Shared pointer to CryptoFactory object, pivotal in creating cryptographic
/// components for decryption process.
/// \property kms_connection_config
/// Shared pointer to KmsConnectionConfig object, containing parameters for connecting
/// to a Key Management Service (KMS) during decryption.
/// \property decryption_config
/// Shared pointer to DecryptionConfiguration object, specifying decryption settings
/// for reading encrypted Parquet data.
struct ARROW_DS_EXPORT ParquetDecryptionConfig {
std::shared_ptr<parquet::encryption::CryptoFactory> crypto_factory;
std::shared_ptr<parquet::encryption::KmsConnectionConfig> kms_connection_config;
std::shared_ptr<parquet::encryption::DecryptionConfiguration> decryption_config;
/// \brief Core configuration class encapsulating parameters for high-level decryption
/// within Parquet framework.
///
/// ParquetDecryptionConfig is designed to pass decryption-related parameters to
/// appropriate decryption components within Parquet library. It holds references to
/// objects defining decryption strategy, Key Management Service (KMS) configuration,
/// and specific decryption configurations for reading encrypted Parquet data.
///
/// \property crypto_factory
/// Shared pointer to CryptoFactory object, pivotal in creating cryptographic
/// components for decryption process.
/// \property kms_connection_config
/// Shared pointer to KmsConnectionConfig object, containing parameters for connecting
/// to a Key Management Service (KMS) during decryption.
/// \property decryption_config
/// Shared pointer to DecryptionConfiguration object, specifying decryption settings
/// for reading encrypted Parquet data.
};

} // namespace dataset
Expand Down

0 comments on commit c3fe65a

Please sign in to comment.