Package org.opensearch.client.opensearch.indices

Class ShrinkRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShrinkRequest.Builder	Builder for ShrinkRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ShrinkRequest>	_DESERIALIZER	Json deserializer for ShrinkRequest
static Endpoint<ShrinkRequest,ShrinkResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.shrink".

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Alias>	aliases()	API name: aliases
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
java.lang.String	index()	Required - The name of the source index to shrink
Time	masterTimeout()	Deprecated.
static ShrinkRequest	of(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.Map<java.lang.String,JsonData>	settings()	API name: settings
protected static void	setupShrinkRequestDeserializer(ObjectDeserializer<ShrinkRequest.Builder> op)
java.lang.String	target()	Required - The name of the target index to shrink into
Time	timeout()	Explicit operation timeout
WaitForActiveShards	waitForActiveShards()	Set the number of active shards to wait for on the shrunken index before the operation returns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ShrinkRequest> _DESERIALIZER

Json deserializer for ShrinkRequest

_ENDPOINT

public static final Endpoint<ShrinkRequest,ShrinkResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.shrink".

Method Detail

of

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

aliases

public final java.util.Map<java.lang.String,Alias> aliases()

API name: aliases

index

public final java.lang.String index()

Required - The name of the source index to shrink

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

settings

public final java.util.Map<java.lang.String,JsonData> settings()

API name: settings

target

public final java.lang.String target()

Required - The name of the target index to shrink into

API name: target

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public final WaitForActiveShards 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

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)