Package org.opensearch.client.opensearch.snapshot.restore

Class SnapshotRestore.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.restore.SnapshotRestore.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotRestore

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

Builder for SnapshotRestore.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotRestore	build()	Builds a SnapshotRestore.
SnapshotRestore.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotRestore.Builder	indices(String value, String... values)	Required - The list of indexes that were restored.
final SnapshotRestore.Builder	indices(List<String> list)	Required - The list of indexes that were restored.
final SnapshotRestore.Builder	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - Any statistics about the restored shards.
final SnapshotRestore.Builder	shards(ShardStatistics value)	Required - Any statistics about the restored shards.
final SnapshotRestore.Builder	snapshot(String value)	Required - The name of the snapshot that was restored.

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

Returns:

a new builder instance.

indices

@Nonnull
public final SnapshotRestore.Builder indices(List<String> list)

Required - The list of indexes that were restored.

API name: indices

Adds all elements of list to indices.

indices

@Nonnull
public final SnapshotRestore.Builder indices(String value,
 String... values)

Required - The list of indexes that were restored.

API name: indices

Adds one or more values to indices.

shards

@Nonnull
public final SnapshotRestore.Builder shards(ShardStatistics value)

Required - Any statistics about the restored shards.

API name: shards

shards

@Nonnull
public final SnapshotRestore.Builder shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Required - Any statistics about the restored shards.

API name: shards

snapshot

@Nonnull
public final SnapshotRestore.Builder snapshot(String value)

Required - The name of the snapshot that was restored.

API name: snapshot

build

@Nonnull
public SnapshotRestore build()

Builds a SnapshotRestore.

Specified by:

build in interface ObjectBuilder<SnapshotRestore>

Throws:

NullPointerException - if some of the required fields are null.