Package org.opensearch.client.opensearch.ism

Class ExplainPolicyResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.ExplainPolicyResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

ExplainPolicyResponse

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

Builder for ExplainPolicyResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainPolicyResponse	build()	Builds a ExplainPolicyResponse.
ExplainPolicyResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExplainPolicyResponse.Builder	metadata(String key, Function<ExplainPolicy.Builder,ObjectBuilder<ExplainPolicy>> fn)	Adds a value to metadata using a builder lambda.
final ExplainPolicyResponse.Builder	metadata(String key, ExplainPolicy value)	Adds an entry to metadata.
final ExplainPolicyResponse.Builder	metadata(Map<String,ExplainPolicy> map)	Adds all elements of map to metadata.
final ExplainPolicyResponse.Builder	totalManagedIndices(Number value)	The total number of managed indices.

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

Returns:

a new builder instance.

metadata

@Nonnull
public final ExplainPolicyResponse.Builder metadata(Map<String,ExplainPolicy> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final ExplainPolicyResponse.Builder metadata(String key,
 ExplainPolicy value)

Adds an entry to metadata.

metadata

@Nonnull
public final ExplainPolicyResponse.Builder metadata(String key,
 Function<ExplainPolicy.Builder,ObjectBuilder<ExplainPolicy>> fn)

Adds a value to metadata using a builder lambda.

totalManagedIndices

@Nonnull
public final ExplainPolicyResponse.Builder totalManagedIndices(@Nullable
 Number value)

The total number of managed indices.

API name: total_managed_indices

build

@Nonnull
public ExplainPolicyResponse build()

Builds a ExplainPolicyResponse.

Specified by:

build in interface ObjectBuilder<ExplainPolicyResponse>

Throws:

NullPointerException - if some of the required fields are null.