Package org.opensearch.client.opensearch.core

Class ReindexRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.ReindexRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ReindexRequest.Builder,ReindexRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class ReindexRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<ReindexRequest.Builder,ReindexRequest>
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

  • Field Details

  • Method Details

    • of

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

    • conflicts

      @Nullable public final Conflicts conflicts()
      API name: conflicts

    • dest

      @Nonnull public final Destination dest()
      Required - API name: dest

    • maxDocs

      @Nullable public final Integer maxDocs()
      The maximum number of documents to reindex.

      API name: max_docs

    • refresh

      @Nullable public final Refresh refresh()
      If true, the request refreshes affected shards to make this operation visible to search.

      API name: refresh

    • requestsPerSecond

      @Nullable public final Float requestsPerSecond()
      The throttle for this request in sub-requests per second. Defaults to no throttle.

      API name: requests_per_second

    • requireAlias

      @Nullable public final Boolean requireAlias()
      API name: require_alias

    • script

      @Nullable public final Script script()
      API name: script

    • scroll

      @Nullable public final Time scroll()
      Specifies how long a consistent view of the index should be maintained for scrolled search.

      API name: scroll

    • size

      @Nullable public final Integer size()
      API name: size

    • slices

      @Nullable public final Slices slices()
      The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.

      API name: slices

    • source

      @Nonnull public final Source source()
      Required - API name: source

    • timeout

      @Nullable public final Time timeout()
      Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.

      API name: timeout

    • waitForActiveShards

      @Nullable public final WaitForActiveShards waitForActiveShards()
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      API name: wait_for_active_shards

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      If true, the request blocks until the operation is complete.

      API name: wait_for_completion

    • 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 ReindexRequest.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<ReindexRequest.Builder,ReindexRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ReindexRequest.Builder builder()

    • setupReindexRequestDeserializer

      protected static void setupReindexRequestDeserializer(ObjectDeserializer<ReindexRequest.Builder> op)

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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