Package org.opensearch.client.opensearch.indices

Class OpenResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.OpenResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

OpenResponse

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

Builder for OpenResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final OpenResponse.Builder	acknowledged(Boolean value)	API name: acknowledged
OpenResponse	build()	Builds a OpenResponse.
OpenResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final OpenResponse.Builder	metadata(String key, JsonData value)	Adds an entry to metadata.
final OpenResponse.Builder	metadata(Map<String,JsonData> map)	Adds all elements of map to metadata.
final OpenResponse.Builder	shardsAcknowledged(Boolean value)	API name: shards_acknowledged
final OpenResponse.Builder	task(String value)	API name: task

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

Returns:

a new builder instance.

acknowledged

@Nonnull
public final OpenResponse.Builder acknowledged(@Nullable
 Boolean value)

API name: acknowledged

metadata

@Nonnull
public final OpenResponse.Builder metadata(Map<String,JsonData> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final OpenResponse.Builder metadata(String key,
 JsonData value)

Adds an entry to metadata.

shardsAcknowledged

@Nonnull
public final OpenResponse.Builder shardsAcknowledged(@Nullable
 Boolean value)

API name: shards_acknowledged

task

@Nonnull
public final OpenResponse.Builder task(@Nullable
 String value)

API name: task

build

@Nonnull
public OpenResponse build()

Builds a OpenResponse.

Specified by:

build in interface ObjectBuilder<OpenResponse>

Throws:

NullPointerException - if some of the required fields are null.