co.elastic.clients.elasticsearch.indices.PutIndicesSettingsRequest 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.indices;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import jakarta.json.stream.JsonParser;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
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.
//
//----------------------------------------------------------------
// typedef: indices.put_settings.Request
/**
* Update index settings. Changes dynamic index settings in real time. For data
* streams, index setting changes are applied to all backing indices by default.
*
* To revert a setting to the default value, use a null value. The list of
* per-index settings that can be updated dynamically on live indices can be
* found in index settings documentation. To preserve existing settings from
* being updated, set the preserve_existing parameter to
* true.
*
* For performance optimization during bulk indexing, you can disable the
* refresh interval. Refer to disable
* refresh interval for an example. There are multiple valid ways to
* represent index settings in the request body. You can specify only the
* setting, for example:
*
*
* {
* "number_of_replicas": 1
* }
*
*
*
* Or you can use an index setting object:
*
*
* {
* "index": {
* "number_of_replicas": 1
* }
* }
*
*
*
* Or you can use dot annotation:
*
*
* {
* "index.number_of_replicas": 1
* }
*
*
*
* Or you can embed any of the aforementioned options in a settings
* object. For example:
*
*
* {
* "settings": {
* "index": {
* "number_of_replicas": 1
* }
* }
* }
*
*
*
* NOTE: You can only define new analyzers on closed indices. To add an
* analyzer, you must close the index, define the analyzer, and reopen the
* index. You cannot close the write index of a data stream. To update the
* analyzer for a data stream's write index and future backing indices, update
* the analyzer in the index template used by the stream. Then roll over the
* data stream to apply the new analyzer to the stream's write index and future
* backing indices. This affects searches and any new data added to the stream
* after the rollover. However, it does not affect the data stream's backing
* indices or their existing data. To change the analyzer for existing backing
* indices, you must create a new data stream and reindex your data into it.
* Refer to updating
* analyzers on existing indices for step-by-step examples.
*
* @see API
* specification
*/
@JsonpDeserializable
public class PutIndicesSettingsRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowNoIndices;
private final List expandWildcards;
@Nullable
private final Boolean flatSettings;
@Nullable
private final Boolean ignoreUnavailable;
private final List index;
@Nullable
private final Time masterTimeout;
@Nullable
private final Boolean preserveExisting;
@Nullable
private final Boolean reopen;
@Nullable
private final Time timeout;
private final IndexSettings settings;
// ---------------------------------------------------------------------------------------------
private PutIndicesSettingsRequest(Builder builder) {
this.allowNoIndices = builder.allowNoIndices;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.flatSettings = builder.flatSettings;
this.ignoreUnavailable = builder.ignoreUnavailable;
this.index = ApiTypeHelper.unmodifiable(builder.index);
this.masterTimeout = builder.masterTimeout;
this.preserveExisting = builder.preserveExisting;
this.reopen = builder.reopen;
this.timeout = builder.timeout;
this.settings = ApiTypeHelper.requireNonNull(builder.settings, this, "settings");
}
public static PutIndicesSettingsRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If false, the request returns an error if any wildcard
* expression, index alias, or _all value targets only missing or
* closed indices. This behavior applies even if the request targets other open
* indices. For example, a request targeting foo*,bar* returns an
* error if an index starts with foo but no index starts with
* bar.
*
* API name: {@code allow_no_indices}
*/
@Nullable
public final Boolean allowNoIndices() {
return this.allowNoIndices;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* If true, returns settings in flat format.
*
* API name: {@code flat_settings}
*/
@Nullable
public final Boolean flatSettings() {
return this.flatSettings;
}
/**
* If true, returns settings in flat format.
*
* API name: {@code ignore_unavailable}
*/
@Nullable
public final Boolean ignoreUnavailable() {
return this.ignoreUnavailable;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* If true, existing index settings remain unchanged.
*
* API name: {@code preserve_existing}
*/
@Nullable
public final Boolean preserveExisting() {
return this.preserveExisting;
}
/**
* Whether to close and reopen the index to apply non-dynamic settings. If set
* to true the indices to which the settings are being applied will
* be closed temporarily and then reopened in order to apply the changes.
*
* API name: {@code reopen}
*/
@Nullable
public final Boolean reopen() {
return this.reopen;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* Required - Request body.
*/
public final IndexSettings settings() {
return this.settings;
}
/**
* Serialize this value to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
this.settings.serialize(generator, mapper);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PutIndicesSettingsRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean allowNoIndices;
@Nullable
private List expandWildcards;
@Nullable
private Boolean flatSettings;
@Nullable
private Boolean ignoreUnavailable;
@Nullable
private List index;
@Nullable
private Time masterTimeout;
@Nullable
private Boolean preserveExisting;
@Nullable
private Boolean reopen;
@Nullable
private Time timeout;
private IndexSettings settings;
/**
* If false, the request returns an error if any wildcard
* expression, index alias, or _all value targets only missing or
* closed indices. This behavior applies even if the request targets other open
* indices. For example, a request targeting foo*,bar* returns an
* error if an index starts with foo but no index starts with
* bar.
*
* API name: {@code allow_no_indices}
*/
public final Builder allowNoIndices(@Nullable Boolean value) {
this.allowNoIndices = value;
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds all elements of list to expandWildcards.
*/
public final Builder expandWildcards(List list) {
this.expandWildcards = _listAddAll(this.expandWildcards, list);
return this;
}
/**
* Type of index that wildcard patterns can match. If the request can target
* data streams, this argument determines whether wildcard expressions match
* hidden data streams. Supports comma-separated values, such as
* open,hidden.
*
* API name: {@code expand_wildcards}
*
* Adds one or more values to expandWildcards.
*/
public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) {
this.expandWildcards = _listAdd(this.expandWildcards, value, values);
return this;
}
/**
* If true, returns settings in flat format.
*
* API name: {@code flat_settings}
*/
public final Builder flatSettings(@Nullable Boolean value) {
this.flatSettings = value;
return this;
}
/**
* If true, returns settings in flat format.
*
* API name: {@code ignore_unavailable}
*/
public final Builder ignoreUnavailable(@Nullable Boolean value) {
this.ignoreUnavailable = value;
return this;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* Comma-separated list of data streams, indices, and aliases used to limit the
* request. Supports wildcards (*). To target all data streams and
* indices, omit this parameter or use * or _all.
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* If true, existing index settings remain unchanged.
*
* API name: {@code preserve_existing}
*/
public final Builder preserveExisting(@Nullable Boolean value) {
this.preserveExisting = value;
return this;
}
/**
* Whether to close and reopen the index to apply non-dynamic settings. If set
* to true the indices to which the settings are being applied will
* be closed temporarily and then reopened in order to apply the changes.
*
* API name: {@code reopen}
*/
public final Builder reopen(@Nullable Boolean value) {
this.reopen = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Required - Request body.
*/
public final Builder settings(IndexSettings value) {
this.settings = value;
return this;
}
/**
* Required - Request body.
*/
public final Builder settings(Function> fn) {
return this.settings(fn.apply(new IndexSettings.Builder()).build());
}
@Override
public Builder withJson(JsonParser parser, JsonpMapper mapper) {
@SuppressWarnings("unchecked")
IndexSettings value = (IndexSettings) IndexSettings._DESERIALIZER.deserialize(parser, mapper);
return this.settings(value);
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PutIndicesSettingsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PutIndicesSettingsRequest build() {
_checkSingleUse();
return new PutIndicesSettingsRequest(this);
}
}
public static final JsonpDeserializer _DESERIALIZER = createPutIndicesSettingsRequestDeserializer();
protected static JsonpDeserializer createPutIndicesSettingsRequestDeserializer() {
JsonpDeserializer valueDeserializer = IndexSettings._DESERIALIZER;
return JsonpDeserializer.of(valueDeserializer.acceptedEvents(), (parser, mapper, event) -> new Builder()
.settings(valueDeserializer.deserialize(parser, mapper, event)).build());
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code indices.put_settings}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/indices.put_settings",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_settings");
return buf.toString();
}
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_settings");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
}
if (propsSet == (_index)) {
params.put("index", request.index.stream().map(v -> v).collect(Collectors.joining(",")));
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.flatSettings != null) {
params.put("flat_settings", String.valueOf(request.flatSettings));
}
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.ignoreUnavailable != null) {
params.put("ignore_unavailable", String.valueOf(request.ignoreUnavailable));
}
if (request.allowNoIndices != null) {
params.put("allow_no_indices", String.valueOf(request.allowNoIndices));
}
if (request.reopen != null) {
params.put("reopen", String.valueOf(request.reopen));
}
if (request.preserveExisting != null) {
params.put("preserve_existing", String.valueOf(request.preserveExisting));
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), true, PutIndicesSettingsResponse._DESERIALIZER);
}