case class ClientEncryption(wrapped: com.mongodb.async.client.vault.ClientEncryption) extends Closeable with Product with Serializable
The Key vault.
Used to create data encryption keys, and to explicitly encrypt and decrypt values when auto-encryption is not an option.
- Annotations
- @Beta()
- Since
2.7
- Alphabetic
- By Inheritance
- ClientEncryption
- Serializable
- Product
- Equals
- Closeable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ClientEncryption(wrapped: com.mongodb.async.client.vault.ClientEncryption)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def close(): Unit
- Definition Classes
- ClientEncryption → Closeable → AutoCloseable
- def createDataKey(kmsProvider: String, dataKeyOptions: DataKeyOptions): SingleObservable[BsonBinary]
Create a data key with the given KMS provider and options.
Create a data key with the given KMS provider and options.
Creates a new key document and inserts into the key vault collection.
- kmsProvider
the KMS provider
- dataKeyOptions
the options for data key creation
- returns
a Publisher containing the identifier for the created data key
- def createDataKey(kmsProvider: String): SingleObservable[BsonBinary]
Create a data key with the given KMS provider.
Create a data key with the given KMS provider.
Creates a new key document and inserts into the key vault collection.
- kmsProvider
the KMS provider
- returns
a Publisher containing the identifier for the created data key
- def decrypt(value: BsonBinary): SingleObservable[BsonValue]
Decrypt the given value.
Decrypt the given value.
- value
the value to decrypt, which must be of subtype 6
- returns
a Publisher containing the decrypted value
- def encrypt(value: BsonValue, options: EncryptOptions): SingleObservable[BsonBinary]
Encrypt the given value with the given options.
Encrypt the given value with the given options. The driver may throw an exception for prohibited BSON value types
- value
the value to encrypt
- options
the options for data encryption
- returns
a Publisher containing the encrypted value, a BSON binary of subtype 6
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: