SnapshotsRequest (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.SnapshotsRequest

public class SnapshotsRequest
extends CatRequestBase

Returns all snapshots in a specific repository.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class SnapshotsRequest.Builder
Builder for SnapshotsRequest.

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<SnapshotsRequest,SnapshotsResponse,ErrorResponse> _ENDPOINT
Endpoint "cat.snapshots".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`ignoreUnavailable()`	Set to true to ignore unavailable snapshots
`static SnapshotsRequest`	`of(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)`
`java.util.List<java.lang.String>`	`repository()`	Name of repository from which to fetch the snapshot 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<SnapshotsRequest,SnapshotsResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "cat.snapshots".
Method Details
- of
  
  public static SnapshotsRequest of(java.util.function.Function<SnapshotsRequest.Builder,ObjectBuilder<SnapshotsRequest>> fn)
- ignoreUnavailable
  
  @Nullable public final java.lang.Boolean ignoreUnavailable()
  
  Set to true to ignore unavailable snapshots
  API name: ignore_unavailable
- repository
  
  public final java.util.List<java.lang.String> repository()
  
  Name of repository from which to fetch the snapshot information
  API name: repository