co.elastic.clients.elasticsearch.ilm.ElasticsearchIlmAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-java Show documentation
Show all versions of elasticsearch-java Show documentation
Elasticsearch Java API Client
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ilm;
import co.elastic.clients.ApiClient;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.JsonEndpoint;
import co.elastic.clients.transport.Transport;
import co.elastic.clients.transport.TransportOptions;
import co.elastic.clients.util.ObjectBuilder;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import javax.annotation.Nullable;
/**
* Client for the ilm namespace.
*/
public class ElasticsearchIlmAsyncClient extends ApiClient {
public ElasticsearchIlmAsyncClient(ElasticsearchTransport transport) {
super(transport, null);
}
public ElasticsearchIlmAsyncClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions) {
super(transport, transportOptions);
}
@Override
public ElasticsearchIlmAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions) {
return new ElasticsearchIlmAsyncClient(this.transport, transportOptions);
}
// ----- Endpoint: ilm.delete_lifecycle
/**
* Deletes the specified lifecycle policy definition. A currently used policy
* cannot be deleted.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture deleteLifecycle(DeleteLifecycleRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) DeleteLifecycleRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Deletes the specified lifecycle policy definition. A currently used policy
* cannot be deleted.
*
* @param fn
* a function that initializes a builder to create the
* {@link DeleteLifecycleRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture deleteLifecycle(
Function> fn) {
return deleteLifecycle(fn.apply(new DeleteLifecycleRequest.Builder()).build());
}
// ----- Endpoint: ilm.explain_lifecycle
/**
* Retrieves information about the index's current lifecycle state, such as the
* currently executing phase, action, and step.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture explainLifecycle(ExplainLifecycleRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) ExplainLifecycleRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Retrieves information about the index's current lifecycle state, such as the
* currently executing phase, action, and step.
*
* @param fn
* a function that initializes a builder to create the
* {@link ExplainLifecycleRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture explainLifecycle(
Function> fn) {
return explainLifecycle(fn.apply(new ExplainLifecycleRequest.Builder()).build());
}
// ----- Endpoint: ilm.get_lifecycle
/**
* Returns the specified policy definition. Includes the policy version and last
* modified date.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture getLifecycle(GetLifecycleRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) GetLifecycleRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Returns the specified policy definition. Includes the policy version and last
* modified date.
*
* @param fn
* a function that initializes a builder to create the
* {@link GetLifecycleRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture getLifecycle(
Function> fn) {
return getLifecycle(fn.apply(new GetLifecycleRequest.Builder()).build());
}
/**
* Returns the specified policy definition. Includes the policy version and last
* modified date.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture getLifecycle() {
return this.transport.performRequestAsync(new GetLifecycleRequest.Builder().build(),
GetLifecycleRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: ilm.get_status
/**
* Retrieves the current index lifecycle management (ILM) status.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture getStatus() {
return this.transport.performRequestAsync(GetIlmStatusRequest._INSTANCE, GetIlmStatusRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: ilm.migrate_to_data_tiers
/**
* Migrates the indices and ILM policies away from custom node attribute
* allocation routing to data tiers routing
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture migrateToDataTiers(MigrateToDataTiersRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) MigrateToDataTiersRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Migrates the indices and ILM policies away from custom node attribute
* allocation routing to data tiers routing
*
* @param fn
* a function that initializes a builder to create the
* {@link MigrateToDataTiersRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture migrateToDataTiers(
Function> fn) {
return migrateToDataTiers(fn.apply(new MigrateToDataTiersRequest.Builder()).build());
}
/**
* Migrates the indices and ILM policies away from custom node attribute
* allocation routing to data tiers routing
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture migrateToDataTiers() {
return this.transport.performRequestAsync(new MigrateToDataTiersRequest.Builder().build(),
MigrateToDataTiersRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: ilm.move_to_step
/**
* Manually moves an index into the specified step and executes that step.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture moveToStep(MoveToStepRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) MoveToStepRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Manually moves an index into the specified step and executes that step.
*
* @param fn
* a function that initializes a builder to create the
* {@link MoveToStepRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture moveToStep(
Function> fn) {
return moveToStep(fn.apply(new MoveToStepRequest.Builder()).build());
}
// ----- Endpoint: ilm.put_lifecycle
/**
* Creates a lifecycle policy
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture putLifecycle(PutLifecycleRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) PutLifecycleRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Creates a lifecycle policy
*
* @param fn
* a function that initializes a builder to create the
* {@link PutLifecycleRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture putLifecycle(
Function> fn) {
return putLifecycle(fn.apply(new PutLifecycleRequest.Builder()).build());
}
// ----- Endpoint: ilm.remove_policy
/**
* Removes the assigned lifecycle policy and stops managing the specified index
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture removePolicy(RemovePolicyRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) RemovePolicyRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Removes the assigned lifecycle policy and stops managing the specified index
*
* @param fn
* a function that initializes a builder to create the
* {@link RemovePolicyRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture removePolicy(
Function> fn) {
return removePolicy(fn.apply(new RemovePolicyRequest.Builder()).build());
}
// ----- Endpoint: ilm.retry
/**
* Retries executing the policy for an index that is in the ERROR step.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture retry(RetryRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) RetryRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Retries executing the policy for an index that is in the ERROR step.
*
* @param fn
* a function that initializes a builder to create the
* {@link RetryRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture retry(
Function> fn) {
return retry(fn.apply(new RetryRequest.Builder()).build());
}
// ----- Endpoint: ilm.start
/**
* Start the index lifecycle management (ILM) plugin.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture start(StartIlmRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) StartIlmRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Start the index lifecycle management (ILM) plugin.
*
* @param fn
* a function that initializes a builder to create the
* {@link StartIlmRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture start(
Function> fn) {
return start(fn.apply(new StartIlmRequest.Builder()).build());
}
/**
* Start the index lifecycle management (ILM) plugin.
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture start() {
return this.transport.performRequestAsync(new StartIlmRequest.Builder().build(), StartIlmRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: ilm.stop
/**
* Halts all lifecycle management operations and stops the index lifecycle
* management (ILM) plugin
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture stop(StopIlmRequest request) {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) StopIlmRequest._ENDPOINT;
return this.transport.performRequestAsync(request, endpoint, this.transportOptions);
}
/**
* Halts all lifecycle management operations and stops the index lifecycle
* management (ILM) plugin
*
* @param fn
* a function that initializes a builder to create the
* {@link StopIlmRequest}
* @see Documentation
* on elastic.co
*/
public final CompletableFuture stop(
Function> fn) {
return stop(fn.apply(new StopIlmRequest.Builder()).build());
}
/**
* Halts all lifecycle management operations and stops the index lifecycle
* management (ILM) plugin
*
* @see Documentation
* on elastic.co
*/
public CompletableFuture stop() {
return this.transport.performRequestAsync(new StopIlmRequest.Builder().build(), StopIlmRequest._ENDPOINT,
this.transportOptions);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy