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 java.util.concurrent.CompletableFuture<DeleteLifecycleResponse>
deleteLifecycle(DeleteLifecycleRequest request)
Deletes the specified lifecycle policy definition.java.util.concurrent.CompletableFuture<DeleteLifecycleResponse>
deleteLifecycle(java.util.function.Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)
Deletes the specified lifecycle policy definition.java.util.concurrent.CompletableFuture<ExplainLifecycleResponse>
explainLifecycle(ExplainLifecycleRequest request)
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.java.util.concurrent.CompletableFuture<ExplainLifecycleResponse>
explainLifecycle(java.util.function.Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.java.util.concurrent.CompletableFuture<GetLifecycleResponse>
getLifecycle()
Returns the specified policy definition.java.util.concurrent.CompletableFuture<GetLifecycleResponse>
getLifecycle(GetLifecycleRequest request)
Returns the specified policy definition.java.util.concurrent.CompletableFuture<GetLifecycleResponse>
getLifecycle(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
Returns the specified policy definition.java.util.concurrent.CompletableFuture<GetIlmStatusResponse>
getStatus()
Retrieves the current index lifecycle management (ILM) status.java.util.concurrent.CompletableFuture<MigrateToDataTiersResponse>
migrateToDataTiers()
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingjava.util.concurrent.CompletableFuture<MigrateToDataTiersResponse>
migrateToDataTiers(MigrateToDataTiersRequest request)
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingjava.util.concurrent.CompletableFuture<MigrateToDataTiersResponse>
migrateToDataTiers(java.util.function.Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn)
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routingjava.util.concurrent.CompletableFuture<MoveToStepResponse>
moveToStep(MoveToStepRequest request)
Manually moves an index into the specified step and executes that step.java.util.concurrent.CompletableFuture<MoveToStepResponse>
moveToStep(java.util.function.Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)
Manually moves an index into the specified step and executes that step.java.util.concurrent.CompletableFuture<PutLifecycleResponse>
putLifecycle(PutLifecycleRequest request)
Creates a lifecycle policyjava.util.concurrent.CompletableFuture<PutLifecycleResponse>
putLifecycle(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
Creates a lifecycle policyjava.util.concurrent.CompletableFuture<RemovePolicyResponse>
removePolicy(RemovePolicyRequest request)
Removes the assigned lifecycle policy and stops managing the specified indexjava.util.concurrent.CompletableFuture<RemovePolicyResponse>
removePolicy(java.util.function.Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)
Removes the assigned lifecycle policy and stops managing the specified indexjava.util.concurrent.CompletableFuture<RetryResponse>
retry(RetryRequest request)
Retries executing the policy for an index that is in the ERROR step.java.util.concurrent.CompletableFuture<RetryResponse>
retry(java.util.function.Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)
Retries executing the policy for an index that is in the ERROR step.java.util.concurrent.CompletableFuture<StartIlmResponse>
start()
Start the index lifecycle management (ILM) plugin.java.util.concurrent.CompletableFuture<StartIlmResponse>
start(StartIlmRequest request)
Start the index lifecycle management (ILM) plugin.java.util.concurrent.CompletableFuture<StartIlmResponse>
start(java.util.function.Function<StartIlmRequest.Builder,ObjectBuilder<StartIlmRequest>> fn)
Start the index lifecycle management (ILM) plugin.java.util.concurrent.CompletableFuture<StopIlmResponse>
stop()
Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginjava.util.concurrent.CompletableFuture<StopIlmResponse>
stop(StopIlmRequest request)
Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginjava.util.concurrent.CompletableFuture<StopIlmResponse>
stop(java.util.function.Function<StopIlmRequest.Builder,ObjectBuilder<StopIlmRequest>> fn)
Halts all lifecycle management operations and stops the index lifecycle management (ILM) pluginElasticsearchIlmAsyncClient
withTransportOptions(TransportOptions transportOptions)
Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
public java.util.concurrent.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 java.util.concurrent.CompletableFuture<DeleteLifecycleResponse> deleteLifecycle(java.util.function.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:
- Documentation on elastic.co
-
explainLifecycle
public java.util.concurrent.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 java.util.concurrent.CompletableFuture<ExplainLifecycleResponse> explainLifecycle(java.util.function.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:
- Documentation on elastic.co
-
getLifecycle
public java.util.concurrent.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 java.util.concurrent.CompletableFuture<GetLifecycleResponse> getLifecycle(java.util.function.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:
- Documentation on elastic.co
-
getLifecycle
Returns the specified policy definition. Includes the policy version and last modified date.- See Also:
- Documentation on elastic.co
-
getStatus
Retrieves the current index lifecycle management (ILM) status.- See Also:
- Documentation on elastic.co
-
migrateToDataTiers
public java.util.concurrent.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 java.util.concurrent.CompletableFuture<MigrateToDataTiersResponse> migrateToDataTiers(java.util.function.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:
- Documentation on elastic.co
-
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 java.util.concurrent.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 java.util.concurrent.CompletableFuture<MoveToStepResponse> moveToStep(java.util.function.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:
- Documentation on elastic.co
-
putLifecycle
public java.util.concurrent.CompletableFuture<PutLifecycleResponse> putLifecycle(PutLifecycleRequest request)Creates a lifecycle policy- See Also:
- Documentation on elastic.co
-
putLifecycle
public final java.util.concurrent.CompletableFuture<PutLifecycleResponse> putLifecycle(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)Creates a lifecycle policy- Parameters:
fn
- a function that initializes a builder to create thePutLifecycleRequest
- See Also:
- Documentation on elastic.co
-
removePolicy
public java.util.concurrent.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 java.util.concurrent.CompletableFuture<RemovePolicyResponse> removePolicy(java.util.function.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:
- Documentation on elastic.co
-
retry
Retries executing the policy for an index that is in the ERROR step.- See Also:
- Documentation on elastic.co
-
retry
public final java.util.concurrent.CompletableFuture<RetryResponse> retry(java.util.function.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:
- Documentation on elastic.co
-
start
Start the index lifecycle management (ILM) plugin.- See Also:
- Documentation on elastic.co
-
start
public final java.util.concurrent.CompletableFuture<StartIlmResponse> start(java.util.function.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:
- Documentation on elastic.co
-
start
Start the index lifecycle management (ILM) plugin.- See Also:
- Documentation on elastic.co
-
stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin- See Also:
- Documentation on elastic.co
-
stop
public final java.util.concurrent.CompletableFuture<StopIlmResponse> stop(java.util.function.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:
- Documentation on elastic.co
-
stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin- See Also:
- Documentation on elastic.co
-