Package org.opensearch.client.opensearch.snapshot

Class RestoreRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.RestoreRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RestoreRequest
extends RequestBase
implements JsonpSerializable

Restores a snapshot.

Nested Class Summary

Nested Classes

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

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<RestoreRequest>	_DESERIALIZER	Json deserializer for RestoreRequest
static Endpoint<RestoreRequest,RestoreResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.restore".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Explicit operation timeout for connection to cluster-manager node
java.util.List<java.lang.String>	ignoreIndexSettings()	API name: ignore_index_settings
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.lang.Boolean	includeAliases()	API name: include_aliases
java.lang.Boolean	includeGlobalState()	API name: include_global_state
PutIndicesSettingsRequest	indexSettings()	API name: index_settings
java.util.List<java.lang.String>	indices()	API name: indices
Time	masterTimeout()	Deprecated.
static RestoreRequest	of(java.util.function.Function<RestoreRequest.Builder,ObjectBuilder<RestoreRequest>> fn)
java.lang.Boolean	partial()	API name: partial
java.lang.String	renamePattern()	API name: rename_pattern
java.lang.String	renameReplacement()	API name: rename_replacement
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	setupRestoreRequestDeserializer(ObjectDeserializer<RestoreRequest.Builder> op)
java.lang.String	snapshot()	Required - A snapshot name
java.lang.Boolean	waitForCompletion()	Should this request wait until the operation has completed before returning

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

Json deserializer for RestoreRequest

_ENDPOINT

public static final Endpoint<RestoreRequest,RestoreResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.restore".

Method Detail

of

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

ignoreIndexSettings

public final java.util.List<java.lang.String> ignoreIndexSettings()

API name: ignore_index_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

includeAliases

@Nullable
public final java.lang.Boolean includeAliases()

API name: include_aliases

includeGlobalState

@Nullable
public final java.lang.Boolean includeGlobalState()

API name: include_global_state

indexSettings

@Nullable
public final PutIndicesSettingsRequest indexSettings()

API name: index_settings

indices

public final java.util.List<java.lang.String> indices()

API name: indices

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

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

partial

@Nullable
public final java.lang.Boolean partial()

API name: partial

renamePattern

@Nullable
public final java.lang.String renamePattern()

API name: rename_pattern

renameReplacement

@Nullable
public final java.lang.String renameReplacement()

API name: rename_replacement

repository

public final java.lang.String repository()

Required - A repository name

API name: repository

snapshot

public final java.lang.String snapshot()

Required - A snapshot name

API name: snapshot

waitForCompletion

@Nullable
public final java.lang.Boolean waitForCompletion()

Should this request wait until the operation has completed before returning

API name: wait_for_completion

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)

setupRestoreRequestDeserializer

protected static void setupRestoreRequestDeserializer(ObjectDeserializer<RestoreRequest.Builder> op)