Class ShrinkRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.ShrinkRequest
- All Implemented Interfaces:
JsonpSerializable
Shrinks an existing index into a new index with fewer primary shards.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ShrinkRequest>
Json deserializer forShrinkRequest
static final Endpoint<ShrinkRequest,
ShrinkResponse, ErrorResponse> Endpoint "indices.shrink
". -
Method Summary
Modifier and TypeMethodDescriptionaliases()
The key is the alias name.final String
index()
Required - Name of the source index to shrink.final Time
Period to wait for a connection to the master node.static ShrinkRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) settings()
Configuration options for the target index.protected static void
final String
target()
Required - Name of the target index to create.final Time
timeout()
Period to wait for a response.final WaitForActiveShards
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forShrinkRequest
-
_ENDPOINT
Endpoint "indices.shrink
".
-
-
Method Details
-
of
-
aliases
The key is the alias name. Index alias names support date math.API name:
aliases
-
index
Required - Name of the source index to shrink.API name:
index
-
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
Configuration options for the target index.API name:
settings
-
target
Required - Name of the target index to create.API name:
target
-
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
The number of shard copies that must be active before proceeding with the operation. Set toall
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupShrinkRequestDeserializer
-