Package co.elastic.clients.elasticsearch.ilm

Class ElasticsearchIlmAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchIlmAsyncClient>

co.elastic.clients.elasticsearch.ilm.ElasticsearchIlmAsyncClient

public class ElasticsearchIlmAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchIlmAsyncClient>

Client for the ilm namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIlmAsyncClient(ElasticsearchTransport transport)
ElasticsearchIlmAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteLifecycleResponse>	deleteLifecycle(DeleteLifecycleRequest request)	Deletes the specified lifecycle policy definition.
final CompletableFuture<DeleteLifecycleResponse>	deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)	Deletes the specified lifecycle policy definition.
CompletableFuture<ExplainLifecycleResponse>	explainLifecycle(ExplainLifecycleRequest request)	Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
final CompletableFuture<ExplainLifecycleResponse>	explainLifecycle(Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)	Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
CompletableFuture<GetLifecycleResponse>	getLifecycle()	Returns the specified policy definition.
CompletableFuture<GetLifecycleResponse>	getLifecycle(GetLifecycleRequest request)	Returns the specified policy definition.
final CompletableFuture<GetLifecycleResponse>	getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)	Returns the specified policy definition.
CompletableFuture<GetIlmStatusResponse>	getStatus()	Retrieves the current index lifecycle management (ILM) status.
CompletableFuture<MigrateToDataTiersResponse>	migrateToDataTiers()	Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
CompletableFuture<MigrateToDataTiersResponse>	migrateToDataTiers(MigrateToDataTiersRequest request)	Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
final CompletableFuture<MigrateToDataTiersResponse>	migrateToDataTiers(Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn)	Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
CompletableFuture<MoveToStepResponse>	moveToStep(MoveToStepRequest request)	Manually moves an index into the specified step and executes that step.
final CompletableFuture<MoveToStepResponse>	moveToStep(Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)	Manually moves an index into the specified step and executes that step.
CompletableFuture<PutLifecycleResponse>	putLifecycle(PutLifecycleRequest request)	Creates a lifecycle policy
final CompletableFuture<PutLifecycleResponse>	putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)	Creates a lifecycle policy
CompletableFuture<RemovePolicyResponse>	removePolicy(RemovePolicyRequest request)	Removes the assigned lifecycle policy and stops managing the specified index
final CompletableFuture<RemovePolicyResponse>	removePolicy(Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)	Removes the assigned lifecycle policy and stops managing the specified index
CompletableFuture<RetryResponse>	retry(RetryRequest request)	Retries executing the policy for an index that is in the ERROR step.
final CompletableFuture<RetryResponse>	retry(Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)	Retries executing the policy for an index that is in the ERROR step.
CompletableFuture<StartIlmResponse>	start()	Start the index lifecycle management (ILM) plugin.
CompletableFuture<StartIlmResponse>	start(StartIlmRequest request)	Start the index lifecycle management (ILM) plugin.
final CompletableFuture<StartIlmResponse>	start(Function<StartIlmRequest.Builder,ObjectBuilder<StartIlmRequest>> fn)	Start the index lifecycle management (ILM) plugin.
CompletableFuture<StopIlmResponse>	stop()	Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
CompletableFuture<StopIlmResponse>	stop(StopIlmRequest request)	Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
final CompletableFuture<StopIlmResponse>	stop(Function<StopIlmRequest.Builder,ObjectBuilder<StopIlmRequest>> fn)	Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
ElasticsearchIlmAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchIlmAsyncClient

public ElasticsearchIlmAsyncClient(ElasticsearchTransport transport)

ElasticsearchIlmAsyncClient

public ElasticsearchIlmAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchIlmAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchIlmAsyncClient>

deleteLifecycle

public CompletableFuture<DeleteLifecycleResponse> deleteLifecycle(DeleteLifecycleRequest request)

Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

See Also:

• Documentation on elastic.co

deleteLifecycle

public final CompletableFuture<DeleteLifecycleResponse> deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)

Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

Parameters:

fn - a function that initializes a builder to create the DeleteLifecycleRequest

See Also:

• Documentation on elastic.co

explainLifecycle

public CompletableFuture<ExplainLifecycleResponse> explainLifecycle(ExplainLifecycleRequest request)

Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

See Also:

• Documentation on elastic.co

explainLifecycle

public final CompletableFuture<ExplainLifecycleResponse> explainLifecycle(Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)

Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

