Package org.opensearch.client.opensearch.ingest.simulate

Class DocumentSimulation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.simulate.DocumentSimulation.Builder

All Implemented Interfaces:

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

Enclosing class:

DocumentSimulation

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

Builder for DocumentSimulation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DocumentSimulation	build()	Builds a DocumentSimulation.
DocumentSimulation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DocumentSimulation.Builder	id(String value)	Required - API name: _id
final DocumentSimulation.Builder	index(String value)	Required - API name: _index
final DocumentSimulation.Builder	ingest(Function<Ingest.Builder,ObjectBuilder<Ingest>> fn)	Required - API name: _ingest
final DocumentSimulation.Builder	ingest(Ingest value)	Required - API name: _ingest
final DocumentSimulation.Builder	routing(String value)	Value used to send the document to a specific primary shard.
final DocumentSimulation.Builder	source(String key, JsonData value)	Required - JSON body for the document.
final DocumentSimulation.Builder	source(Map<String,JsonData> map)	Required - JSON body for the document.
final DocumentSimulation.Builder	version(Long value)	API name: _version
final DocumentSimulation.Builder	versionType(VersionType value)	API name: _version_type

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

Returns:

a new builder instance.

id

@Nonnull
public final DocumentSimulation.Builder id(String value)

Required - API name: _id

index

@Nonnull
public final DocumentSimulation.Builder index(String value)

Required - API name: _index

ingest

@Nonnull
public final DocumentSimulation.Builder ingest(Ingest value)

Required - API name: _ingest

ingest

@Nonnull
public final DocumentSimulation.Builder ingest(Function<Ingest.Builder,ObjectBuilder<Ingest>> fn)

Required - API name: _ingest

routing

@Nonnull
public final DocumentSimulation.Builder routing(@Nullable
 String value)

Value used to send the document to a specific primary shard.

API name: _routing

source

@Nonnull
public final DocumentSimulation.Builder source(Map<String,JsonData> map)

Required - JSON body for the document.

API name: _source

Adds all elements of map to source.

source

@Nonnull
public final DocumentSimulation.Builder source(String key,
 JsonData value)

Required - JSON body for the document.

API name: _source

Adds an entry to source.

version

@Nonnull
public final DocumentSimulation.Builder version(@Nullable
 Long value)

API name: _version

versionType

@Nonnull
public final DocumentSimulation.Builder versionType(@Nullable
 VersionType value)

API name: _version_type

build

@Nonnull
public DocumentSimulation build()

Builds a DocumentSimulation.

Specified by:

build in interface ObjectBuilder<DocumentSimulation>

Throws:

NullPointerException - if some of the required fields are null.