Class CloneIndexRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.CloneIndexRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class CloneIndexRequest
extends RequestBase
implements JsonpSerializable
Clones an existing index.
- 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<CloneIndexRequest>
Json deserializer forCloneIndexRequest
static final Endpoint<CloneIndexRequest,
CloneIndexResponse, ErrorResponse> Endpoint "indices.clone
". -
Method Summary
Modifier and TypeMethodDescriptionaliases()
Aliases for the resulting index.final String
index()
Required - Name of the source index to clone.final Time
Period to wait for a connection to the master node.static CloneIndexRequest
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 forCloneIndexRequest
-
_ENDPOINT
Endpoint "indices.clone
".
-
-
Method Details
-
of
public static CloneIndexRequest of(Function<CloneIndexRequest.Builder, ObjectBuilder<CloneIndexRequest>> fn) -
aliases
Aliases for the resulting index.API name:
aliases
-
index
Required - Name of the source index to clone.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
-
setupCloneIndexRequestDeserializer
protected static void setupCloneIndexRequestDeserializer(ObjectDeserializer<CloneIndexRequest.Builder> op)
-