Package org.opensearch.client.opensearch.snapshot

Class CloneSnapshotRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.CloneSnapshotRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CloneSnapshotRequest
extends RequestBase
implements JsonpSerializable

Clones indices from one snapshot into another snapshot in the same repository.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Explicit operation timeout for connection to cluster-manager node
java.lang.String	indices()	Required - API name: indices
Time	masterTimeout()	Explicit operation timeout for connection to master node
static CloneSnapshotRequest	of(java.util.function.Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)
java.lang.String	repository()	Required - A repository name
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)
java.lang.String	snapshot()	Required - The name of the snapshot to clone from
java.lang.String	targetSnapshot()	Required - The name of the cloned snapshot to create
Time	timeout()	API name: timeout

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<CloneSnapshotRequest> _DESERIALIZER

Json deserializer for CloneSnapshotRequest

_ENDPOINT

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

Endpoint "snapshot.clone".

Method Detail

of

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

indices

public final java.lang.String indices()

Required - API name: indices

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

repository

public final java.lang.String repository()

Required - A repository name

API name: repository

snapshot

public final java.lang.String snapshot()

Required - The name of the snapshot to clone from

API name: snapshot

targetSnapshot

public final java.lang.String targetSnapshot()

Required - The name of the cloned snapshot to create

API name: target_snapshot

timeout

@Nullable
public final Time timeout()

API name: timeout

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)