Package co.elastic.clients.elasticsearch.snapshot

Class CloneSnapshotRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.CloneSnapshotRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CloneSnapshotRequest
extends RequestBase
implements JsonpSerializable

Clone a snapshot. Clone part of all of a snapshot into another snapshot in the same repository.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<CloneSnapshotRequest>	_DESERIALIZER	Json deserializer for CloneSnapshotRequest
static final Endpoint<CloneSnapshotRequest,CloneSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.clone".

Method Summary

Modifier and Type	Method	Description
final String	indices()	Required - A comma-separated list of indices to include in the snapshot.
final Time	masterTimeout()	The period to wait for the master node.
static CloneSnapshotRequest	of(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)
final String	repository()	Required - The name of the snapshot repository that both source and target snapshot belong to.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCloneSnapshotRequestDeserializer(ObjectDeserializer<CloneSnapshotRequest.Builder> op)
final String	snapshot()	Required - The source snapshot name.
final String	targetSnapshot()	Required - The target snapshot name.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CloneSnapshotRequest> _DESERIALIZER

Json deserializer for CloneSnapshotRequest

_ENDPOINT

public static final Endpoint<CloneSnapshotRequest,CloneSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.clone".

Method Details

of

public static CloneSnapshotRequest of(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)

indices

public final String indices()

Required - A comma-separated list of indices to include in the snapshot. Multi-target syntax is supported.

API name: indices

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

repository

public final String repository()

Required - The name of the snapshot repository that both source and target snapshot belong to.

API name: repository

snapshot

public final String snapshot()

Required - The source snapshot name.

API name: snapshot

targetSnapshot

public final String targetSnapshot()

Required - The target snapshot name.

API name: target_snapshot

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)

setupCloneSnapshotRequestDeserializer

protected static void setupCloneSnapshotRequestDeserializer(ObjectDeserializer<CloneSnapshotRequest.Builder> op)