Package org.opensearch.client.opensearch.indices

Class RecoveryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.RecoveryRequest

All Implemented Interfaces:

ToCopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class RecoveryRequest
extends RequestBase
implements ToCopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>

Returns information about ongoing index shard recoveries.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.recovery".

Method Summary

Modifier and Type	Method	Description
final Boolean	activeOnly()	If true, the response only includes ongoing shard recoveries.
protected void	applyQueryParameters(Map<String,String> params)
static RecoveryRequest.Builder	builder()
final Boolean	detailed()	If true, the response includes detailed information about shard recoveries.
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	Comma-separated list of data streams, indexes, and aliases used to limit the request.
static RecoveryRequest	of(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
RecoveryRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.recovery".

Method Details

of

public static RecoveryRequest of(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)

activeOnly

@Nullable
public final Boolean activeOnly()

If true, the response only includes ongoing shard recoveries.

API name: active_only

detailed

@Nullable
public final Boolean detailed()

If true, the response includes detailed information about shard recoveries.

API name: detailed

index

@Nonnull
public final List<String> index()

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

toBuilder

@Nonnull
public RecoveryRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static RecoveryRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object