Package org.opensearch.client.opensearch.cat

Class SnapshotsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<SnapshotsRequest.Builder>

org.opensearch.client.opensearch.cat.SnapshotsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotsRequest

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

Builder for SnapshotsRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRequest	build()	Builds a SnapshotsRequest.
final SnapshotsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final SnapshotsRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
SnapshotsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotsRequest.Builder	ignoreUnavailable(Boolean value)	When true, the response does not include information from unavailable snapshots.
final SnapshotsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SnapshotsRequest.Builder	masterTimeout(Time value)	Deprecated.
final SnapshotsRequest.Builder	repository(String value, String... values)	A comma-separated list of snapshot repositories used to limit the request.
final SnapshotsRequest.Builder	repository(List<String> list)	A comma-separated list of snapshot repositories used to limit the request.
protected SnapshotsRequest.Builder	self()
final SnapshotsRequest.Builder	time(TimeUnit value)	Specifies the time units, for example, 5d or 7h.

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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 SnapshotsRequest.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<SnapshotsRequest.Builder,SnapshotsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SnapshotsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SnapshotsRequest.Builder>

clusterManagerTimeout

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

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

ignoreUnavailable

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

When true, the response does not include information from unavailable snapshots.

API name: ignore_unavailable

masterTimeout

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

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

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

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

repository

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

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.

API name: repository

Adds all elements of list to repository.

repository

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

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.

API name: repository

Adds one or more values to repository.

time

@Nonnull
public final SnapshotsRequest.Builder time(@Nullable
 TimeUnit value)

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

build

@Nonnull
public SnapshotsRequest build()

Builds a SnapshotsRequest.

Specified by:

build in interface ObjectBuilder<SnapshotsRequest>

Throws:

NullPointerException - if some of the required fields are null.