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.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

public class EncryptOptions

Public Class EncryptOptions

type EncryptOptions =  class end

The EncryptOptions type exposes the following members.

Constructors

	Name	Description
	EncryptOptions(String, OptionalString, OptionalNullableGuid, OptionalNullableInt64, OptionalString, OptionalRangeOptions)	Initializes a new instance of the EncryptOptions class.
	EncryptOptions(EncryptionAlgorithm, OptionalString, OptionalNullableGuid, OptionalNullableInt64, OptionalString, OptionalRangeOptions)	Initializes a new instance of the EncryptOptions class.

Top

Properties

	Name	Description
	Algorithm	Gets the algorithm.
	AlternateKeyName	Gets the alternate key name.
	ContentionFactor	Gets the contention factor.
	KeyId	Gets the key identifier.
	QueryType	Gets the query type.
	RangeOptions	Gets the range options.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	With	Returns a new EncryptOptions instance with some settings changed.

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Encryption Namespace