Package org.opensearch.client.opensearch.snapshot

Class SnapshotStatus.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotStatus.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotStatus

public static class SnapshotStatus.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SnapshotStatus.Builder,SnapshotStatus>

Builder for SnapshotStatus.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotStatus	build()	Builds a SnapshotStatus.
SnapshotStatus.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotStatus.Builder	includeGlobalState(Boolean value)	Whether the snapshot includes the cluster state.
final SnapshotStatus.Builder	indices(String key, Function<SnapshotIndexStats.Builder,ObjectBuilder<SnapshotIndexStats>> fn)	The status of indexes in the snapshot.
final SnapshotStatus.Builder	indices(String key, SnapshotIndexStats value)	The status of indexes in the snapshot.
final SnapshotStatus.Builder	indices(Map<String,SnapshotIndexStats> map)	The status of indexes in the snapshot.
final SnapshotStatus.Builder	repository(String value)	The name of the repository containing the snapshot.
final SnapshotStatus.Builder	shardsStats(Function<SnapshotShardsStats.Builder,ObjectBuilder<SnapshotShardsStats>> fn)	The statistics about snapshot shards.
final SnapshotStatus.Builder	shardsStats(SnapshotShardsStats value)	The statistics about snapshot shards.
final SnapshotStatus.Builder	snapshot(String value)	The name of the snapshot.
final SnapshotStatus.Builder	state(String value)	The current state of the snapshot.
final SnapshotStatus.Builder	stats(Function<SnapshotStats.Builder,ObjectBuilder<SnapshotStats>> fn)	The detailed statistics about the snapshot.
final SnapshotStatus.Builder	stats(SnapshotStats value)	The detailed statistics about the snapshot.
final SnapshotStatus.Builder	uuid(String value)	The unique identifier for the snapshot.

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

Returns:

a new builder instance.

includeGlobalState

@Nonnull
public final SnapshotStatus.Builder includeGlobalState(@Nullable
 Boolean value)

Whether the snapshot includes the cluster state.

API name: include_global_state

indices

@Nonnull
public final SnapshotStatus.Builder indices(Map<String,SnapshotIndexStats> map)

The status of indexes in the snapshot.

API name: indices

Adds all elements of map to indices.

indices

@Nonnull
public final SnapshotStatus.Builder indices(String key,
 SnapshotIndexStats value)

The status of indexes in the snapshot.

API name: indices

Adds an entry to indices.

indices

@Nonnull
public final SnapshotStatus.Builder indices(String key,
 Function<SnapshotIndexStats.Builder,ObjectBuilder<SnapshotIndexStats>> fn)

The status of indexes in the snapshot.

API name: indices

Adds a value to indices using a builder lambda.

repository

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

The name of the repository containing the snapshot.

API name: repository

shardsStats

@Nonnull
public final SnapshotStatus.Builder shardsStats(@Nullable
 SnapshotShardsStats value)

The statistics about snapshot shards.

API name: shards_stats

shardsStats

@Nonnull
public final SnapshotStatus.Builder shardsStats(Function<SnapshotShardsStats.Builder,ObjectBuilder<SnapshotShardsStats>> fn)

The statistics about snapshot shards.

API name: shards_stats

snapshot

@Nonnull
public final SnapshotStatus.Builder snapshot(@Nullable
 String value)

The name of the snapshot.

API name: snapshot

state

@Nonnull
public final SnapshotStatus.Builder state(@Nullable
 String value)

The current state of the snapshot.

API name: state

stats

@Nonnull
public final SnapshotStatus.Builder stats(@Nullable
 SnapshotStats value)

The detailed statistics about the snapshot.

API name: stats

stats

@Nonnull
public final SnapshotStatus.Builder stats(Function<SnapshotStats.Builder,ObjectBuilder<SnapshotStats>> fn)

The detailed statistics about the snapshot.

API name: stats

uuid

@Nonnull
public final SnapshotStatus.Builder uuid(@Nullable
 String value)

The unique identifier for the snapshot.

API name: uuid

build

@Nonnull
public SnapshotStatus build()

Builds a SnapshotStatus.

Specified by:

build in interface ObjectBuilder<SnapshotStatus>

Throws:

NullPointerException - if some of the required fields are null.