Package com.mongodb.crypt.capi

Class MongoExplicitEncryptOptions.Builder

java.lang.Object

com.mongodb.crypt.capi.MongoExplicitEncryptOptions.Builder

Enclosing class:

MongoExplicitEncryptOptions

public static class MongoExplicitEncryptOptions.Builder
extends java.lang.Object

The builder for the options

Method Summary

Modifier and Type	Method	Description
MongoExplicitEncryptOptions.Builder	algorithm(java.lang.String algorithm)	Add the encryption algorithm.
MongoExplicitEncryptOptions	build()	Build the options.
MongoExplicitEncryptOptions.Builder	contentionFactor(java.lang.Long contentionFactor)	The contention factor.
MongoExplicitEncryptOptions.Builder	keyAltName(java.lang.String keyAltName)	Add the key alternative name.
MongoExplicitEncryptOptions.Builder	keyId(org.bson.BsonBinary keyId)	Add the key identifier.
MongoExplicitEncryptOptions.Builder	queryType(java.lang.String queryType)	The QueryType.
MongoExplicitEncryptOptions.Builder	rangeOptions(org.bson.BsonDocument rangeOptions)	The Range Options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

keyId

public MongoExplicitEncryptOptions.Builder keyId(org.bson.BsonBinary keyId)

Add the key identifier.

Parameters:

keyId - the key idenfifier

Returns:

this

keyAltName

public MongoExplicitEncryptOptions.Builder keyAltName(java.lang.String keyAltName)

Add the key alternative name.

Parameters:

keyAltName - the key alternative name

Returns:

this

algorithm

public MongoExplicitEncryptOptions.Builder algorithm(java.lang.String algorithm)

Add the encryption algorithm.

To insert or query with an "Indexed" encrypted payload, use a MongoClient configured with AutoEncryptionSettings. AutoEncryptionSettings.bypassQueryAnalysis may be true. AutoEncryptionSettings.bypassAutoEncryption must be false.

Parameters:

algorithm - the encryption algorithm

Returns:

this

contentionFactor

public MongoExplicitEncryptOptions.Builder contentionFactor(java.lang.Long contentionFactor)

The contention factor.

It is an error to set contentionFactor when algorithm is not "Indexed".

Parameters:

contentionFactor - the contention factor

Returns:

this

Since:

1.5

queryType

public MongoExplicitEncryptOptions.Builder queryType(java.lang.String queryType)

The QueryType.

It is an error to set queryType when algorithm is not "Indexed".

Parameters:

queryType - the query type

Returns:

this

Since:

1.5

rangeOptions

public MongoExplicitEncryptOptions.Builder rangeOptions(org.bson.BsonDocument rangeOptions)

The Range Options.

It is an error to set rangeOptions when the algorithm is not "rangePreview".

Parameters:

rangeOptions - the range options

Returns:

this

Since:

1.7

build

public MongoExplicitEncryptOptions build()

Build the options.

Returns:

the options