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
Allow to shrink an existing index into a new index with fewer primary shards.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classShrinkRequest.BuilderBuilder forShrinkRequest.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ShrinkRequest>_DESERIALIZERJson deserializer forShrinkRequeststatic Endpoint<ShrinkRequest,ShrinkResponse,ErrorResponse>_ENDPOINTEndpoint "indices.shrink". -
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,Alias>aliases()API name:aliasesjava.lang.Stringindex()Required - The name of the source index to shrinkTimemasterTimeout()Specify timeout for connection to masterstatic ShrinkRequestof(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)java.util.Map<java.lang.String,JsonData>settings()API name:settingsprotected static voidsetupShrinkRequestDeserializer(ObjectDeserializer<ShrinkRequest.Builder> op)java.lang.Stringtarget()Required - The name of the target index to shrink intoTimetimeout()Explicit operation timeoutWaitForActiveShardswaitForActiveShards()Set the number of active shards to wait for on the shrunken index before the operation returns.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forShrinkRequest -
_ENDPOINT
Endpoint "indices.shrink".
-
-
Method Details
-
of
public static ShrinkRequest of(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn) -
aliases
API name:aliases -
index
public final java.lang.String index()Required - The name of the source index to shrinkAPI name:
index -
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout -
settings
API name:settings -
target
public final java.lang.String target()Required - The name of the target index to shrink intoAPI name:
target -
timeout
Explicit operation timeoutAPI name:
timeout -
waitForActiveShards
Set the number of active shards to wait for on the shrunken index before the operation returns.API name:
wait_for_active_shards -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupShrinkRequestDeserializer
-