Package org.opensearch.client.opensearch.ism

Class AddPolicyRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ism.AddPolicyRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AddPolicyRequest

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

Builder for AddPolicyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddPolicyRequest	build()	Builds a AddPolicyRequest.
AddPolicyRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AddPolicyRequest.Builder	index(String value)	API name: index
final AddPolicyRequest.Builder	policyId(String value)	Required - The ID of the policy to add.
protected AddPolicyRequest.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 AddPolicyRequest.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<AddPolicyRequest.Builder,AddPolicyRequest>

Returns:

a new builder instance.

self

@Nonnull
protected AddPolicyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AddPolicyRequest.Builder>

index

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

API name: index

policyId

@Nonnull
public final AddPolicyRequest.Builder policyId(String value)

Required - The ID of the policy to add.

API name: policy_id

build

@Nonnull
public AddPolicyRequest build()

Builds a AddPolicyRequest.

Specified by:

build in interface ObjectBuilder<AddPolicyRequest>

Throws:

NullPointerException - if some of the required fields are null.