Package co.elastic.clients.elasticsearch.enrich

Class ElasticsearchEnrichClient

java.lang.Object

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

co.elastic.clients.elasticsearch.enrich.ElasticsearchEnrichClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchEnrichClient
extends ApiClient<ElasticsearchTransport,ElasticsearchEnrichClient>

Client for the enrich namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeletePolicyResponse	deletePolicy(DeletePolicyRequest request)	Delete an enrich policy.
final DeletePolicyResponse	deletePolicy(Function<DeletePolicyRequest.Builder,ObjectBuilder<DeletePolicyRequest>> fn)	Delete an enrich policy.
ExecutePolicyResponse	executePolicy(ExecutePolicyRequest request)	Run an enrich policy.
final ExecutePolicyResponse	executePolicy(Function<ExecutePolicyRequest.Builder,ObjectBuilder<ExecutePolicyRequest>> fn)	Run an enrich policy.
GetPolicyResponse	getPolicy()	Get an enrich policy.
GetPolicyResponse	getPolicy(GetPolicyRequest request)	Get an enrich policy.
final GetPolicyResponse	getPolicy(Function<GetPolicyRequest.Builder,ObjectBuilder<GetPolicyRequest>> fn)	Get an enrich policy.
PutPolicyResponse	putPolicy(PutPolicyRequest request)	Create an enrich policy.
final PutPolicyResponse	putPolicy(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)	Create an enrich policy.
EnrichStatsResponse	stats()	Get enrich stats.
EnrichStatsResponse	stats(EnrichStatsRequest request)	Get enrich stats.
final EnrichStatsResponse	stats(Function<EnrichStatsRequest.Builder,ObjectBuilder<EnrichStatsRequest>> fn)	Get enrich stats.
ElasticsearchEnrichClient	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

ElasticsearchEnrichClient

public ElasticsearchEnrichClient(ElasticsearchTransport transport)

ElasticsearchEnrichClient

public ElasticsearchEnrichClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchEnrichClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchEnrichClient>

deletePolicy

public DeletePolicyResponse deletePolicy(DeletePolicyRequest request)
                                  throws IOException,
ElasticsearchException

Delete an enrich policy. Deletes an existing enrich policy and its enrich index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePolicy

public final DeletePolicyResponse deletePolicy(Function<DeletePolicyRequest.Builder,ObjectBuilder<DeletePolicyRequest>> fn)
                                        throws IOException,
ElasticsearchException

Delete an enrich policy. Deletes an existing enrich policy and its enrich index.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executePolicy

public ExecutePolicyResponse executePolicy(ExecutePolicyRequest request)
                                    throws IOException,
ElasticsearchException

Run an enrich policy. Create the enrich index for an existing enrich policy.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executePolicy

public final ExecutePolicyResponse executePolicy(Function<ExecutePolicyRequest.Builder,ObjectBuilder<ExecutePolicyRequest>> fn)
                                          throws IOException,
ElasticsearchException

Run an enrich policy. Create the enrich index for an existing enrich policy.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPolicy

public GetPolicyResponse getPolicy(GetPolicyRequest request)
                            throws IOException,
ElasticsearchException

Get an enrich policy. Returns information about an enrich policy.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPolicy

public final GetPolicyResponse getPolicy(Function<GetPolicyRequest.Builder,ObjectBuilder<GetPolicyRequest>> fn)
                                  throws IOException,
ElasticsearchException

Get an enrich policy. Returns information about an enrich policy.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPolicy

public GetPolicyResponse getPolicy()
                            throws IOException,
ElasticsearchException

Get an enrich policy. Returns information about an enrich policy.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPolicy

public PutPolicyResponse putPolicy(PutPolicyRequest request)
                            throws IOException,
ElasticsearchException

Create an enrich policy. Creates an enrich policy.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPolicy

public final PutPolicyResponse putPolicy(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)
                                  throws IOException,
ElasticsearchException

Create an enrich policy. Creates an enrich policy.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public EnrichStatsResponse stats(EnrichStatsRequest request)
                          throws IOException,
ElasticsearchException

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public final EnrichStatsResponse stats(Function<EnrichStatsRequest.Builder,ObjectBuilder<EnrichStatsRequest>> fn)
                                throws IOException,
ElasticsearchException

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public EnrichStatsResponse stats()
                          throws IOException,
ElasticsearchException

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co