Package co.elastic.clients.elasticsearch.enrich

Class ElasticsearchEnrichClient

java.lang.Object

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

co.elastic.clients.elasticsearch.enrich.ElasticsearchEnrichClient

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)	Deletes an existing enrich policy and its enrich index.
final DeletePolicyResponse	deletePolicy(Function<DeletePolicyRequest.Builder,ObjectBuilder<DeletePolicyRequest>> fn)	Deletes an existing enrich policy and its enrich index.
ExecutePolicyResponse	executePolicy(ExecutePolicyRequest request)	Creates the enrich index for an existing enrich policy.
final ExecutePolicyResponse	executePolicy(Function<ExecutePolicyRequest.Builder,ObjectBuilder<ExecutePolicyRequest>> fn)	Creates the enrich index for an existing enrich policy.
GetPolicyResponse	getPolicy()	Returns information about an enrich policy.
GetPolicyResponse	getPolicy(GetPolicyRequest request)	Returns information about an enrich policy.
final GetPolicyResponse	getPolicy(Function<GetPolicyRequest.Builder,ObjectBuilder<GetPolicyRequest>> fn)	Returns information about an enrich policy.
PutPolicyResponse	putPolicy(PutPolicyRequest request)	Creates an enrich policy.
final PutPolicyResponse	putPolicy(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)	Creates an enrich policy.
EnrichStatsResponse	stats()	Returns enrich coordinator statistics and information about enrich policies that are currently executing.
ElasticsearchEnrichClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, 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

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

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

Creates 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

Creates 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

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

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

Returns information about an enrich policy.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPolicy

public PutPolicyResponse putPolicy(PutPolicyRequest request)
                            throws IOException,
ElasticsearchException

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

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()
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co