Package co.elastic.clients.elasticsearch.ilm

Class MigrateToDataTiersRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<MigrateToDataTiersRequest.Builder>

co.elastic.clients.elasticsearch.ilm.MigrateToDataTiersRequest.Builder

All Implemented Interfaces:

WithJson<MigrateToDataTiersRequest.Builder>, ObjectBuilder<MigrateToDataTiersRequest>

Enclosing class:

MigrateToDataTiersRequest

public static class MigrateToDataTiersRequest.Builder
extends RequestBase.AbstractBuilder<MigrateToDataTiersRequest.Builder>
implements ObjectBuilder<MigrateToDataTiersRequest>

Builder for MigrateToDataTiersRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MigrateToDataTiersRequest	build()	Builds a MigrateToDataTiersRequest.
final MigrateToDataTiersRequest.Builder	dryRun(Boolean value)	If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.
final MigrateToDataTiersRequest.Builder	legacyTemplateToDelete(String value)	API name: legacy_template_to_delete
final MigrateToDataTiersRequest.Builder	masterTimeout(Time value)	The period to wait for a connection to the master node.
final MigrateToDataTiersRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a connection to the master node.
final MigrateToDataTiersRequest.Builder	nodeAttribute(String value)	API name: node_attribute
protected MigrateToDataTiersRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dryRun

public final MigrateToDataTiersRequest.Builder dryRun(@Nullable
 Boolean value)

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

public final MigrateToDataTiersRequest.Builder legacyTemplateToDelete(@Nullable
 String value)

API name: legacy_template_to_delete

masterTimeout

public final MigrateToDataTiersRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

public final MigrateToDataTiersRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public final MigrateToDataTiersRequest.Builder nodeAttribute(@Nullable
 String value)

API name: node_attribute

self

protected MigrateToDataTiersRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<MigrateToDataTiersRequest.Builder>

build

public MigrateToDataTiersRequest build()

Builds a MigrateToDataTiersRequest.

Specified by:

build in interface ObjectBuilder<MigrateToDataTiersRequest>

Throws:

NullPointerException - if some of the required fields are null.