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:

ToJsonp

public final class RestoreRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RestoreRequest>	DESERIALIZER	Json deserializer for RestoreRequest
static Endpoint<RestoreRequest,RestoreResponse,OpenSearchError>	ENDPOINT	Endpoint "snapshot.restore".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestoreRequest(RestoreRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
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
jakarta.json.JsonValue	indexSettings()	API name: index_settings
java.util.List<java.lang.String>	indices()	API name: indices
jakarta.json.JsonValue	masterTimeout()	API name: master_timeout
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()	API name: repository
protected static void	setupRestoreRequestDeserializer(DelegatingDeserializer<RestoreRequest.Builder> op)
java.lang.String	snapshot()	API name: snapshot
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.Boolean	waitForCompletion()	API name: wait_for_completion

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<RestoreRequest> DESERIALIZER

Json deserializer for RestoreRequest

ENDPOINT

public static final Endpoint<RestoreRequest,RestoreResponse,OpenSearchError> ENDPOINT

Endpoint "snapshot.restore".

Constructor Details

RestoreRequest

protected RestoreRequest(RestoreRequest.Builder builder)

Method Details

repository

public java.lang.String repository()

API name: repository

snapshot

public java.lang.String snapshot()

API name: snapshot

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

API name: master_timeout

waitForCompletion

@Nullable public java.lang.Boolean waitForCompletion()

API name: wait_for_completion

ignoreIndexSettings

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

API name: ignore_index_settings

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

includeAliases

@Nullable public java.lang.Boolean includeAliases()

API name: include_aliases

includeGlobalState

@Nullable public java.lang.Boolean includeGlobalState()

API name: include_global_state

indexSettings

@Nullable public jakarta.json.JsonValue indexSettings()

API name: index_settings

indices

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

API name: indices

partial

@Nullable public java.lang.Boolean partial()

API name: partial

renamePattern

@Nullable public java.lang.String renamePattern()

API name: rename_pattern

renameReplacement

@Nullable public java.lang.String renameReplacement()

API name: rename_replacement

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupRestoreRequestDeserializer

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