co.elastic.clients.elasticsearch.synonyms.ElasticsearchSynonymsClient Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.synonyms;
import co.elastic.clients.ApiClient;
import co.elastic.clients.elasticsearch._types.ElasticsearchException;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.JsonEndpoint;
import co.elastic.clients.transport.Transport;
import co.elastic.clients.transport.TransportOptions;
import co.elastic.clients.util.ObjectBuilder;
import java.io.IOException;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
/**
* Client for the synonyms namespace.
*/
public class ElasticsearchSynonymsClient extends ApiClient {
public ElasticsearchSynonymsClient(ElasticsearchTransport transport) {
super(transport, null);
}
public ElasticsearchSynonymsClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions) {
super(transport, transportOptions);
}
@Override
public ElasticsearchSynonymsClient withTransportOptions(@Nullable TransportOptions transportOptions) {
return new ElasticsearchSynonymsClient(this.transport, transportOptions);
}
// ----- Endpoint: synonyms.delete_synonym
/**
* Delete a synonym set.
*
* You can only delete a synonyms set that is not in use by any index analyzer.
*
* Synonyms sets can be used in synonym graph token filters and synonym token
* filters. These synonym filters can be used as part of search analyzers.
*
* Analyzers need to be loaded when an index is restored (such as when a node
* starts, or the index becomes open). Even if the analyzer is not used on any
* field mapping, it still needs to be loaded on the index recovery phase.
*
* If any analyzers cannot be loaded, the index becomes unavailable and the
* cluster status becomes red or yellow as index shards are not available. To
* prevent that, synonyms sets that are used in analyzers can't be deleted. A
* delete request in this case will return a 400 response code.
*
* To remove a synonyms set, you must first remove all indices that contain
* analyzers using it. You can migrate an index by creating a new index that
* does not contain the token filter with the synonyms set, and use the reindex
* API in order to copy over the index data. Once finished, you can delete the
* index. When the synonyms set is not used in analyzers, you will be able to
* delete it.
*
* @see Documentation
* on elastic.co
*/
public DeleteSynonymResponse deleteSynonym(DeleteSynonymRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) DeleteSynonymRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Delete a synonym set.
*
* You can only delete a synonyms set that is not in use by any index analyzer.
*
* Synonyms sets can be used in synonym graph token filters and synonym token
* filters. These synonym filters can be used as part of search analyzers.
*
* Analyzers need to be loaded when an index is restored (such as when a node
* starts, or the index becomes open). Even if the analyzer is not used on any
* field mapping, it still needs to be loaded on the index recovery phase.
*
* If any analyzers cannot be loaded, the index becomes unavailable and the
* cluster status becomes red or yellow as index shards are not available. To
* prevent that, synonyms sets that are used in analyzers can't be deleted. A
* delete request in this case will return a 400 response code.
*
* To remove a synonyms set, you must first remove all indices that contain
* analyzers using it. You can migrate an index by creating a new index that
* does not contain the token filter with the synonyms set, and use the reindex
* API in order to copy over the index data. Once finished, you can delete the
* index. When the synonyms set is not used in analyzers, you will be able to
* delete it.
*
* @param fn
* a function that initializes a builder to create the
* {@link DeleteSynonymRequest}
* @see Documentation
* on elastic.co
*/
public final DeleteSynonymResponse deleteSynonym(
Function> fn)
throws IOException, ElasticsearchException {
return deleteSynonym(fn.apply(new DeleteSynonymRequest.Builder()).build());
}
// ----- Endpoint: synonyms.delete_synonym_rule
/**
* Delete a synonym rule. Delete a synonym rule from a synonym set.
*
* @see Documentation
* on elastic.co
*/
public DeleteSynonymRuleResponse deleteSynonymRule(DeleteSynonymRuleRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) DeleteSynonymRuleRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Delete a synonym rule. Delete a synonym rule from a synonym set.
*
* @param fn
* a function that initializes a builder to create the
* {@link DeleteSynonymRuleRequest}
* @see Documentation
* on elastic.co
*/
public final DeleteSynonymRuleResponse deleteSynonymRule(
Function> fn)
throws IOException, ElasticsearchException {
return deleteSynonymRule(fn.apply(new DeleteSynonymRuleRequest.Builder()).build());
}
// ----- Endpoint: synonyms.get_synonym
/**
* Get a synonym set.
*
* @see Documentation
* on elastic.co
*/
public GetSynonymResponse getSynonym(GetSynonymRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) GetSynonymRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get a synonym set.
*
* @param fn
* a function that initializes a builder to create the
* {@link GetSynonymRequest}
* @see Documentation
* on elastic.co
*/
public final GetSynonymResponse getSynonym(Function> fn)
throws IOException, ElasticsearchException {
return getSynonym(fn.apply(new GetSynonymRequest.Builder()).build());
}
// ----- Endpoint: synonyms.get_synonym_rule
/**
* Get a synonym rule. Get a synonym rule from a synonym set.
*
* @see Documentation
* on elastic.co
*/
public GetSynonymRuleResponse getSynonymRule(GetSynonymRuleRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) GetSynonymRuleRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get a synonym rule. Get a synonym rule from a synonym set.
*
* @param fn
* a function that initializes a builder to create the
* {@link GetSynonymRuleRequest}
* @see Documentation
* on elastic.co
*/
public final GetSynonymRuleResponse getSynonymRule(
Function> fn)
throws IOException, ElasticsearchException {
return getSynonymRule(fn.apply(new GetSynonymRuleRequest.Builder()).build());
}
// ----- Endpoint: synonyms.get_synonyms_sets
/**
* Get all synonym sets. Get a summary of all defined synonym sets.
*
* @see Documentation
* on elastic.co
*/
public GetSynonymsSetsResponse getSynonymsSets(GetSynonymsSetsRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) GetSynonymsSetsRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get all synonym sets. Get a summary of all defined synonym sets.
*
* @param fn
* a function that initializes a builder to create the
* {@link GetSynonymsSetsRequest}
* @see Documentation
* on elastic.co
*/
public final GetSynonymsSetsResponse getSynonymsSets(
Function> fn)
throws IOException, ElasticsearchException {
return getSynonymsSets(fn.apply(new GetSynonymsSetsRequest.Builder()).build());
}
/**
* Get all synonym sets. Get a summary of all defined synonym sets.
*
* @see Documentation
* on elastic.co
*/
public GetSynonymsSetsResponse getSynonymsSets() throws IOException, ElasticsearchException {
return this.transport.performRequest(new GetSynonymsSetsRequest.Builder().build(),
GetSynonymsSetsRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: synonyms.put_synonym
/**
* 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.
*
* When an existing synonyms set is updated, the search analyzers that use the
* synonyms set are reloaded automatically for all indices. This is equivalent
* to invoking the reload search analyzers API for all indices that use the
* synonyms set.
*
* @see Documentation
* on elastic.co
*/
public PutSynonymResponse putSynonym(PutSynonymRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) PutSynonymRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* 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.
*
* When an existing synonyms set is updated, the search analyzers that use the
* synonyms set are reloaded automatically for all indices. This is equivalent
* to invoking the reload search analyzers API for all indices that use the
* synonyms set.
*
* @param fn
* a function that initializes a builder to create the
* {@link PutSynonymRequest}
* @see Documentation
* on elastic.co
*/
public final PutSynonymResponse putSynonym(Function> fn)
throws IOException, ElasticsearchException {
return putSynonym(fn.apply(new PutSynonymRequest.Builder()).build());
}
// ----- Endpoint: synonyms.put_synonym_rule
/**
* Create or update a synonym rule. Create or update a synonym rule in a synonym
* set.
*
* If any of the synonym rules included is invalid, the API returns an error.
*
* When you update a synonym rule, all analyzers using the synonyms set will be
* reloaded automatically to reflect the new rule.
*
* @see Documentation
* on elastic.co
*/
public PutSynonymRuleResponse putSynonymRule(PutSynonymRuleRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) PutSynonymRuleRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Create or update a synonym rule. Create or update a synonym rule in a synonym
* set.
*
* If any of the synonym rules included is invalid, the API returns an error.
*
* When you update a synonym rule, all analyzers using the synonyms set will be
* reloaded automatically to reflect the new rule.
*
* @param fn
* a function that initializes a builder to create the
* {@link PutSynonymRuleRequest}
* @see Documentation
* on elastic.co
*/
public final PutSynonymRuleResponse putSynonymRule(
Function> fn)
throws IOException, ElasticsearchException {
return putSynonymRule(fn.apply(new PutSynonymRuleRequest.Builder()).build());
}
}