Package co.elastic.clients.elasticsearch.cat

Class SnapshotsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<SnapshotsRequest.Builder>

co.elastic.clients.elasticsearch.cat.SnapshotsRequest.Builder

All Implemented Interfaces:

WithJson<SnapshotsRequest.Builder>, ObjectBuilder<SnapshotsRequest>

Enclosing class:

SnapshotsRequest

public static class SnapshotsRequest.Builder
extends CatRequestBase.AbstractBuilder<SnapshotsRequest.Builder>
implements ObjectBuilder<SnapshotsRequest>

Builder for SnapshotsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRequest	build()	Builds a SnapshotsRequest.
final SnapshotsRequest.Builder	ignoreUnavailable(Boolean value)	Set to true to ignore unavailable snapshots
final SnapshotsRequest.Builder	repository(String value, String... values)	Name of repository from which to fetch the snapshot information
final SnapshotsRequest.Builder	repository(List<String> list)	Name of repository from which to fetch the snapshot information
protected SnapshotsRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

ignoreUnavailable

public final SnapshotsRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Set to true to ignore unavailable snapshots

API name: ignore_unavailable

repository

public final SnapshotsRequest.Builder repository(List<String> list)

Name of repository from which to fetch the snapshot information

API name: repository

Adds all elements of list to repository.

repository

public final SnapshotsRequest.Builder repository(String value,
 String... values)

Name of repository from which to fetch the snapshot information

API name: repository

Adds one or more values to repository.

self

protected SnapshotsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<SnapshotsRequest.Builder>

build

public SnapshotsRequest build()

Builds a SnapshotsRequest.

Specified by:

build in interface ObjectBuilder<SnapshotsRequest>

Throws:

NullPointerException - if some of the required fields are null.