Package org.opensearch.client.opensearch.security

Class PatchOperation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.security.PatchOperation.Builder

All Implemented Interfaces:

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

Enclosing class:

PatchOperation

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

Builder for PatchOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PatchOperation	build()	Builds a PatchOperation.
PatchOperation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PatchOperation.Builder	op(String value)	Required - The operation to perform, such as remove, add, replace, move, copy, or test.
final PatchOperation.Builder	path(String value)	Required - The path to the resource.
final PatchOperation.Builder	value(JsonData value)	The new values used for the update.

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

Returns:

a new builder instance.

op

@Nonnull
public final PatchOperation.Builder op(String value)

Required - The operation to perform, such as remove, add, replace, move, copy, or test.

API name: op

path

@Nonnull
public final PatchOperation.Builder path(String value)

Required - The path to the resource.

API name: path

value

@Nonnull
public final PatchOperation.Builder value(@Nullable
 JsonData value)

The new values used for the update.

API name: value

build

@Nonnull
public PatchOperation build()

Builds a PatchOperation.

Specified by:

build in interface ObjectBuilder<PatchOperation>

Throws:

NullPointerException - if some of the required fields are null.