@@ -65,35 +65,36 @@ ClientEncryption.encrypt()
65
65
66
66
- string or document
67
67
68
- - When specifying ``encryptionAlgorithm``:
69
-
70
- The encryption algorithm to use for encrypting the ``value``.
71
-
72
- - ``AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic``
73
-
74
- - ``AEAD_AES_256_CBC_HMAC_SHA_512-Random``
75
-
76
- - ``Indexed``
77
-
78
- - ``Unindexed``
79
-
80
- For complete documentation on the supported encryption
81
- algorithms, see :ref:`field-level-encryption-algorithms`.
82
-
83
- - When specifying ``encryptionOptions``:
84
-
85
- - ``algorithm``: The encryption algorithm to use for
86
- encrypting the ``value``.
87
-
88
- - ``keyId``: ID of the data decryption key.
89
-
90
- - ``contentionFactor``: Required when ``algorithm`` is set
91
- to ``Indexed``. Related to the frequency of the values for
92
- this field.
93
-
94
- - ``queryType``: The only query type currently supported is
95
- ``"equality"``. ``queryType`` must be set when algorithm is
96
- not ``Indexed``.
68
+ -
69
+ - When specifying ``encryptionAlgorithm``:
70
+
71
+ The encryption algorithm to use for encrypting the ``value``.
72
+
73
+ - ``AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic``
74
+
75
+ - ``AEAD_AES_256_CBC_HMAC_SHA_512-Random``
76
+
77
+ - ``Indexed``
78
+
79
+ - ``Unindexed``
80
+
81
+ For complete documentation on the supported encryption
82
+ algorithms, see :ref:`field-level-encryption-algorithms`.
83
+
84
+ - When specifying ``encryptionOptions``:
85
+
86
+ - ``algorithm``: The encryption algorithm to use for
87
+ encrypting the ``value``.
88
+
89
+ - ``keyId``: ID of the data decryption key.
90
+
91
+ - ``contentionFactor``: Required when ``algorithm`` is set
92
+ to ``Indexed``. Related to the frequency of the values for
93
+ this field.
94
+
95
+ - ``queryType``: The only query type currently supported is
96
+ ``"equality"``. ``queryType`` must be set when algorithm is
97
+ not ``Indexed``.
97
98
98
99
:returns:
99
100
0 commit comments