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
Switches the indices, ILM policies, and legacy, composable and component
templates from using custom node attributes and attribute-based allocation
filters to using data tiers, and optionally deletes one legacy index
template.+ Using node roles enables ILM to automatically move the indices
between data tiers.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MigrateToDataTiersRequest.Builder
Builder forMigrateToDataTiersRequest
.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<MigrateToDataTiersRequest>
_DESERIALIZER
Json deserializer forMigrateToDataTiersRequest
static Endpoint<MigrateToDataTiersRequest,MigrateToDataTiersResponse,ErrorResponse>
_ENDPOINT
Endpoint "ilm.migrate_to_data_tiers
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
dryRun()
If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.java.lang.String
legacyTemplateToDelete()
API name:legacy_template_to_delete
java.lang.String
nodeAttribute()
API name:node_attribute
static MigrateToDataTiersRequest
of(java.util.function.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
Json deserializer forMigrateToDataTiersRequest
-
_ENDPOINT
public static final Endpoint<MigrateToDataTiersRequest,MigrateToDataTiersResponse,ErrorResponse> _ENDPOINTEndpoint "ilm.migrate_to_data_tiers
".
-
-
Method Details
-
of
public static MigrateToDataTiersRequest of(java.util.function.Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn) -
dryRun
@Nullable public final java.lang.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 java.lang.String legacyTemplateToDelete()API name:legacy_template_to_delete
-
nodeAttribute
@Nullable public final java.lang.String nodeAttribute()API name:node_attribute
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupMigrateToDataTiersRequestDeserializer
protected static void setupMigrateToDataTiersRequestDeserializer(ObjectDeserializer<MigrateToDataTiersRequest.Builder> op)
-