RecoveryRequest (java-client 7.15.0 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.RecoveryRequest

All Implemented Interfaces:: ElasticsearchCatRequest, ElasticsearchCommonRequest

public final class RecoveryRequest
extends CatRequestBase

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.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
Field Summary

Fields

Modifier and Type Field Description

static Endpoint<RecoveryRequest,RecoveryResponse,ElasticsearchError> ENDPOINT
Endpoint "cat.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()`	If `true`, the response only includes ongoing shard recoveries
`Bytes`	`bytes()`	The unit in which to display byte values
`java.lang.Boolean`	`detailed()`	If `true`, the response includes detailed information about shard recoveries
`java.util.List<java.lang.String>`	`index()`	Comma-separated list or wildcard expression of index names to limit the returned information

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 "cat.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()
  
  Comma-separated list or wildcard expression of index names to limit the returned information
  API name: index
- activeOnly
  
  @Nullable public java.lang.Boolean activeOnly()
  
  If true, the response only includes ongoing shard recoveries
  API name: active_only
- bytes
  
  @Nullable public Bytes bytes()
  
  The unit in which to display byte values
  API name: bytes
- detailed
  
  @Nullable public java.lang.Boolean detailed()
  
  If true, the response includes detailed information about shard recoveries
  API name: detailed