Package org.opensearch.client.opensearch.core

Class ReindexRequest

  • All Implemented Interfaces:
    JsonpSerializable
    @JsonpDeserializable
public class ReindexRequest
extends RequestBase
implements JsonpSerializable
    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.

    • Method Detail

      • conflicts

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

      • dest

        @Nullable
public final Destination dest()
        API name: dest

      • maxDocs

        @Nullable
public final java.lang.Long maxDocs()
        API name: max_docs

      • refresh

        @Nullable
public final java.lang.Boolean refresh()
        Should the affected indexes be refreshed?

        API name: refresh

      • requestsPerSecond

        @Nullable
public final java.lang.Long requestsPerSecond()
        The throttle to set on this request in sub-requests per second. -1 means no throttle.

        API name: requests_per_second

      • requireAlias

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

      • script

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

      • scroll

        @Nullable
public final Time scroll()
        Control how long to keep the search context alive

        API name: scroll

      • size

        @Nullable
public final java.lang.Long size()
        API name: size

      • slices

        @Nullable
public final java.lang.Long slices()
        The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to 0 for auto.

        API name: slices

      • source

        @Nullable
public final Source source()
        API name: source

      • timeout

        @Nullable
public final Time timeout()
        Time each individual bulk request should wait for shards that are unavailable.

        API name: timeout

      • waitForActiveShards

        @Nullable
public final WaitForActiveShards waitForActiveShards()
        Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

        API name: wait_for_active_shards

      • waitForCompletion

        @Nullable
public final java.lang.Boolean waitForCompletion()
        Should the request should block until the reindex 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)