Package co.elastic.clients.elasticsearch.indices

Class RecoveryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.RecoveryRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class RecoveryRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecoveryRequest.Builder	Builder for RecoveryRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<RecoveryRequest,RecoveryResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.recovery".

Constructor Summary

Constructors

Constructor	Description
RecoveryRequest(RecoveryRequest.Builder builder)
RecoveryRequest(java.util.function.Function<RecoveryRequest.Builder,RecoveryRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	activeOnly()	Display only those recoveries that are currently on-going
java.lang.Boolean	detailed()	Whether to display detailed information about shard recovery
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENDPOINT

public static final Endpoint<RecoveryRequest,RecoveryResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.recovery".

Constructor Details

RecoveryRequest

public RecoveryRequest(RecoveryRequest.Builder builder)

RecoveryRequest

public RecoveryRequest(java.util.function.Function<RecoveryRequest.Builder,RecoveryRequest.Builder> fn)

Method Details

index

@Nullable
public java.util.List<java.lang.String> index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

activeOnly

@Nullable
public java.lang.Boolean activeOnly()

Display only those recoveries that are currently on-going

API name: active_only

detailed

@Nullable
public java.lang.Boolean detailed()

Whether to display detailed information about shard recovery

API name: detailed