Package co.elastic.clients.elasticsearch.synonyms

Class ElasticsearchSynonymsAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.synonyms.ElasticsearchSynonymsAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSynonymsAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSynonymsAsyncClient>

Client for the synonyms namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteSynonymResponse>	deleteSynonym(DeleteSynonymRequest request)	Delete a synonym set.
final CompletableFuture<DeleteSynonymResponse>	deleteSynonym(Function<DeleteSynonymRequest.Builder,ObjectBuilder<DeleteSynonymRequest>> fn)	Delete a synonym set.
CompletableFuture<DeleteSynonymRuleResponse>	deleteSynonymRule(DeleteSynonymRuleRequest request)	Delete a synonym rule.
final CompletableFuture<DeleteSynonymRuleResponse>	deleteSynonymRule(Function<DeleteSynonymRuleRequest.Builder,ObjectBuilder<DeleteSynonymRuleRequest>> fn)	Delete a synonym rule.
CompletableFuture<GetSynonymResponse>	getSynonym(GetSynonymRequest request)	Get a synonym set.
final CompletableFuture<GetSynonymResponse>	getSynonym(Function<GetSynonymRequest.Builder,ObjectBuilder<GetSynonymRequest>> fn)	Get a synonym set.
CompletableFuture<GetSynonymRuleResponse>	getSynonymRule(GetSynonymRuleRequest request)	Get a synonym rule.
final CompletableFuture<GetSynonymRuleResponse>	getSynonymRule(Function<GetSynonymRuleRequest.Builder,ObjectBuilder<GetSynonymRuleRequest>> fn)	Get a synonym rule.
CompletableFuture<GetSynonymsSetsResponse>	getSynonymsSets()	Get all synonym sets.
CompletableFuture<GetSynonymsSetsResponse>	getSynonymsSets(GetSynonymsSetsRequest request)	Get all synonym sets.
final CompletableFuture<GetSynonymsSetsResponse>	getSynonymsSets(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)	Get all synonym sets.
CompletableFuture<PutSynonymResponse>	putSynonym(PutSynonymRequest request)	Create or update a synonym set.
final CompletableFuture<PutSynonymResponse>	putSynonym(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)	Create or update a synonym set.
CompletableFuture<PutSynonymRuleResponse>	putSynonymRule(PutSynonymRuleRequest request)	Create or update a synonym rule.
final CompletableFuture<PutSynonymRuleResponse>	putSynonymRule(Function<PutSynonymRuleRequest.Builder,ObjectBuilder<PutSynonymRuleRequest>> fn)	Create or update a synonym rule.
ElasticsearchSynonymsAsyncClient	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

ElasticsearchSynonymsAsyncClient

public ElasticsearchSynonymsAsyncClient(ElasticsearchTransport transport)

ElasticsearchSynonymsAsyncClient

public ElasticsearchSynonymsAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSynonymsAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSynonymsAsyncClient>

deleteSynonym

public CompletableFuture<DeleteSynonymResponse> deleteSynonym(DeleteSynonymRequest request)

Delete a synonym set.

See Also:

• Documentation on elastic.co

deleteSynonym

public final CompletableFuture<DeleteSynonymResponse> deleteSynonym(Function<DeleteSynonymRequest.Builder,ObjectBuilder<DeleteSynonymRequest>> fn)

Delete a synonym set.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteSynonymRule

public CompletableFuture<DeleteSynonymRuleResponse> deleteSynonymRule(DeleteSynonymRuleRequest request)

Delete a synonym rule. Delete a synonym rule from a synonym set.

See Also:

• Documentation on elastic.co

deleteSynonymRule

public final CompletableFuture<DeleteSynonymRuleResponse> deleteSynonymRule(Function<DeleteSynonymRuleRequest.Builder,ObjectBuilder<DeleteSynonymRuleRequest>> fn)

Delete a synonym rule. Delete a synonym rule from a synonym set.

Parameters:

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

See Also:

• Documentation on elastic.co

getSynonym

public CompletableFuture<GetSynonymResponse> getSynonym(GetSynonymRequest request)

Get a synonym set.

See Also:

• Documentation on elastic.co

getSynonym

public final CompletableFuture<GetSynonymResponse> getSynonym(Function<GetSynonymRequest.Builder,ObjectBuilder<GetSynonymRequest>> fn)

Get a synonym set.

Parameters:

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

See Also:

• Documentation on elastic.co

getSynonymRule

public CompletableFuture<GetSynonymRuleResponse> getSynonymRule(GetSynonymRuleRequest request)

Get a synonym rule. Get a synonym rule from a synonym set.

See Also:

• Documentation on elastic.co

getSynonymRule

public final CompletableFuture<GetSynonymRuleResponse> getSynonymRule(Function<GetSynonymRuleRequest.Builder,ObjectBuilder<GetSynonymRuleRequest>> fn)

Get a synonym rule. Get a synonym rule from a synonym set.

Parameters:

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

See Also:

• Documentation on elastic.co

getSynonymsSets

public CompletableFuture<GetSynonymsSetsResponse> getSynonymsSets(GetSynonymsSetsRequest request)

Get all synonym sets. Get a summary of all defined synonym sets.

See Also:

• Documentation on elastic.co

getSynonymsSets

public final CompletableFuture<GetSynonymsSetsResponse> getSynonymsSets(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)

Get all synonym sets. Get a summary of all defined synonym sets.

Parameters:

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

See Also:

• Documentation on elastic.co

getSynonymsSets

public CompletableFuture<GetSynonymsSetsResponse> getSynonymsSets()

Get all synonym sets. Get a summary of all defined synonym sets.

See Also:

• Documentation on elastic.co

putSynonym

public CompletableFuture<PutSynonymResponse> putSynonym(PutSynonymRequest request)

Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

See Also:

• Documentation on elastic.co

putSynonym

public final CompletableFuture<PutSynonymResponse> putSynonym(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)

Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

Parameters:

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

See Also:

• Documentation on elastic.co

putSynonymRule

public CompletableFuture<PutSynonymRuleResponse> putSynonymRule(PutSynonymRuleRequest request)

Create or update a synonym rule. Create or update a synonym rule in a synonym set.

See Also:

• Documentation on elastic.co

putSynonymRule

public final CompletableFuture<PutSynonymRuleResponse> putSynonymRule(Function<PutSynonymRuleRequest.Builder,ObjectBuilder<PutSynonymRuleRequest>> fn)

Create or update a synonym rule. Create or update a synonym rule in a synonym set.

Parameters:

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

See Also:

• Documentation on elastic.co