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, PlainJsonSerializable, ToCopyableBuilder<CloneSnapshotRequest.Builder,CloneSnapshotRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CloneSnapshotRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CloneSnapshotRequest.Builder,CloneSnapshotRequest>

Creates a clone of all or part of a snapshot in the same repository as the original snapshot.

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 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
protected void	applyQueryParameters(Map<String,String> params)
static CloneSnapshotRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final String	indices()	Required - API name: indices
final Time	masterTimeout()	Deprecated.
static CloneSnapshotRequest	of(Function<CloneSnapshotRequest.Builder,ObjectBuilder<CloneSnapshotRequest>> fn)
final String	repository()	Required - The name of repository which will contain the snapshots clone.
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 name of the original snapshot.
final String	targetSnapshot()	Required - The name of the cloned snapshot.
CloneSnapshotRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

indices

@Nonnull
public final String indices()

Required - API name: indices

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

repository

@Nonnull
public final String repository()

Required - The name of repository which will contain the snapshots clone.

API name: repository

snapshot

@Nonnull
public final String snapshot()

Required - The name of the original snapshot.

API name: snapshot

targetSnapshot

@Nonnull
public final String targetSnapshot()

Required - The name of the cloned snapshot.

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)

toBuilder

@Nonnull
public CloneSnapshotRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CloneSnapshotRequest.Builder,CloneSnapshotRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CloneSnapshotRequest.Builder builder()

setupCloneSnapshotRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object