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

@JsonpDeserializable
public class CloneIndexRequest
extends RequestBase
implements JsonpSerializable

Clones an index

Nested Class Summary

Nested Classes

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

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<CloneIndexRequest>	_DESERIALIZER	Json deserializer for CloneIndexRequest
static Endpoint<CloneIndexRequest,CloneIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.clone".

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Alias>	aliases()	API name: aliases
java.lang.String	index()	Required - The name of the source index to clone
Time	masterTimeout()	Specify timeout for connection to master
static CloneIndexRequest	of(java.util.function.Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> 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	setupCloneIndexRequestDeserializer(ObjectDeserializer<CloneIndexRequest.Builder> op)
java.lang.String	target()	Required - The name of the target index to clone into
Time	timeout()	Explicit operation timeout
WaitForActiveShards	waitForActiveShards()	Set the number of active shards to wait for on the cloned index before the operation returns.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CloneIndexRequest> _DESERIALIZER

Json deserializer for CloneIndexRequest

_ENDPOINT

public static final Endpoint<CloneIndexRequest,CloneIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.clone".

Method Details

of

public static CloneIndexRequest of(java.util.function.Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> 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 clone

API name: index

masterTimeout

@Nullable public final Time masterTimeout()

Specify timeout for connection to master

API name: master_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 clone 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 cloned 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)

setupCloneIndexRequestDeserializer

protected static void setupCloneIndexRequestDeserializer(ObjectDeserializer<CloneIndexRequest.Builder> op)