Package co.elastic.clients.elasticsearch.dangling_indices

Class ImportDanglingIndexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.dangling_indices.ImportDanglingIndexRequest

public class ImportDanglingIndexRequest
extends RequestBase

Import a dangling index.

If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final Endpoint<ImportDanglingIndexRequest,ImportDanglingIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "dangling_indices.import_dangling_index".

Method Summary

Modifier and Type	Method	Description
final Boolean	acceptDataLoss()	This parameter must be set to true to import a dangling index.
final String	indexUuid()	Required - The UUID of the index to import.
final Time	masterTimeout()	The period to wait for a connection to the master node.
static ImportDanglingIndexRequest	of(Function<ImportDanglingIndexRequest.Builder,ObjectBuilder<ImportDanglingIndexRequest>> fn)
ImportDanglingIndexRequest.Builder	rebuild()
final Time	timeout()	The period to wait for a response.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<ImportDanglingIndexRequest,ImportDanglingIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "dangling_indices.import_dangling_index".

Method Details

of

public static ImportDanglingIndexRequest of(Function<ImportDanglingIndexRequest.Builder,ObjectBuilder<ImportDanglingIndexRequest>> fn)

acceptDataLoss

@Nullable
public final Boolean acceptDataLoss()

This parameter must be set to true to import a dangling index. Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.

API name: accept_data_loss

indexUuid

public final String indexUuid()

Required - The UUID of the index to import. Use the get dangling indices API to locate the UUID.

API name: index_uuid

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node.

API name: master_timeout

timeout

@Nullable
public final Time timeout()

The period to wait for a response.

API name: timeout

rebuild

public ImportDanglingIndexRequest.Builder rebuild()

Returns:

New ImportDanglingIndexRequest.Builder initialized with field values of this instance