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
ConstructorDescriptionElasticsearchIlmAsyncClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptiondeleteLifecycle
(DeleteLifecycleRequest request) Deletes the specified lifecycle policy definition.Deletes the specified lifecycle policy definition.explainLifecycle
(ExplainLifecycleRequest request) Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.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.Returns the specified policy definition.getLifecycle
(GetLifecycleRequest request) Returns the specified policy definition.Returns the specified policy definition.Retrieves the current index lifecycle management (ILM) status.Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingMigrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingmigrateToDataTiers
(Function<MigrateToDataTiersRequest.Builder, ObjectBuilder<MigrateToDataTiersRequest>> fn) Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingmoveToStep
(MoveToStepRequest request) Manually moves an index into the specified step and executes that step.Manually moves an index into the specified step and executes that step.putLifecycle
(PutLifecycleRequest request) Creates a lifecycle policyCreates a lifecycle policyremovePolicy
(RemovePolicyRequest request) Removes the assigned lifecycle policy and stops managing the specified indexRemoves the assigned lifecycle policy and stops managing the specified indexretry
(RetryRequest request) Retries executing the policy for an index that is in the ERROR step.final CompletableFuture<RetryResponse>
Retries executing the policy for an index that is in the ERROR step.start()
Start the index lifecycle management (ILM) plugin.start
(StartIlmRequest request) Start the index lifecycle management (ILM) plugin.Start the index lifecycle management (ILM) plugin.stop()
Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginstop
(StopIlmRequest request) Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginfinal CompletableFuture<StopIlmResponse>
Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginwithTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchIlmAsyncClient
-
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 classApiClient<ElasticsearchTransport,
ElasticsearchIlmAsyncClient>
-
deleteLifecycle
Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.- See Also:
-
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 theDeleteLifecycleRequest
- See Also:
-
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:
-
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 theExplainLifecycleRequest
- See Also:
-
getLifecycle
Returns the specified policy definition. Includes the policy version and last modified date.- See Also:
-
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 theGetLifecycleRequest
- See Also:
-
getLifecycle
Returns the specified policy definition. Includes the policy version and last modified date.- See Also:
-
getStatus
Retrieves the current index lifecycle management (ILM) status.- See Also:
-
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:
-
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 theMigrateToDataTiersRequest
- See Also:
-
migrateToDataTiers
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing- See Also:
-
moveToStep
Manually moves an index into the specified step and executes that step.- See Also:
-
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 theMoveToStepRequest
- See Also:
-
putLifecycle
Creates a lifecycle policy- See Also:
-
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 thePutLifecycleRequest
- See Also:
-
removePolicy
Removes the assigned lifecycle policy and stops managing the specified index- See Also:
-
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 theRemovePolicyRequest
- See Also:
-
retry
Retries executing the policy for an index that is in the ERROR step.- See Also:
-
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 theRetryRequest
- See Also:
-
start
Start the index lifecycle management (ILM) plugin.- See Also:
-
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 theStartIlmRequest
- See Also:
-
start
Start the index lifecycle management (ILM) plugin.- See Also:
-
stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin- See Also:
-
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 theStopIlmRequest
- See Also:
-
stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin- See Also:
-