Module spring.data.mongodb

Package org.springframework.data.mongodb.core.encryption

Class EncryptionOptions.QueryableEncryptionOptions

java.lang.Object

org.springframework.data.mongodb.core.encryption.EncryptionOptions.QueryableEncryptionOptions

Enclosing class:

EncryptionOptions

public static class EncryptionOptions.QueryableEncryptionOptions
extends Object

Options, like the getQueryType(), to apply when encrypting queryable values.

Since:

4.5

Author:

Ross Lawley, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
EncryptionOptions.QueryableEncryptionOptions	attributes(Map<String,Object> attributes)	Define the rangeOptions to be used for queryable document encryption.
EncryptionOptions.QueryableEncryptionOptions	contentionFactor(Long contentionFactor)	Define the contentionFactor to be used for queryable document encryption.
boolean	equals(Object o)
Map<String,Object>	getAttributes()	Get the rangeOptions to apply.
Long	getContentionFactor()	Get the contentionFactor to apply.
String	getQueryType()	Get the queryType to apply.
int	hashCode()
static EncryptionOptions.QueryableEncryptionOptions	none()	Create an empty EncryptionOptions.QueryableEncryptionOptions.
EncryptionOptions.QueryableEncryptionOptions	queryType(String queryType)	Define the queryType to be used for queryable document encryption.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

none

public static EncryptionOptions.QueryableEncryptionOptions none()

Create an empty EncryptionOptions.QueryableEncryptionOptions.

Returns:

unmodifiable EncryptionOptions.QueryableEncryptionOptions instance.

queryType

public EncryptionOptions.QueryableEncryptionOptions queryType(@Nullable
 String queryType)

Define the queryType to be used for queryable document encryption.

Parameters:

queryType - can be null.

Returns:

new instance of EncryptionOptions.QueryableEncryptionOptions.

contentionFactor

public EncryptionOptions.QueryableEncryptionOptions contentionFactor(@Nullable
 Long contentionFactor)

Define the contentionFactor to be used for queryable document encryption.

Parameters:

contentionFactor - can be null.

Returns:

new instance of EncryptionOptions.QueryableEncryptionOptions.

attributes

public EncryptionOptions.QueryableEncryptionOptions attributes(Map<String,Object> attributes)

Define the rangeOptions to be used for queryable document encryption.

Parameters:

attributes - can be null.

Returns:

new instance of EncryptionOptions.QueryableEncryptionOptions.

getQueryType

@Nullable
public String getQueryType()

Get the queryType to apply.

Returns:

null if not set.

getContentionFactor

@Nullable
public Long getContentionFactor()

Get the contentionFactor to apply.

Returns:

null if not set.

getAttributes

public Map<String,Object> getAttributes()

Get the rangeOptions to apply.

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object