Package co.elastic.clients.elasticsearch.ilm

Class MigrateToDataTiersRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.MigrateToDataTiersRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class MigrateToDataTiersRequest
extends RequestBase
implements JsonpSerializable

Migrate to data tiers routing. Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers.

Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide:

1. Stop setting the custom hot attribute on new indices.
2. Remove custom allocation settings from existing ILM policies.
3. Replace custom allocation settings from existing indices with the corresponding tier preference.

ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<MigrateToDataTiersRequest>	_DESERIALIZER	Json deserializer for MigrateToDataTiersRequest
static final Endpoint<MigrateToDataTiersRequest,MigrateToDataTiersResponse,ErrorResponse>	_ENDPOINT	Endpoint "ilm.migrate_to_data_tiers".

Method Summary

Modifier and Type	Method	Description
final Boolean	dryRun()	If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.
final String	legacyTemplateToDelete()	API name: legacy_template_to_delete
final Time	masterTimeout()	The period to wait for a connection to the master node.
final String	nodeAttribute()	API name: node_attribute
static MigrateToDataTiersRequest	of(Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn)
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	setupMigrateToDataTiersRequestDeserializer(ObjectDeserializer<MigrateToDataTiersRequest.Builder> op)

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

_DESERIALIZER

public static final JsonpDeserializer<MigrateToDataTiersRequest> _DESERIALIZER

Json deserializer for MigrateToDataTiersRequest

_ENDPOINT

public static final Endpoint<MigrateToDataTiersRequest,MigrateToDataTiersResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.migrate_to_data_tiers".

Method Details

of

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

dryRun

@Nullable
public final Boolean dryRun()

If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated.

API name: dry_run

legacyTemplateToDelete

@Nullable
public final String legacyTemplateToDelete()

API name: legacy_template_to_delete

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

API name: master_timeout

nodeAttribute

@Nullable
public final String nodeAttribute()

API name: node_attribute

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)

setupMigrateToDataTiersRequestDeserializer

protected static void setupMigrateToDataTiersRequestDeserializer(ObjectDeserializer<MigrateToDataTiersRequest.Builder> op)