Package co.elastic.clients.elasticsearch.synonyms

Class ElasticsearchSynonymsClient

java.lang.Object

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

co.elastic.clients.elasticsearch.synonyms.ElasticsearchSynonymsClient

public class ElasticsearchSynonymsClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSynonymsClient>

Client for the synonyms namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DeleteSynonymResponse	deleteSynonym(DeleteSynonymRequest request)	Deletes a synonym set
final DeleteSynonymResponse	deleteSynonym(Function<DeleteSynonymRequest.Builder,ObjectBuilder<DeleteSynonymRequest>> fn)	Deletes a synonym set
DeleteSynonymRuleResponse	deleteSynonymRule(DeleteSynonymRuleRequest request)	Deletes a synonym rule in a synonym set
final DeleteSynonymRuleResponse	deleteSynonymRule(Function<DeleteSynonymRuleRequest.Builder,ObjectBuilder<DeleteSynonymRuleRequest>> fn)	Deletes a synonym rule in a synonym set
GetSynonymResponse	getSynonym(GetSynonymRequest request)	Retrieves a synonym set
final GetSynonymResponse	getSynonym(Function<GetSynonymRequest.Builder,ObjectBuilder<GetSynonymRequest>> fn)	Retrieves a synonym set
GetSynonymRuleResponse	getSynonymRule(GetSynonymRuleRequest request)	Retrieves a synonym rule from a synonym set
final GetSynonymRuleResponse	getSynonymRule(Function<GetSynonymRuleRequest.Builder,ObjectBuilder<GetSynonymRuleRequest>> fn)	Retrieves a synonym rule from a synonym set
GetSynonymsSetsResponse	getSynonymsSets()	Retrieves a summary of all defined synonym sets
GetSynonymsSetsResponse	getSynonymsSets(GetSynonymsSetsRequest request)	Retrieves a summary of all defined synonym sets
final GetSynonymsSetsResponse	getSynonymsSets(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)	Retrieves a summary of all defined synonym sets
PutSynonymResponse	putSynonym(PutSynonymRequest request)	Creates or updates a synonyms set
final PutSynonymResponse	putSynonym(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)	Creates or updates a synonyms set
PutSynonymRuleResponse	putSynonymRule(PutSynonymRuleRequest request)	Creates or updates a synonym rule in a synonym set
final PutSynonymRuleResponse	putSynonymRule(Function<PutSynonymRuleRequest.Builder,ObjectBuilder<PutSynonymRuleRequest>> fn)	Creates or updates a synonym rule in a synonym set
ElasticsearchSynonymsClient	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

ElasticsearchSynonymsClient

public ElasticsearchSynonymsClient(ElasticsearchTransport transport)

ElasticsearchSynonymsClient

public ElasticsearchSynonymsClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSynonymsClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSynonymsClient>

deleteSynonym

public DeleteSynonymResponse deleteSynonym(DeleteSynonymRequest request)
                                    throws IOException,
ElasticsearchException

Deletes a synonym set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteSynonym

public final DeleteSynonymResponse deleteSynonym(Function<DeleteSynonymRequest.Builder,ObjectBuilder<DeleteSynonymRequest>> fn)
                                          throws IOException,
ElasticsearchException

Deletes a synonym set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteSynonymRule

public DeleteSynonymRuleResponse deleteSynonymRule(DeleteSynonymRuleRequest request)
                                            throws IOException,
ElasticsearchException

Deletes a synonym rule in a synonym set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteSynonymRule

public final DeleteSynonymRuleResponse deleteSynonymRule(Function<DeleteSynonymRuleRequest.Builder,ObjectBuilder<DeleteSynonymRuleRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Deletes a synonym rule in a synonym set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonym

public GetSynonymResponse getSynonym(GetSynonymRequest request)
                              throws IOException,
ElasticsearchException

Retrieves a synonym set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonym

public final GetSynonymResponse getSynonym(Function<GetSynonymRequest.Builder,ObjectBuilder<GetSynonymRequest>> fn)
                                    throws IOException,
ElasticsearchException

Retrieves a synonym set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonymRule

public GetSynonymRuleResponse getSynonymRule(GetSynonymRuleRequest request)
                                      throws IOException,
ElasticsearchException

Retrieves a synonym rule from a synonym set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonymRule

public final GetSynonymRuleResponse getSynonymRule(Function<GetSynonymRuleRequest.Builder,ObjectBuilder<GetSynonymRuleRequest>> fn)
                                            throws IOException,
ElasticsearchException

Retrieves a synonym rule from a synonym set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonymsSets

public GetSynonymsSetsResponse getSynonymsSets(GetSynonymsSetsRequest request)
                                        throws IOException,
ElasticsearchException

Retrieves a summary of all defined synonym sets

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonymsSets

public final GetSynonymsSetsResponse getSynonymsSets(Function<GetSynonymsSetsRequest.Builder,ObjectBuilder<GetSynonymsSetsRequest>> fn)
                                              throws IOException,
ElasticsearchException

Retrieves a summary of all defined synonym sets

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSynonymsSets

public GetSynonymsSetsResponse getSynonymsSets()
                                        throws IOException,
ElasticsearchException

Retrieves a summary of all defined synonym sets

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSynonym

public PutSynonymResponse putSynonym(PutSynonymRequest request)
                              throws IOException,
ElasticsearchException

Creates or updates a synonyms set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSynonym

public final PutSynonymResponse putSynonym(Function<PutSynonymRequest.Builder,ObjectBuilder<PutSynonymRequest>> fn)
                                    throws IOException,
ElasticsearchException

Creates or updates a synonyms set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSynonymRule

public PutSynonymRuleResponse putSynonymRule(PutSynonymRuleRequest request)
                                      throws IOException,
ElasticsearchException

Creates or updates a synonym rule in a synonym set

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSynonymRule

public final PutSynonymRuleResponse putSynonymRule(Function<PutSynonymRuleRequest.Builder,ObjectBuilder<PutSynonymRuleRequest>> fn)
                                            throws IOException,
ElasticsearchException

Creates or updates a synonym rule in a synonym set

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co