Package org.opensearch.client.opensearch.snapshot

Class RestoreSnapshotResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.RestoreSnapshotResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

RestoreSnapshotResponse

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

Builder for RestoreSnapshotResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RestoreSnapshotResponse.Builder	accepted(Boolean value)	Returns true if the restore was accepted.
RestoreSnapshotResponse	build()	Builds a RestoreSnapshotResponse.
RestoreSnapshotResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RestoreSnapshotResponse.Builder	snapshot(Function<SnapshotRestore.Builder,ObjectBuilder<SnapshotRestore>> fn)	API name: snapshot
final RestoreSnapshotResponse.Builder	snapshot(SnapshotRestore value)	API name: 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 RestoreSnapshotResponse.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<RestoreSnapshotResponse.Builder,RestoreSnapshotResponse>

Returns:

a new builder instance.

accepted

@Nonnull
public final RestoreSnapshotResponse.Builder accepted(@Nullable
 Boolean value)

Returns true if the restore was accepted. Present when the request had wait_for_completion set to false.

API name: accepted

snapshot

@Nonnull
public final RestoreSnapshotResponse.Builder snapshot(@Nullable
 SnapshotRestore value)

API name: snapshot

snapshot

@Nonnull
public final RestoreSnapshotResponse.Builder snapshot(Function<SnapshotRestore.Builder,ObjectBuilder<SnapshotRestore>> fn)

API name: snapshot

build

@Nonnull
public RestoreSnapshotResponse build()

Builds a RestoreSnapshotResponse.

Specified by:

build in interface ObjectBuilder<RestoreSnapshotResponse>

Throws:

NullPointerException - if some of the required fields are null.