Click or drag to resize

EncryptOptions Class

Encryption options for explicit encryption.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.EncryptionEncryptOptions

Namespace:  MongoDB.Driver.Encryption
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax
Copy
public class EncryptOptions

The EncryptOptions type exposes the following members.

Constructors
  NameDescription
Public methodEncryptOptions(EncryptionAlgorithm, OptionalString, OptionalNullableGuid, OptionalNullableInt64, OptionalString, OptionalRangeOptions)
Initializes a new instance of the EncryptOptions class.
Public methodEncryptOptions(String, OptionalString, OptionalNullableGuid, OptionalNullableInt64, OptionalString, OptionalRangeOptions)
Initializes a new instance of the EncryptOptions class.
Top
Properties
  NameDescription
Public propertyAlgorithm
Gets the algorithm.
Public propertyAlternateKeyName
Gets the alternate key name.
Public propertyContentionFactor
[Beta] Gets the contention factor.
Public propertyKeyId
Gets the key identifier.
Public propertyQueryType
[Beta] Gets the query type.
Public propertyRangeOptions
Gets the range options.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWith
Returns a new EncryptOptions instance with some settings changed.
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also