Package org.opensearch.client.opensearch.core.reindex

Class Source.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.reindex.Source.Builder

All Implemented Interfaces:

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

Enclosing class:

Source

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

Builder for Source.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Source	build()	Builds a Source.
Source.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Source.Builder	index(String value, String... values)	Required - API name: index
final Source.Builder	index(List<String> list)	Required - API name: index
final Source.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final Source.Builder	query(Query value)	API name: query
final Source.Builder	remote(Function<RemoteSource.Builder,ObjectBuilder<RemoteSource>> fn)	API name: remote
final Source.Builder	remote(RemoteSource value)	API name: remote
final Source.Builder	size(Integer value)	The number of documents to index per batch.
final Source.Builder	slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)	API name: slice
final Source.Builder	slice(SlicedScroll value)	API name: slice
final Source.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final Source.Builder	sort(List<SortOptions> list)	API name: sort
final Source.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final Source.Builder	sourceFields(String value, String... values)	API name: _source
final Source.Builder	sourceFields(List<String> list)	API name: _source

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

Returns:

a new builder instance.

index

@Nonnull
public final Source.Builder index(List<String> list)

Required - API name: index

Adds all elements of list to index.

index

@Nonnull
public final Source.Builder index(String value,
 String... values)

Required - API name: index

Adds one or more values to index.

query

@Nonnull
public final Source.Builder query(@Nullable
 Query value)

API name: query

query

@Nonnull
public final Source.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: query

remote

@Nonnull
public final Source.Builder remote(@Nullable
 RemoteSource value)

API name: remote

remote

@Nonnull
public final Source.Builder remote(Function<RemoteSource.Builder,ObjectBuilder<RemoteSource>> fn)

API name: remote

size

@Nonnull
public final Source.Builder size(@Nullable
 Integer value)

The number of documents to index per batch. Use the size setting when indexing from a remote cluster. This ensures that batches fit in the on-heap buffer. The buffer defaults to a maximum size of 100MB.

API name: size

slice

@Nonnull
public final Source.Builder slice(@Nullable
 SlicedScroll value)

API name: slice

slice

@Nonnull
public final Source.Builder slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)

API name: slice

sort

@Nonnull
public final Source.Builder sort(List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

@Nonnull
public final Source.Builder sort(SortOptions value,
 SortOptions... values)

API name: sort

Adds one or more values to sort.

sort

@Nonnull
public final Source.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

sourceFields

@Nonnull
public final Source.Builder sourceFields(List<String> list)

API name: _source

Adds all elements of list to sourceFields.

sourceFields

@Nonnull
public final Source.Builder sourceFields(String value,
 String... values)

API name: _source

Adds one or more values to sourceFields.

build

@Nonnull
public Source build()

Builds a Source.

Specified by:

build in interface ObjectBuilder<Source>

Throws:

NullPointerException - if some of the required fields are null.