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)	Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
final SnapshotStatusRequest.Builder	masterTimeout(Time value)	Explicit operation timeout for connection to master node
final SnapshotStatusRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to master node
final SnapshotStatusRequest.Builder	repository(String value)	A repository name
protected SnapshotStatusRequest.Builder	self()
final SnapshotStatusRequest.Builder	snapshot(String value, String... values)	A comma-separated list of snapshot names
final SnapshotStatusRequest.Builder	snapshot(List<String> list)	A comma-separated list of snapshot names

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)

Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown

API name: ignore_unavailable

masterTimeout

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

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

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

Explicit operation timeout for connection to master node

API name: master_timeout

repository

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

A repository name

API name: repository

snapshot

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

A comma-separated list of snapshot names

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 snapshot names

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.