EncryptOptions

java.lang.Object
- io.vertx.mongo.client.model.vault.EncryptOptions

public class EncryptOptions
extends java.lang.Object

The options for explicit encryption.

Since:: 3.11

Constructor Summary

Constructors
Constructor Description

EncryptOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAlgorithm()`	Gets the encryption algorithm, which must be either "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" or "AEAD_AES_256_CBC_HMAC_SHA_512-Random".
`java.lang.String`	`getKeyAltName()`	Gets the alternate name with which to look up the key.
`byte[]`	`getKeyId()`	Gets the key identifier.
`EncryptOptions`	`setKeyAltName(java.lang.String keyAltName)`	Sets the alternate key name
`EncryptOptions`	`setKeyId(byte[] keyId)`	Sets the key identifier

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EncryptOptions
```
public EncryptOptions()
```
- Method Detail
  - getAlgorithm
```
public java.lang.String getAlgorithm()
```
    Gets the encryption algorithm, which must be either "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" or "AEAD_AES_256_CBC_HMAC_SHA_512-Random".
    
    Returns:
    
    the encryption algorithm
  - setKeyId
```
public EncryptOptions setKeyId(byte[] keyId)
```
    Sets the key identifier
    
    Parameters:
    
    keyId - the key identifier
    
    Returns:
    
    this
    
    See Also:
    
    getKeyId()
  - getKeyId
```
public byte[] getKeyId()
```
    Gets the key identifier.
    Identifies the data key by its _id value. The value is a UUID (binary subtype 4).
    
    Returns:
    
    the key identifier
  - setKeyAltName
```
public EncryptOptions setKeyAltName(java.lang.String keyAltName)
```
    Sets the alternate key name
    
    Parameters:
    
    keyAltName - the alternate key name
    
    Returns:
    
    this
    
    See Also:
    
    getKeyAltName()
  - getKeyAltName
```
public java.lang.String getKeyAltName()
```
    Gets the alternate name with which to look up the key.
    Identifies the alternate key name to look up the key by.
    
    Returns:
    
    the alternate name