Package co.elastic.clients.elasticsearch.indices

Class ShrinkRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.ShrinkRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ShrinkRequest extends RequestBase implements JsonpSerializable
Shrinks an existing index into a new index with fewer primary shards.
See Also:

  • Field Details

  • Method Details

    • of

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

    • aliases

      public final Map<String,Alias> aliases()
      The key is the alias name. Index alias names support date math.

      API name: aliases

    • index

      public final String index()
      Required - Name of the source index to shrink.

      API name: index

    • masterTimeout

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

      API name: master_timeout

    • settings

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

      API name: settings

    • target

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

      API name: target

    • 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

    • 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)

    • setupShrinkRequestDeserializer

      protected static void setupShrinkRequestDeserializer(ObjectDeserializer<ShrinkRequest.Builder> op)