Package co.elastic.clients.elasticsearch.encryption

Class ElasticsearchEncryptionClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchEncryptionClient>

co.elastic.clients.elasticsearch.encryption.ElasticsearchEncryptionClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchEncryptionClient
extends ApiClient<ElasticsearchTransport,ElasticsearchEncryptionClient>

Client for the encryption namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchEncryptionClient(ElasticsearchTransport transport)
ElasticsearchEncryptionClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
ResetResponse	reset(ResetRequest request)	Reset the project encryption key.
final ResetResponse	reset(Function<ResetRequest.Builder,ObjectBuilder<ResetRequest>> fn)	Reset the project encryption key.
ElasticsearchEncryptionClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchEncryptionClient

public ElasticsearchEncryptionClient(ElasticsearchTransport transport)

ElasticsearchEncryptionClient

public ElasticsearchEncryptionClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchEncryptionClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchEncryptionClient>

reset

public ResetResponse reset(ResetRequest request)
                    throws IOException,
ElasticsearchException

Reset the project encryption key.

Destroy the current project encryption key (PEK) and generate a new one. This is the recovery path for when the on-disk encrypted PEK becomes permanently inaccessible, for example because the key encryption material protecting it was lost.

All data that was encrypted under the destroyed key becomes permanently unrecoverable. Each feature that stores encrypted data decides how to handle its own data during the reset: some features drop the encrypted values entirely, while others preserve the rest of the affected data and only clear the values that can no longer be decrypted.

Because this operation causes permanent data loss, it requires the accept_data_loss query parameter to be set to true.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reset

public final ResetResponse reset(Function<ResetRequest.Builder,ObjectBuilder<ResetRequest>> fn)
                          throws IOException,
ElasticsearchException

Reset the project encryption key.

Destroy the current project encryption key (PEK) and generate a new one. This is the recovery path for when the on-disk encrypted PEK becomes permanently inaccessible, for example because the key encryption material protecting it was lost.

All data that was encrypted under the destroyed key becomes permanently unrecoverable. Each feature that stores encrypted data decides how to handle its own data during the reset: some features drop the encrypted values entirely, while others preserve the rest of the affected data and only clear the values that can no longer be decrypted.

Because this operation causes permanent data loss, it requires the accept_data_loss query parameter to be set to true.

Parameters:

fn - a function that initializes a builder to create the ResetRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co