Package org.opensearch.client.opensearch.indices

Class IngestionSource

java.lang.Object
org.opensearch.client.opensearch.indices.IngestionSource
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<IngestionSource.Builder,IngestionSource>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class IngestionSource extends Object implements PlainJsonSerializable, ToCopyableBuilder<IngestionSource.Builder,IngestionSource>
The pull-based ingestion settings controlling how data is read from streaming sources.

  • Field Details

  • Method Details

    • of

      public static IngestionSource of(Function<IngestionSource.Builder,ObjectBuilder<IngestionSource>> fn)

    • allActive

      @Nullable public final Boolean allActive()
      Indicates if all-active ingestion is enabled for this index.

      API name: all_active

    • errorStrategy

      @Nullable public final ErrorPolicy errorStrategy()
      Defines the policy for error handling.

      API name: error_strategy

    • internalQueueSize

      @Nullable public final Integer internalQueueSize()
      Defines the size of the internal blocking queue in pull-based ingestion.

      API name: internal_queue_size

    • numProcessorThreads

      @Nullable public final Integer numProcessorThreads()
      Defines the number of processor or writer threads.

      API name: num_processor_threads

    • param

      @Nonnull public final Map<String,JsonData> param()
      Custom parameters for the ingestion source.

      API name: param

    • pointer

      @Nullable public final IngestionSourcePointer pointer()
      API name: pointer

    • pointerInitReset

      @Nullable public final IngestionSourcePointerInitReset pointerInitReset()
      API name: pointer.init.reset

    • pointerInitResetValue

      @Nullable public final String pointerInitResetValue()
      Specifies the offset value or timestamp in milliseconds.

      API name: pointer.init.reset.value

    • poll

      @Nullable public final IngestionSourcePoll poll()
      API name: poll

    • pollMaxBatchSize

      @Nullable public final Long pollMaxBatchSize()
      The maximum number of records to retrieve in each poll operation.

      API name: poll.max_batch_size

    • pollTimeout

      @Nullable public final Integer pollTimeout()
      Determines the Poll timeout value.

      API name: poll.timeout

    • type

      @Nullable public final IngestionSourceType type()
      The streaming source type.

      API name: type

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public IngestionSource.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IngestionSource.Builder,IngestionSource>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static IngestionSource.Builder builder()

    • setupIngestionSourceDeserializer

      protected static void setupIngestionSourceDeserializer(ObjectDeserializer<IngestionSource.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object