Package org.opensearch.client.opensearch.ism

Class ActionSnapshot.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.ActionSnapshot.Builder

All Implemented Interfaces:

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

Enclosing class:

ActionSnapshot

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

Builder for ActionSnapshot.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ActionSnapshot	build()	Builds a ActionSnapshot.
ActionSnapshot.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ActionSnapshot.Builder	includeGlobalState(Boolean value)	Whether to include the global state in the snapshot.
final ActionSnapshot.Builder	repository(String value)	The repository to store the snapshot.
final ActionSnapshot.Builder	snapshot(String value)	The name of 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 ActionSnapshot.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<ActionSnapshot.Builder,ActionSnapshot>

Returns:

a new builder instance.

includeGlobalState

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

Whether to include the global state in the snapshot.

API name: include_global_state

repository

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

The repository to store the snapshot.

API name: repository

snapshot

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

The name of the snapshot.

API name: snapshot

build

@Nonnull
public ActionSnapshot build()

Builds a ActionSnapshot.

Specified by:

build in interface ObjectBuilder<ActionSnapshot>

Throws:

NullPointerException - if some of the required fields are null.