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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<CloneSnapshotRequest> Json deserializer forCloneSnapshotRequeststatic final Endpoint<CloneSnapshotRequest, CloneSnapshotResponse, ErrorResponse> Endpoint "snapshot.clone". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) static CloneSnapshotRequest.Builderbuilder()final TimeThe amount of time to wait for a response from the cluster manager node.booleaninthashCode()final Stringindices()Required - API name:indicesfinal TimeDeprecated.static CloneSnapshotRequestfinal StringRequired - The name of repository which will contain the snapshots clone.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal Stringsnapshot()Required - The name of the original snapshot.final StringRequired - The name of the cloned snapshot.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forCloneSnapshotRequest -
_ENDPOINT
Endpoint "snapshot.clone".
-
-
Method Details
-
of
public static CloneSnapshotRequest of(Function<CloneSnapshotRequest.Builder, ObjectBuilder<CloneSnapshotRequest>> fn) -
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
Required - API name:indices -
masterTimeout
Deprecated.Explicit operation timeout for connection to cluster-manager nodeAPI name:
master_timeout -
repository
Required - The name of repository which will contain the snapshots clone.API name:
repository -
snapshot
Required - The name of the original snapshot.API name:
snapshot -
targetSnapshot
Required - The name of the cloned snapshot.API name:
target_snapshot -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CloneSnapshotRequest.Builder,CloneSnapshotRequest> - Returns:
- a new builder instance.
-
builder
-
setupCloneSnapshotRequestDeserializer
protected static void setupCloneSnapshotRequestDeserializer(ObjectDeserializer<CloneSnapshotRequest.Builder> op) -
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-