Class SnapshotsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.SnapshotsRequest
Returns information about the snapshots stored in one or more repositories. A
snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT:
cat APIs are only intended for human consumption using the command line or
Kibana console. They are not intended for use by applications. For
application consumption, use the get snapshot API.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<SnapshotsRequest,
SnapshotsResponse, ErrorResponse> Endpoint "cat.snapshots
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iftrue
, the response does not include information from unavailable snapshots.static SnapshotsRequest
A comma-separated list of snapshot repositories used to limit the request.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.snapshots
".
-
-
Method Details
-
of
public static SnapshotsRequest of(Function<SnapshotsRequest.Builder, ObjectBuilder<SnapshotsRequest>> fn) -
repository
A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions._all
returns all repositories. If any repository fails during the request, Elasticsearch returns an error.API name:
repository
-