Package org.opensearch.client.opensearch.indices

Class CloneIndexRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.CloneIndexRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CloneIndexRequest.Builder,CloneIndexRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class CloneIndexRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<CloneIndexRequest.Builder,CloneIndexRequest>
Clones an index.

  • Field Details

  • Method Details

    • of

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

    • aliases

      @Nonnull public final Map<String,Alias> aliases()
      Aliases for the resulting index.

      API name: aliases

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • index

      @Nonnull public final String index()
      Required - Name of the source index to clone.

      API name: index

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • settings

      @Nonnull public final Map<String,JsonData> settings()
      Configuration options for the target index.

      API name: settings

    • target

      @Nonnull public final String target()
      Required - Name of the target index to create.

      API name: target

    • taskExecutionTimeout

      @Nullable public final Time taskExecutionTimeout()
      Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

      API name: task_execution_timeout

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      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()
      Should this request wait until the operation has completed before returning.

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

    • builder

      @Nonnull public static CloneIndexRequest.Builder builder()

    • setupCloneIndexRequestDeserializer

      protected static void setupCloneIndexRequestDeserializer(ObjectDeserializer<CloneIndexRequest.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