Package co.elastic.clients.elasticsearch.searchable_snapshots

Class MountRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.searchable_snapshots.MountRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class MountRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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<MountRequest>	_DESERIALIZER	Json deserializer for MountRequest
static Endpoint<MountRequest,MountResponse,ElasticsearchError>	ENDPOINT	Endpoint "searchable_snapshots.mount".

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	ignoreIndexSettings()	API name: ignore_index_settings
java.lang.String	index()	Required - API name: index
java.util.Map<java.lang.String,JsonData>	indexSettings()	API name: index_settings
java.lang.String	masterTimeout()	Explicit operation timeout for connection to master node
java.lang.String	renamedIndex()	API name: renamed_index
java.lang.String	repository()	Required - The name of the repository containing the snapshot of the index to mount
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	setupMountRequestDeserializer(DelegatingDeserializer<MountRequest.Builder> op)
java.lang.String	snapshot()	Required - The name of the snapshot of the index to mount
java.lang.String	storage()	Selects the kind of local storage used to accelerate searches.
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<MountRequest> _DESERIALIZER

Json deserializer for MountRequest

ENDPOINT

public static final Endpoint<MountRequest,MountResponse,ElasticsearchError> ENDPOINT

Endpoint "searchable_snapshots.mount".

Constructor Details

MountRequest

public MountRequest(MountRequest.Builder builder)

MountRequest

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

Method Details

repository

public java.lang.String repository()

Required - The name of the repository containing the snapshot of the index to mount

API name: repository

snapshot

public java.lang.String snapshot()

Required - The name of the snapshot of the index to mount

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

storage

@Nullable
public java.lang.String storage()

Selects the kind of local storage used to accelerate searches. Experimental, and defaults to full_copy

API name: storage

index

public java.lang.String index()

Required - API name: index

renamedIndex

@Nullable
public java.lang.String renamedIndex()

API name: renamed_index

indexSettings

@Nullable
public java.util.Map<java.lang.String,JsonData> indexSettings()

API name: index_settings

ignoreIndexSettings

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

API name: ignore_index_settings

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)

setupMountRequestDeserializer

protected static void setupMountRequestDeserializer(DelegatingDeserializer<MountRequest.Builder> op)