Package co.elastic.clients.elasticsearch.snapshot

Class SnapshotStatusRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.SnapshotStatusRequest.Builder

All Implemented Interfaces:

WithJson<SnapshotStatusRequest.Builder>, ObjectBuilder<SnapshotStatusRequest>

Enclosing class:

SnapshotStatusRequest

public static class SnapshotStatusRequest.Builder
extends RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>
implements ObjectBuilder<SnapshotStatusRequest>

Builder for SnapshotStatusRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotStatusRequest	build()	Builds a SnapshotStatusRequest.
final SnapshotStatusRequest.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error for any snapshots that are unavailable.
final SnapshotStatusRequest.Builder	masterTimeout(Time value)	The period to wait for the master node.
final SnapshotStatusRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for the master node.
final SnapshotStatusRequest.Builder	repository(String value)	The snapshot repository name used to limit the request.
protected SnapshotStatusRequest.Builder	self()
final SnapshotStatusRequest.Builder	snapshot(String value, String... values)	A comma-separated list of snapshots to retrieve status for.
final SnapshotStatusRequest.Builder	snapshot(List<String> list)	A comma-separated list of snapshots to retrieve status for.

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 SnapshotStatusRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If false, the request returns an error for any snapshots that are unavailable. If true, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.

API name: ignore_unavailable

masterTimeout

public final SnapshotStatusRequest.Builder masterTimeout(@Nullable
 Time value)

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

masterTimeout

public final SnapshotStatusRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

repository

public final SnapshotStatusRequest.Builder repository(@Nullable
 String value)

The snapshot repository name used to limit the request. It supports wildcards (*) if <snapshot> isn't specified.

API name: repository

snapshot

public final SnapshotStatusRequest.Builder snapshot(List<String> list)

A comma-separated list of snapshots to retrieve status for. The default is currently running snapshots. Wildcards (*) are not supported.

API name: snapshot

Adds all elements of list to snapshot.

snapshot

public final SnapshotStatusRequest.Builder snapshot(String value,
 String... values)

A comma-separated list of snapshots to retrieve status for. The default is currently running snapshots. Wildcards (*) are not supported.

API name: snapshot

Adds one or more values to snapshot.

self

protected SnapshotStatusRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>

build

public SnapshotStatusRequest build()

Builds a SnapshotStatusRequest.

Specified by:

build in interface ObjectBuilder<SnapshotStatusRequest>

Throws:

NullPointerException - if some of the required fields are null.