Package org.opensearch.client.opensearch.ism

Class ExplainPolicy.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.ExplainPolicy.Builder

All Implemented Interfaces:

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

Enclosing class:

ExplainPolicy

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

Builder for ExplainPolicy.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainPolicy	build()	Builds a ExplainPolicy.
ExplainPolicy.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExplainPolicy.Builder	enabled(Boolean value)	Whether the policy is enabled for the index.
final ExplainPolicy.Builder	indexOpendistroIndexStateManagementPolicyId(String value)	The ID of the OpenDistro policy applied to the index.
final ExplainPolicy.Builder	indexPluginsIndexStateManagementPolicyId(String value)	The ID of the policy applied to the index.

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

Returns:

a new builder instance.

enabled

@Nonnull
public final ExplainPolicy.Builder enabled(@Nullable
 Boolean value)

Whether the policy is enabled for the index.

API name: enabled

indexOpendistroIndexStateManagementPolicyId

@Nonnull
public final ExplainPolicy.Builder indexOpendistroIndexStateManagementPolicyId(@Nullable
 String value)

The ID of the OpenDistro policy applied to the index.

API name: index.opendistro.index_state_management.policy_id

indexPluginsIndexStateManagementPolicyId

@Nonnull
public final ExplainPolicy.Builder indexPluginsIndexStateManagementPolicyId(@Nullable
 String value)

The ID of the policy applied to the index.

API name: index.plugins.index_state_management.policy_id

build

@Nonnull
public ExplainPolicy build()

Builds a ExplainPolicy.

Specified by:

build in interface ObjectBuilder<ExplainPolicy>

Throws:

NullPointerException - if some of the required fields are null.