Package org.opensearch.client.opensearch.ism

Class ExplainPolicyRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ExplainPolicyRequest.Builder>

org.opensearch.client.opensearch.ism.ExplainPolicyRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ExplainPolicyRequest

public static class ExplainPolicyRequest.Builder
extends RequestBase.AbstractBuilder<ExplainPolicyRequest.Builder>
implements CopyableBuilder<ExplainPolicyRequest.Builder,ExplainPolicyRequest>

Builder for ExplainPolicyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ExplainPolicyRequest.Builder	body(JsonData value)	Required - Request body.
ExplainPolicyRequest	build()	Builds a ExplainPolicyRequest.
ExplainPolicyRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExplainPolicyRequest.Builder	index(String value)	API name: index
protected ExplainPolicyRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected ExplainPolicyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExplainPolicyRequest.Builder>

body

@Nonnull
public final ExplainPolicyRequest.Builder body(JsonData value)

Required - Request body.

index

@Nonnull
public final ExplainPolicyRequest.Builder index(@Nullable
 String value)

API name: index

build

@Nonnull
public ExplainPolicyRequest build()

Builds a ExplainPolicyRequest.

Specified by:

build in interface ObjectBuilder<ExplainPolicyRequest>

Throws:

NullPointerException - if some of the required fields are null.