Package co.elastic.clients.elasticsearch.ilm

Class ElasticsearchIlmClient

java.lang.Object

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

co.elastic.clients.elasticsearch.ilm.ElasticsearchIlmClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchIlmClient
extends ApiClient<ElasticsearchTransport,ElasticsearchIlmClient>

Client for the ilm namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchIlmClient

public ElasticsearchIlmClient(ElasticsearchTransport transport)

ElasticsearchIlmClient

public ElasticsearchIlmClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchIlmClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchIlmClient>

deleteLifecycle

public DeleteLifecycleResponse deleteLifecycle(DeleteLifecycleRequest request)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteLifecycle

public final DeleteLifecycleResponse deleteLifecycle(Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainLifecycle

public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request)
                                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainLifecycle

public final ExplainLifecycleResponse explainLifecycle(Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
                                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle(GetLifecycleRequest request)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public final GetLifecycleResponse getLifecycle(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle()
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getStatus

public GetIlmStatusResponse getStatus()
                               throws IOException,
ElasticsearchException

Retrieves the current index lifecycle management (ILM) status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataTiers

public MigrateToDataTiersResponse migrateToDataTiers(MigrateToDataTiersRequest request)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataTiers

public final MigrateToDataTiersResponse migrateToDataTiers(Function<MigrateToDataTiersRequest.Builder,ObjectBuilder<MigrateToDataTiersRequest>> fn)
                                                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataTiers

public MigrateToDataTiersResponse migrateToDataTiers()
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

moveToStep

public MoveToStepResponse moveToStep(MoveToStepRequest request)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

moveToStep

public final MoveToStepResponse moveToStep(Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)
                                    throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putLifecycle

public PutLifecycleResponse putLifecycle(PutLifecycleRequest request)
                                  throws IOException,
ElasticsearchException

Creates a lifecycle policy

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putLifecycle

public final PutLifecycleResponse putLifecycle(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
                                        throws IOException,
ElasticsearchException

Creates a lifecycle policy

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

removePolicy

public RemovePolicyResponse removePolicy(RemovePolicyRequest request)
                                  throws IOException,
ElasticsearchException

Removes the assigned lifecycle policy and stops managing the specified index

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

removePolicy

public final RemovePolicyResponse removePolicy(Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)
                                        throws IOException,
ElasticsearchException

Removes the assigned lifecycle policy and stops managing the specified index

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

retry

public RetryResponse retry(RetryRequest request)
                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

retry

public final RetryResponse retry(Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartIlmResponse start(StartIlmRequest request)
                       throws IOException,
ElasticsearchException

Start the index lifecycle management (ILM) plugin.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public final StartIlmResponse start(Function<StartIlmRequest.Builder,ObjectBuilder<StartIlmRequest>> fn)
                             throws IOException,
ElasticsearchException

Start the index lifecycle management (ILM) plugin.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartIlmResponse start()
                       throws IOException,
ElasticsearchException

Start the index lifecycle management (ILM) plugin.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopIlmResponse stop(StopIlmRequest request)
                     throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public final StopIlmResponse stop(Function<StopIlmRequest.Builder,ObjectBuilder<StopIlmRequest>> fn)
                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopIlmResponse stop()
                     throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co