Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatusRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotStatusRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SnapshotStatusRequest>

Enclosing class:

SnapshotStatusRequest

public static class SnapshotStatusRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SnapshotStatusRequest>

Builder for SnapshotStatusRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotStatusRequest	build()	Builds a SnapshotStatusRequest.
SnapshotStatusRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to cluster-manager node
SnapshotStatusRequest.Builder	clusterManagerTimeout(Time value)	Explicit operation timeout for connection to cluster-manager node
SnapshotStatusRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
SnapshotStatusRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
SnapshotStatusRequest.Builder	masterTimeout(Time value)	Deprecated.
SnapshotStatusRequest.Builder	repository(java.lang.String value)	A repository name
SnapshotStatusRequest.Builder	snapshot(java.lang.String value, java.lang.String... values)	A comma-separated list of snapshot names
SnapshotStatusRequest.Builder	snapshot(java.util.List<java.lang.String> list)	A comma-separated list of snapshot names

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

ignoreUnavailable

public final SnapshotStatusRequest.Builder ignoreUnavailable(@Nullable
                                                             java.lang.Boolean value)

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

API name: ignore_unavailable

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

@Deprecated
public final SnapshotStatusRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

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

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

clusterManagerTimeout

public final SnapshotStatusRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

repository

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

A repository name

API name: repository

snapshot

public final SnapshotStatusRequest.Builder snapshot(java.util.List<java.lang.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(java.lang.String value,
                                                    java.lang.String... values)

A comma-separated list of snapshot names

API name: snapshot

Adds one or more values to snapshot.

build

public SnapshotStatusRequest build()

Builds a SnapshotStatusRequest.

Specified by:

build in interface ObjectBuilder<SnapshotStatusRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.