Package org.opensearch.client.opensearch.indices

Class IngestionSource.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IngestionSource.Builder

All Implemented Interfaces:

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

Enclosing class:

IngestionSource

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

Builder for IngestionSource.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IngestionSource.Builder	allActive(Boolean value)	Indicates if all-active ingestion is enabled for this index.
IngestionSource	build()	Builds a IngestionSource.
IngestionSource.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IngestionSource.Builder	errorStrategy(ErrorPolicy value)	Defines the policy for error handling.
final IngestionSource.Builder	internalQueueSize(Integer value)	Defines the size of the internal blocking queue in pull-based ingestion.
final IngestionSource.Builder	numProcessorThreads(Integer value)	Defines the number of processor or writer threads.
final IngestionSource.Builder	param(String key, JsonData value)	Custom parameters for the ingestion source.
final IngestionSource.Builder	param(Map<String,JsonData> map)	Custom parameters for the ingestion source.
final IngestionSource.Builder	pointer(Function<IngestionSourcePointer.Builder,ObjectBuilder<IngestionSourcePointer>> fn)	API name: pointer
final IngestionSource.Builder	pointer(IngestionSourcePointer value)	API name: pointer
final IngestionSource.Builder	pointerInitReset(IngestionSourcePointerInitReset value)	API name: pointer.init.reset
final IngestionSource.Builder	pointerInitResetValue(String value)	Specifies the offset value or timestamp in milliseconds.
final IngestionSource.Builder	poll(Function<IngestionSourcePoll.Builder,ObjectBuilder<IngestionSourcePoll>> fn)	API name: poll
final IngestionSource.Builder	poll(IngestionSourcePoll value)	API name: poll
final IngestionSource.Builder	pollMaxBatchSize(Long value)	The maximum number of records to retrieve in each poll operation.
final IngestionSource.Builder	pollTimeout(Integer value)	Determines the Poll timeout value.
final IngestionSource.Builder	type(IngestionSourceType value)	The streaming source 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 IngestionSource.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<IngestionSource.Builder,IngestionSource>

Returns:

a new builder instance.

allActive

@Nonnull
public final IngestionSource.Builder allActive(@Nullable
 Boolean value)

Indicates if all-active ingestion is enabled for this index.

API name: all_active

errorStrategy

@Nonnull
public final IngestionSource.Builder errorStrategy(@Nullable
 ErrorPolicy value)

Defines the policy for error handling.

API name: error_strategy

internalQueueSize

@Nonnull
public final IngestionSource.Builder internalQueueSize(@Nullable
 Integer value)

Defines the size of the internal blocking queue in pull-based ingestion.

API name: internal_queue_size

numProcessorThreads

@Nonnull
public final IngestionSource.Builder numProcessorThreads(@Nullable
 Integer value)

Defines the number of processor or writer threads.

API name: num_processor_threads

param

@Nonnull
public final IngestionSource.Builder param(Map<String,JsonData> map)

Custom parameters for the ingestion source.

API name: param

Adds all elements of map to param.

param

@Nonnull
public final IngestionSource.Builder param(String key,
 JsonData value)

Custom parameters for the ingestion source.

API name: param

Adds an entry to param.

pointer

@Nonnull
public final IngestionSource.Builder pointer(@Nullable
 IngestionSourcePointer value)

API name: pointer

pointer

@Nonnull
public final IngestionSource.Builder pointer(Function<IngestionSourcePointer.Builder,ObjectBuilder<IngestionSourcePointer>> fn)

API name: pointer

pointerInitReset

@Nonnull
public final IngestionSource.Builder pointerInitReset(@Nullable
 IngestionSourcePointerInitReset value)

API name: pointer.init.reset

pointerInitResetValue

@Nonnull
public final IngestionSource.Builder pointerInitResetValue(@Nullable
 String value)

Specifies the offset value or timestamp in milliseconds.

API name: pointer.init.reset.value

poll

@Nonnull
public final IngestionSource.Builder poll(@Nullable
 IngestionSourcePoll value)

API name: poll

poll

@Nonnull
public final IngestionSource.Builder poll(Function<IngestionSourcePoll.Builder,ObjectBuilder<IngestionSourcePoll>> fn)

API name: poll

pollMaxBatchSize

@Nonnull
public final IngestionSource.Builder pollMaxBatchSize(@Nullable
 Long value)

The maximum number of records to retrieve in each poll operation.

API name: poll.max_batch_size

pollTimeout

@Nonnull
public final IngestionSource.Builder pollTimeout(@Nullable
 Integer value)

Determines the Poll timeout value.

API name: poll.timeout

type

@Nonnull
public final IngestionSource.Builder type(@Nullable
 IngestionSourceType value)

The streaming source type.

API name: type

build

@Nonnull
public IngestionSource build()

Builds a IngestionSource.

Specified by:

build in interface ObjectBuilder<IngestionSource>

Throws:

NullPointerException - if some of the required fields are null.