Package org.opensearch.client.opensearch.snapshot

Class GetSnapshotRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.GetSnapshotRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetSnapshotRequest>

Enclosing class:

GetSnapshotRequest

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

Builder for GetSnapshotRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSnapshotRequest	build()	Builds a GetSnapshotRequest.
GetSnapshotRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
GetSnapshotRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
GetSnapshotRequest.Builder	human(java.lang.Boolean value)	API name: human
GetSnapshotRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	If false, the request returns an error for any snapshots that are unavailable.
GetSnapshotRequest.Builder	includeRepository(java.lang.Boolean value)	Deprecated.
GetSnapshotRequest.Builder	indexDetails(java.lang.Boolean value)	Deprecated.
GetSnapshotRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
GetSnapshotRequest.Builder	masterTimeout(Time value)	Deprecated.
GetSnapshotRequest.Builder	repository(java.lang.String value)	Required - Comma-separated list of snapshot repository names used to limit the request.
GetSnapshotRequest.Builder	snapshot(java.lang.String value, java.lang.String... values)	Required -
GetSnapshotRequest.Builder	snapshot(java.util.List<java.lang.String> list)	Required -
GetSnapshotRequest.Builder	verbose(java.lang.Boolean value)	If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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

human

public final GetSnapshotRequest.Builder human(@Nullable
                                              java.lang.Boolean value)

API name: human

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

ignoreUnavailable

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

If false, the request returns an error for any snapshots that are unavailable.

API name: ignore_unavailable

includeRepository

@Deprecated
public final GetSnapshotRequest.Builder includeRepository(@Nullable
                                                          java.lang.Boolean value)

Deprecated.

This method is left for compatibility. The set value is not used.

indexDetails

@Deprecated
public final GetSnapshotRequest.Builder indexDetails(@Nullable
                                                     java.lang.Boolean value)

Deprecated.

This method is left for compatibility. The set value is not used.

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

repository

@Nonnull
public final GetSnapshotRequest.Builder repository(java.lang.String value)

Required - Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

API name: repository

snapshot

@Nonnull
public final GetSnapshotRequest.Builder snapshot(java.util.List<java.lang.String> list)

Required -

Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).

• To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
• To get information about any snapshots that are currently running, use _current.

API name: snapshot

Adds all elements of list to snapshot.

snapshot

@Nonnull
public final GetSnapshotRequest.Builder snapshot(java.lang.String value,
                                                 java.lang.String... values)

Required -

Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).

• To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
• To get information about any snapshots that are currently running, use _current.

API name: snapshot

Adds one or more values to snapshot.

verbose

@Nonnull
public final GetSnapshotRequest.Builder verbose(@Nullable
                                                java.lang.Boolean value)

If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

API name: verbose

build

@Nonnull
public GetSnapshotRequest build()

Builds a GetSnapshotRequest.

Specified by:

build in interface ObjectBuilder<GetSnapshotRequest>

Throws:

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