Package co.elastic.clients.elasticsearch.cat

Class SnapshotsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.SnapshotsRequest

All Implemented Interfaces:

ElasticsearchCatRequest, ElasticsearchCommonRequest

public final class SnapshotsRequest
extends CatRequestBase

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,ElasticsearchError>	ENDPOINT	Endpoint "cat.snapshots".

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	ignoreUnavailable()	Set to true to ignore unavailable snapshots
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,ElasticsearchError> ENDPOINT

Endpoint "cat.snapshots".

Constructor Details

SnapshotsRequest

public SnapshotsRequest(SnapshotsRequest.Builder builder)

SnapshotsRequest

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

Method Details

repository

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

Name of repository from which to fetch the snapshot information

API name: repository

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

Set to true to ignore unavailable snapshots

API name: ignore_unavailable