MongoDataKeyOptions (mongocrypt 1.5.2 API)

java.lang.Object
- com.mongodb.crypt.capi.MongoDataKeyOptions

public class MongoDataKeyOptions
extends java.lang.Object

The options for creation of a data key

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MongoDataKeyOptions.Builder
Options builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MongoDataKeyOptions.Builder`	`builder()`	Create a builder for the options.
`java.util.List<java.lang.String>`	`getKeyAltNames()`	Gets the alternate key names for the data key.
`byte[]`	`getKeyMaterial()`	Gets the custom key material if set.
`org.bson.BsonDocument`	`getMasterKey()`	Gets the master key for the data key.

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

- Method Detail
  - builder
```
public static MongoDataKeyOptions.Builder builder()
```
    Create a builder for the options.
    
    Returns:
    
    the builder
  - getKeyAltNames
```
public java.util.List<java.lang.String> getKeyAltNames()
```
    Gets the alternate key names for the data key.
    
    Returns:
    
    the alternate key names
  - getMasterKey
```
public org.bson.BsonDocument getMasterKey()
```
    Gets the master key for the data key.
    
    Returns:
    
    the master key
  - getKeyMaterial
```
public byte[] getKeyMaterial()
```
    Gets the custom key material if set.
    
    Returns:
    
    the custom key material for the data key or null
    
    Since:
    
    1.5