Parameters:

fn - a function that initializes a builder to create the ExplainLifecycleRequest

See Also:

• Documentation on elastic.co

getLifecycle

public CompletableFuture<GetLifecycleResponse> getLifecycle(GetLifecycleRequest request)

Returns the specified policy definition. Includes the policy version and last modified date.

See Also:

• Documentation on elastic.co

getLifecycle

public final CompletableFuture<GetLifecycleResponse> getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)

Returns the specified policy definition. Includes the policy version and last modified date.

Parameters:

fn - a function that initializes a builder to create the GetLifecycleRequest

See Also:

• Documentation on elastic.co

getLifecycle

public CompletableFuture<GetLifecycleResponse> getLifecycle()

Returns the specified policy definition. Includes the policy version and last modified date.

See Also:

• Documentation on elastic.co

getStatus

public CompletableFuture<GetIlmStatusResponse> getStatus()

Retrieves the current index lifecycle management (ILM) status.

See Also:

• Documentation on elastic.co

migrateToDataTiers

public CompletableFuture<MigrateToDataTiersResponse> migrateToDataTiers(MigrateToDataTiersRequest request)

Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

See Also:

• Documentation on elastic.co

migrateToDataTiers

public final CompletableFuture<MigrateToDataTiersResponse> migrateToDataTiers(Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn)

Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

Parameters:

fn - a function that initializes a builder to create the MigrateToDataTiersRequest

See Also:

• Documentation on elastic.co

migrateToDataTiers

public CompletableFuture<MigrateToDataTiersResponse> migrateToDataTiers()

Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

See Also:

• Documentation on elastic.co

moveToStep

public CompletableFuture<MoveToStepResponse> moveToStep(MoveToStepRequest request)

Manually moves an index into the specified step and executes that step.

See Also:

• Documentation on elastic.co

moveToStep

public final CompletableFuture<MoveToStepResponse> moveToStep(Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)

Manually moves an index into the specified step and executes that step.

Parameters:

fn - a function that initializes a builder to create the MoveToStepRequest

See Also:

• Documentation on elastic.co

putLifecycle

public CompletableFuture<PutLifecycleResponse> putLifecycle(PutLifecycleRequest request)

Creates a lifecycle policy

See Also:

• Documentation on elastic.co

putLifecycle

public final CompletableFuture<PutLifecycleResponse> putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)

Creates a lifecycle policy

Parameters:

fn - a function that initializes a builder to create the PutLifecycleRequest

See Also:

• Documentation on elastic.co

removePolicy

public CompletableFuture<RemovePolicyResponse> removePolicy(RemovePolicyRequest request)

Removes the assigned lifecycle policy and stops managing the specified index

See Also:

• Documentation on elastic.co

removePolicy

public final CompletableFuture<RemovePolicyResponse> removePolicy(Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)

Removes the assigned lifecycle policy and stops managing the specified index

Parameters:

fn - a function that initializes a builder to create the RemovePolicyRequest

See Also:

• Documentation on elastic.co

retry

public CompletableFuture<RetryResponse> retry(RetryRequest request)

Retries executing the policy for an index that is in the ERROR step.

See Also:

• Documentation on elastic.co

retry

public final CompletableFuture<RetryResponse> retry(Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)

Retries executing the policy for an index that is in the ERROR step.

Parameters:

fn - a function that initializes a builder to create the RetryRequest

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartIlmResponse> start(StartIlmRequest request)

Start the index lifecycle management (ILM) plugin.

See Also:

• Documentation on elastic.co

start

public final CompletableFuture<StartIlmResponse> start(Function<StartIlmRequest.Builder,ObjectBuilder<StartIlmRequest>> fn)

Start the index lifecycle management (ILM) plugin.

Parameters:

fn - a function that initializes a builder to create the StartIlmRequest

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartIlmResponse> start()

Start the index lifecycle management (ILM) plugin.

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopIlmResponse> stop(StopIlmRequest request)

Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

See Also:

• Documentation on elastic.co

stop

public final CompletableFuture<StopIlmResponse> stop(Function<StopIlmRequest.Builder,ObjectBuilder<StopIlmRequest>> fn)

Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

Parameters:

fn - a function that initializes a builder to create the StopIlmRequest

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopIlmResponse> stop()

Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

See Also:

• Documentation on elastic.co