Package co.elastic.clients.elasticsearch.indices

Class CloneIndexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.CloneIndexRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class CloneIndexRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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

Constructor Summary

Constructors

Constructor	Description
CloneIndexRequest(CloneIndexRequest.Builder builder)
CloneIndexRequest(java.util.function.Function<CloneIndexRequest.Builder,CloneIndexRequest.Builder> fn)

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
java.lang.String	masterTimeout()	Specify timeout for connection to master
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(DelegatingDeserializer<CloneIndexRequest.Builder> op)
java.lang.String	target()	Required - The name of the target index to clone into
java.lang.String	timeout()	Explicit operation timeout
jakarta.json.JsonValue	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,ElasticsearchError> ENDPOINT

Endpoint "indices.clone".

Constructor Details

CloneIndexRequest

public CloneIndexRequest(CloneIndexRequest.Builder builder)

CloneIndexRequest

public CloneIndexRequest(java.util.function.Function<CloneIndexRequest.Builder,CloneIndexRequest.Builder> fn)

Method Details

index

public java.lang.String index()

Required - The name of the source index to clone

API name: index

target

public java.lang.String target()

Required - The name of the target index to clone into

API name: target

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout

timeout

@Nullable
public java.lang.String timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public jakarta.json.JsonValue waitForActiveShards()

Set the number of active shards to wait for on the cloned index before the operation returns.

API name: wait_for_active_shards

aliases

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

API name: aliases

settings

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

API name: settings

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(DelegatingDeserializer<CloneIndexRequest.Builder> op)