Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatusRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>, MutableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>, ObjectBuilder<SnapshotStatusRequest>

Enclosing class:

SnapshotStatusRequest

public static class SnapshotStatusRequest.Builder
extends RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>
implements CopyableBuilder<SnapshotStatusRequest.Builder,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	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final SnapshotStatusRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
SnapshotStatusRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotStatusRequest.Builder	ignoreUnavailable(Boolean value)	Whether to ignore any unavailable snapshots, When false, a SnapshotMissingException is thrown.
final SnapshotStatusRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SnapshotStatusRequest.Builder	masterTimeout(Time value)	Deprecated.
final SnapshotStatusRequest.Builder	repository(String value)	The name of the repository containing the snapshot.
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 org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SnapshotStatusRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SnapshotStatusRequest.Builder,SnapshotStatusRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SnapshotStatusRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SnapshotStatusRequest.Builder>

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final SnapshotStatusRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

ignoreUnavailable

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

Whether to ignore any unavailable snapshots, When false, a SnapshotMissingException is thrown.

API name: ignore_unavailable

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

repository

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

The name of the repository containing the snapshot.

API name: repository

snapshot

@Nonnull
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

@Nonnull
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.

build

@Nonnull
public SnapshotStatusRequest build()

Builds a SnapshotStatusRequest.

Specified by:

build in interface ObjectBuilder<SnapshotStatusRequest>

Throws:

NullPointerException - if some of the required fields are null.