Package co.elastic.clients.elasticsearch.snapshot

Class RestoreRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.RestoreRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class RestoreRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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 for RestoreRequest
static Endpoint<RestoreRequest,RestoreResponse,ElasticsearchError>	ENDPOINT	Endpoint "snapshot.restore".

Constructor Summary

Constructors

Constructor	Description
RestoreRequest(RestoreRequest.Builder builder)
RestoreRequest(java.util.function.Function<RestoreRequest.Builder,RestoreRequest.Builder> fn)

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
PutSettingsRequest	indexSettings()	API name: index_settings
java.util.List<java.lang.String>	indices()	API name: indices
java.lang.String	masterTimeout()	Explicit operation timeout for connection to master node
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(DelegatingDeserializer<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 Details

_DESERIALIZER

public static final JsonpDeserializer<RestoreRequest> _DESERIALIZER

Json deserializer for RestoreRequest

ENDPOINT

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

Endpoint "snapshot.restore".

Constructor Details

RestoreRequest

public RestoreRequest(RestoreRequest.Builder builder)

RestoreRequest

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

Method Details

repository

public java.lang.String repository()

Required - A repository name

API name: repository

snapshot

public java.lang.String snapshot()

Required - A snapshot name

API name: snapshot

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

waitForCompletion

@Nullable
public java.lang.Boolean waitForCompletion()

Should this request wait until the operation has completed before returning

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 PutSettingsRequest 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

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(DelegatingDeserializer<RestoreRequest.Builder> op)