Class RestoreRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.RestoreRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class RestoreRequest extends RequestBase implements JsonpSerializable
Restores a snapshot.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RestoreRequest.Builder
Builder forRestoreRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<RestoreRequest>
_DESERIALIZER
Json deserializer forRestoreRequest
static Endpoint<RestoreRequest,RestoreResponse,ErrorResponse>
_ENDPOINT
Endpoint "snapshot.restore
". -
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
PutIndicesSettingsRequest
indexSettings()
API name:index_settings
java.util.List<java.lang.String>
indices()
API name:indices
Time
masterTimeout()
Explicit operation timeout for connection to master nodestatic 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 namevoid
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 namejava.lang.Boolean
waitForCompletion()
Should this request wait until the operation has completed before returningMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forRestoreRequest
-
_ENDPOINT
Endpoint "snapshot.restore
".
-
-
Method Details
-
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
-
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
API name:index_settings
-
indices
public final java.util.List<java.lang.String> indices()API name:indices
-
masterTimeout
Explicit operation timeout for connection to master nodeAPI name:
master_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 nameAPI name:
repository
-
snapshot
public final java.lang.String snapshot()Required - A snapshot nameAPI name:
snapshot
-
waitForCompletion
@Nullable public final java.lang.Boolean waitForCompletion()Should this request wait until the operation has completed before returningAPI name:
wait_for_completion
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupRestoreRequestDeserializer
protected static void setupRestoreRequestDeserializer(ObjectDeserializer<RestoreRequest.Builder> op)
-