#include <mongocxx/v_noabi/mongocxx/options/encrypt.hpp>
|
enum class | encryption_algorithm : std::uint8_t |
| Determines which AEAD_AES_256_CBC algorithm to use with HMAC_SHA_512 when encrypting data. More...
|
|
enum class | encryption_query_type : std::uint8_t |
| queryType only applies when algorithm is "indexed" or "range". It is an error to set queryType when algorithm is not "indexed" or "range". More...
|
|
◆ encryption_algorithm
Determines which AEAD_AES_256_CBC algorithm to use with HMAC_SHA_512 when encrypting data.
Enumerator |
---|
k_deterministic | Use deterministic encryption.
|
k_random | Use randomized encryption.
|
k_indexed | Use indexed encryption.
|
k_unindexed | Use unindexed encryption.
|
k_range | Use range encryption.
|
◆ encryption_query_type
queryType only applies when algorithm is "indexed" or "range". It is an error to set queryType when algorithm is not "indexed" or "range".
Enumerator |
---|
k_equality | Use query type "equality".
|
k_range | Use query type "range".
|
◆ algorithm() [1/2]
Gets the current algorithm.
Indexed and Unindexed are used for Queryable Encryption.
- Returns
- An optional algorithm.
◆ algorithm() [2/2]
◆ contention_factor() [1/2]
Gets the current contention factor.
- Returns
- An optional contention factor.
◆ contention_factor() [2/2]
encrypt & mongocxx::v_noabi::options::encrypt::contention_factor |
( |
int64_t | contention_factor | ) |
|
Sets the contention factor to use for encryption. contentionFactor only applies when algorithm is "Indexed" or "Range". It is an error to set contentionFactor when algorithm is not "Indexed".
- Parameters
-
contention_factor | An integer specifiying the desired contention factor. |
◆ key_alt_name() [1/2]
Gets the current key alt name.
- Returns
- An optional key name.
◆ key_alt_name() [2/2]
encrypt & mongocxx::v_noabi::options::encrypt::key_alt_name |
( |
std::string | name | ) |
|
Sets a name by which to lookup a key from the key vault collection to use for this encryption operation. A key alt name can be used instead of a key id.
- Parameters
-
name | The name of the key to use for encryption. |
- Returns
- A reference to this obejct to facilitate method chaining.
- See also
-
◆ key_id() [1/2]
Gets the key_id.
- Returns
- An optional owning bson_value containing the key_id.
◆ key_id() [2/2]
Sets the key to use for this encryption operation. A key id can be used instead of a key alt name.
If a non-owning bson_value::view is passed in as the key_id, the object that owns key_id's memory must outlive this object.
- Parameters
-
key_id | The id of the key to use for encryption, as a bson_value containing a UUID (BSON binary subtype 4). |
- Returns
- A reference to this object to facilitate method chaining.
- See also
-
◆ query_type() [1/2]
Gets the current query type.
- Returns
- A query type.
◆ query_type() [2/2]
Sets the query type to use for encryption.
- Parameters
-
query_type | One of the following: - equality query_type only applies when algorithm is "Indexed" or "Range". It is an error to set query_type when algorithm is not "Indexed" or "Range". |
◆ range_opts() [1/2]
Gets the current range options.
- Returns
- An optional range options.
◆ range_opts() [2/2]
Sets the range options to use for encryption.
The documentation for this class was generated from the following file: