Package co.elastic.clients.elasticsearch.ilm

Class ElasticsearchIlmClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.ilm.ElasticsearchIlmClient

public class ElasticsearchIlmClient
extends ApiClient

Client for the ilm namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIlmClient(Transport transport)

Method Summary

Modifier and Type	Method	Description
DeleteLifecycleResponse	deleteLifecycle(DeleteLifecycleRequest request)	Deletes the specified lifecycle policy definition.
DeleteLifecycleResponse	deleteLifecycle(java.util.function.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.
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.
GetLifecycleResponse	getLifecycle(GetLifecycleRequest request)	Returns the specified policy definition.
GetLifecycleResponse	getLifecycle(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)	Returns the specified policy definition.
GetStatusResponse	getStatus()	Retrieves the current index lifecycle management (ILM) status.
MoveToStepResponse	moveToStep(MoveToStepRequest request)	Manually moves an index into the specified step and executes that step.
MoveToStepResponse	moveToStep(java.util.function.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
PutLifecycleResponse	putLifecycle(java.util.function.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
RemovePolicyResponse	removePolicy(java.util.function.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.
RetryResponse	retry(java.util.function.Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)	Retries executing the policy for an index that is in the ERROR step.
StartResponse	start(StartRequest request)	Start the index lifecycle management (ILM) plugin.
StartResponse	start(java.util.function.Function<StartRequest.Builder,ObjectBuilder<StartRequest>> fn)	Start the index lifecycle management (ILM) plugin.
StopResponse	stop(StopRequest request)	Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
StopResponse	stop(java.util.function.Function<StopRequest.Builder,ObjectBuilder<StopRequest>> fn)	Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchIlmClient

public ElasticsearchIlmClient(Transport transport)

Method Details

deleteLifecycle

public DeleteLifecycleResponse deleteLifecycle(DeleteLifecycleRequest request)
                                        throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteLifecycle

public final DeleteLifecycleResponse deleteLifecycle(java.util.function.Function<DeleteLifecycleRequest.Builder,ObjectBuilder<DeleteLifecycleRequest>> fn)
                                              throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

explainLifecycle

public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request)
                                          throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

explainLifecycle

public final ExplainLifecycleResponse explainLifecycle(java.util.function.Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
                                                throws java.io.IOException

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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getLifecycle

public GetLifecycleResponse getLifecycle(GetLifecycleRequest request)
                                  throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getLifecycle

public final GetLifecycleResponse getLifecycle(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
                                        throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getStatus

public GetStatusResponse getStatus()
                            throws java.io.IOException

Retrieves the current index lifecycle management (ILM) status.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

moveToStep

public MoveToStepResponse moveToStep(MoveToStepRequest request)
                              throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

moveToStep

public final MoveToStepResponse moveToStep(java.util.function.Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)
                                    throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putLifecycle

public PutLifecycleResponse putLifecycle(PutLifecycleRequest request)
                                  throws java.io.IOException

Creates a lifecycle policy

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putLifecycle

public final PutLifecycleResponse putLifecycle(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
                                        throws java.io.IOException

Creates a lifecycle policy

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

removePolicy

public RemovePolicyResponse removePolicy(RemovePolicyRequest request)
                                  throws java.io.IOException

Removes the assigned lifecycle policy and stops managing the specified index

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

removePolicy

public final RemovePolicyResponse removePolicy(java.util.function.Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)
                                        throws java.io.IOException

Removes the assigned lifecycle policy and stops managing the specified index

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

retry

public RetryResponse retry(RetryRequest request)
                    throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

retry

public final RetryResponse retry(java.util.function.Function<RetryRequest.Builder,ObjectBuilder<RetryRequest>> fn)
                          throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

start

public StartResponse start(StartRequest request)
                    throws java.io.IOException

Start the index lifecycle management (ILM) plugin.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

start

public final StartResponse start(java.util.function.Function<StartRequest.Builder,ObjectBuilder<StartRequest>> fn)
                          throws java.io.IOException

Start the index lifecycle management (ILM) plugin.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stop

public StopResponse stop(StopRequest request)
                  throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stop

public final StopResponse stop(java.util.function.Function<StopRequest.Builder,ObjectBuilder<StopRequest>> fn)
                        throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co