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

Class Document.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.simulate.Document.Builder

All Implemented Interfaces:

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

Enclosing class:

Document

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

Builder for Document.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Document	build()	Builds a Document.
Document.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Document.Builder	id(String value)	API name: _id
final Document.Builder	index(String value)	API name: _index
final Document.Builder	source(JsonData value)	Required - JSON body for the document.

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

Returns:

a new builder instance.

id

@Nonnull
public final Document.Builder id(@Nullable
 String value)

API name: _id

index

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

API name: _index

source

@Nonnull
public final Document.Builder source(JsonData value)

Required - JSON body for the document.

API name: _source

build

@Nonnull
public Document build()

Builds a Document.

Specified by:

build in interface ObjectBuilder<Document>

Throws:

NullPointerException - if some of the required fields are null.