Package org.opensearch.client.opensearch.snapshot

Class CreateSnapshotResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.CreateSnapshotResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

CreateSnapshotResponse

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

Builder for CreateSnapshotResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

accepted

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

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

API name: accepted

snapshot

@Nonnull
public final CreateSnapshotResponse.Builder snapshot(@Nullable
 SnapshotInfo value)

API name: snapshot

snapshot

@Nonnull
public final CreateSnapshotResponse.Builder snapshot(Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)

API name: snapshot

build

@Nonnull
public CreateSnapshotResponse build()

Builds a CreateSnapshotResponse.

Specified by:

build in interface ObjectBuilder<CreateSnapshotResponse>

Throws:

NullPointerException - if some of the required fields are null.