Package org.opensearch.client.opensearch._global

Class MgetRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.MgetRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MgetRequest>

Enclosing class:

MgetRequest

public static class MgetRequest.Builder
extends java.lang.Object
implements ObjectBuilder<MgetRequest>

Builder for MgetRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MgetRequest.Builder	addDocs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)	Add a value to docs(List), creating the list if needed.
MgetRequest.Builder	addDocs(Operation value)	Add a value to docs(List), creating the list if needed.
MgetRequest.Builder	addIds(jakarta.json.JsonValue value)	Add a value to ids(List), creating the list if needed.
MgetRequest.Builder	addSourceExcludes(java.lang.String value)	Add a value to sourceExcludes(List), creating the list if needed.
MgetRequest.Builder	addSourceIncludes(java.lang.String value)	Add a value to sourceIncludes(List), creating the list if needed.
MgetRequest.Builder	addStoredFields(java.lang.String value)	Add a value to storedFields(List), creating the list if needed.
MgetRequest	build()	Builds a MgetRequest.
MgetRequest.Builder	docs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)	Set docs(List) to a singleton list.
MgetRequest.Builder	docs(java.util.List<Operation> value)	API name: docs
MgetRequest.Builder	docs(Operation... value)	API name: docs
MgetRequest.Builder	ids(jakarta.json.JsonValue... value)	API name: ids
MgetRequest.Builder	ids(java.util.List<jakarta.json.JsonValue> value)	API name: ids
MgetRequest.Builder	index(java.lang.String value)	API name: index
MgetRequest.Builder	preference(java.lang.String value)	API name: preference
MgetRequest.Builder	realtime(java.lang.Boolean value)	API name: realtime
MgetRequest.Builder	refresh(java.lang.Boolean value)	API name: refresh
MgetRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing
MgetRequest.Builder	source(jakarta.json.JsonValue value)	API name: _source
MgetRequest.Builder	sourceExcludes(java.lang.String... value)	API name: _source_excludes
MgetRequest.Builder	sourceExcludes(java.util.List<java.lang.String> value)	API name: _source_excludes
MgetRequest.Builder	sourceIncludes(java.lang.String... value)	API name: _source_includes
MgetRequest.Builder	sourceIncludes(java.util.List<java.lang.String> value)	API name: _source_includes
MgetRequest.Builder	storedFields(java.lang.String... value)	API name: stored_fields
MgetRequest.Builder	storedFields(java.util.List<java.lang.String> value)	API name: stored_fields
MgetRequest.Builder	type(java.lang.String value)	API name: type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

index

public MgetRequest.Builder index(@Nullable java.lang.String value)

API name: index

type

public MgetRequest.Builder type(@Nullable java.lang.String value)

API name: type

preference

public MgetRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

realtime

public MgetRequest.Builder realtime(@Nullable java.lang.Boolean value)

API name: realtime

refresh

public MgetRequest.Builder refresh(@Nullable java.lang.Boolean value)

API name: refresh

routing

public MgetRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

source

public MgetRequest.Builder source(@Nullable jakarta.json.JsonValue value)

API name: _source

sourceExcludes

public MgetRequest.Builder sourceExcludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_excludes

sourceExcludes

public MgetRequest.Builder sourceExcludes(java.lang.String... value)

API name: _source_excludes

addSourceExcludes

public MgetRequest.Builder addSourceExcludes(java.lang.String value)

Add a value to sourceExcludes(List), creating the list if needed.

sourceIncludes

public MgetRequest.Builder sourceIncludes(@Nullable java.util.List<java.lang.String> value)

API name: _source_includes

sourceIncludes

public MgetRequest.Builder sourceIncludes(java.lang.String... value)

API name: _source_includes

addSourceIncludes

public MgetRequest.Builder addSourceIncludes(java.lang.String value)

Add a value to sourceIncludes(List), creating the list if needed.

storedFields

public MgetRequest.Builder storedFields(@Nullable java.util.List<java.lang.String> value)

API name: stored_fields

storedFields

public MgetRequest.Builder storedFields(java.lang.String... value)

API name: stored_fields

addStoredFields

public MgetRequest.Builder addStoredFields(java.lang.String value)

Add a value to storedFields(List), creating the list if needed.

docs

public MgetRequest.Builder docs(@Nullable java.util.List<Operation> value)

API name: docs

docs

public MgetRequest.Builder docs(Operation... value)

API name: docs

addDocs

public MgetRequest.Builder addDocs(Operation value)

Add a value to docs(List), creating the list if needed.

docs

public MgetRequest.Builder docs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)

Set docs(List) to a singleton list.

addDocs

public MgetRequest.Builder addDocs(java.util.function.Function<Operation.Builder,ObjectBuilder<Operation>> fn)

Add a value to docs(List), creating the list if needed.

ids

public MgetRequest.Builder ids(@Nullable java.util.List<jakarta.json.JsonValue> value)

API name: ids

ids

public MgetRequest.Builder ids(jakarta.json.JsonValue... value)

API name: ids

addIds

public MgetRequest.Builder addIds(jakarta.json.JsonValue value)

Add a value to ids(List), creating the list if needed.

build

public MgetRequest build()

Builds a MgetRequest.

Specified by:

build in interface ObjectBuilder<MgetRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.