co.elastic.clients.elasticsearch.indices.RecoveryRequest 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.RequestBase;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
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 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.recovery.Request
/**
* Get index recovery information. Get information about ongoing and completed
* shard recoveries for one or more indices. For data streams, the API returns
* information for the stream's backing indices.
*
* All recoveries, whether ongoing or complete, are kept in the cluster state
* and may be reported on at any time.
*
* Shard recovery is the process of initializing a shard copy, such as restoring
* a primary shard from a snapshot or creating a replica shard from a primary
* shard. When a shard recovery completes, the recovered shard is available for
* search and indexing.
*
* Recovery automatically occurs during the following processes:
*
* - When creating an index for the first time.
* - When a node rejoins the cluster and starts up any missing primary shard
* copies using the data that it holds in its data path.
* - Creation of new replica shard copies from the primary.
* - Relocation of a shard copy to a different node in the same cluster.
* - A snapshot restore operation.
* - A clone, shrink, or split operation.
*
*
* You can determine the cause of a shard recovery using the recovery or cat
* recovery APIs.
*
* The index recovery API reports information about completed recoveries only
* for shard copies that currently exist in the cluster. It only reports the
* last recovery for each shard copy and does not report historical information
* about earlier recoveries, nor does it report information about the recoveries
* of shard copies that no longer exist. This means that if a shard copy
* completes a recovery and then Elasticsearch relocates it onto a different
* node then the information about the original recovery will not be shown in
* the recovery API.
*
* @see API
* specification
*/
public class RecoveryRequest extends RequestBase {
@Nullable
private final Boolean activeOnly;
@Nullable
private final Boolean detailed;
private final List index;
// ---------------------------------------------------------------------------------------------
private RecoveryRequest(Builder builder) {
this.activeOnly = builder.activeOnly;
this.detailed = builder.detailed;
this.index = ApiTypeHelper.unmodifiable(builder.index);
}
public static RecoveryRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If true, the response only includes ongoing shard recoveries.
*
* API name: {@code active_only}
*/
@Nullable
public final Boolean activeOnly() {
return this.activeOnly;
}
/**
* If true, the response includes detailed information about shard
* recoveries.
*
* API name: {@code detailed}
*/
@Nullable
public final Boolean detailed() {
return this.detailed;
}
/**
* 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;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link RecoveryRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private Boolean activeOnly;
@Nullable
private Boolean detailed;
@Nullable
private List index;
/**
* If true, the response only includes ongoing shard recoveries.
*
* API name: {@code active_only}
*/
public final Builder activeOnly(@Nullable Boolean value) {
this.activeOnly = value;
return this;
}
/**
* If true, the response includes detailed information about shard
* recoveries.
*
* API name: {@code detailed}
*/
public final Builder detailed(@Nullable Boolean value) {
this.detailed = 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;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link RecoveryRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public RecoveryRequest build() {
_checkSingleUse();
return new RecoveryRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code indices.recovery}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/indices.recovery",
// Request method
request -> {
return "GET";
},
// 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("/_recovery");
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("/_recovery");
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.detailed != null) {
params.put("detailed", String.valueOf(request.detailed));
}
if (request.activeOnly != null) {
params.put("active_only", String.valueOf(request.activeOnly));
}
return params;
}, SimpleEndpoint.emptyMap(), false, RecoveryResponse._DESERIALIZER);
}