org.elasticsearch.groovy.client.IndicesAdminClientExtensions.groovy Maven / Gradle / Ivy
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.
*/
package org.elasticsearch.groovy.client
import org.elasticsearch.action.ListenableActionFuture
import org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest
import org.elasticsearch.action.admin.indices.alias.IndicesAliasesResponse
import org.elasticsearch.action.admin.indices.alias.exists.AliasesExistResponse
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequest
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse
import org.elasticsearch.action.admin.indices.analyze.AnalyzeRequest
import org.elasticsearch.action.admin.indices.analyze.AnalyzeResponse
import org.elasticsearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest
import org.elasticsearch.action.admin.indices.cache.clear.ClearIndicesCacheResponse
import org.elasticsearch.action.admin.indices.close.CloseIndexRequest
import org.elasticsearch.action.admin.indices.close.CloseIndexResponse
import org.elasticsearch.action.admin.indices.create.CreateIndexRequest
import org.elasticsearch.action.admin.indices.create.CreateIndexResponse
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest
import org.elasticsearch.action.admin.indices.delete.DeleteIndexResponse
import org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsRequest
import org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsResponse
import org.elasticsearch.action.admin.indices.exists.types.TypesExistsRequest
import org.elasticsearch.action.admin.indices.exists.types.TypesExistsResponse
import org.elasticsearch.action.admin.indices.flush.FlushRequest
import org.elasticsearch.action.admin.indices.flush.FlushResponse
import org.elasticsearch.action.admin.indices.mapping.delete.DeleteMappingRequest
import org.elasticsearch.action.admin.indices.mapping.delete.DeleteMappingResponse
import org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsRequest
import org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsResponse
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsRequest
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsResponse
import org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequest
import org.elasticsearch.action.admin.indices.mapping.put.PutMappingResponse
import org.elasticsearch.action.admin.indices.open.OpenIndexRequest
import org.elasticsearch.action.admin.indices.open.OpenIndexResponse
import org.elasticsearch.action.admin.indices.optimize.OptimizeRequest
import org.elasticsearch.action.admin.indices.optimize.OptimizeResponse
import org.elasticsearch.action.admin.indices.recovery.RecoveryRequest
import org.elasticsearch.action.admin.indices.recovery.RecoveryResponse
import org.elasticsearch.action.admin.indices.refresh.RefreshRequest
import org.elasticsearch.action.admin.indices.refresh.RefreshResponse
import org.elasticsearch.action.admin.indices.segments.IndicesSegmentResponse
import org.elasticsearch.action.admin.indices.segments.IndicesSegmentsRequest
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsResponse
import org.elasticsearch.action.admin.indices.settings.put.UpdateSettingsRequest
import org.elasticsearch.action.admin.indices.settings.put.UpdateSettingsResponse
import org.elasticsearch.action.admin.indices.stats.IndicesStatsRequest
import org.elasticsearch.action.admin.indices.stats.IndicesStatsResponse
import org.elasticsearch.action.admin.indices.template.delete.DeleteIndexTemplateRequest
import org.elasticsearch.action.admin.indices.template.delete.DeleteIndexTemplateResponse
import org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesRequest
import org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse
import org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateRequest
import org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateResponse
import org.elasticsearch.action.admin.indices.validate.query.ValidateQueryRequest
import org.elasticsearch.action.admin.indices.validate.query.ValidateQueryResponse
import org.elasticsearch.action.admin.indices.warmer.delete.DeleteWarmerRequest
import org.elasticsearch.action.admin.indices.warmer.delete.DeleteWarmerResponse
import org.elasticsearch.action.admin.indices.warmer.get.GetWarmersRequest
import org.elasticsearch.action.admin.indices.warmer.get.GetWarmersResponse
import org.elasticsearch.action.admin.indices.warmer.put.PutWarmerRequest
import org.elasticsearch.action.admin.indices.warmer.put.PutWarmerResponse
import org.elasticsearch.client.AdminClient
import org.elasticsearch.client.IndicesAdminClient
import org.elasticsearch.client.Requests
/**
* {@code IndicesAdminClientExtensions} provides Groovy-friendly access to {@link IndicesAdminClient} features.
* @see AdminClient#indices()
*/
class IndicesAdminClientExtensions extends AbstractClientExtensions {
// REQUEST/RESPONSE
/**
* Explicitly refresh one or more indices, which makes all content indexed since the last refresh searchable.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link RefreshRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture refresh(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.refreshRequest(), requestClosure, self.&refresh)
}
/**
* Determine if the specified indices exist.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link IndicesExistsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture exists(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.indicesExistsRequest(), requestClosure, self.&exists)
}
/**
* Determine if the specified types exist within the specified indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link TypesExistsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture typesExists(IndicesAdminClient self, Closure requestClosure) {
// indices must be supplied by the closure
doRequestAsync(self, new TypesExistsRequest(null), requestClosure, self.&typesExists)
}
/**
* Get stats for indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link IndicesStatsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture stats(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new IndicesStatsRequest(), requestClosure, self.&stats)
}
/**
* Get details pertaining to the recovery state of indices and their associated shards.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link RecoveryRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture recoveries(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new RecoveryRequest(), requestClosure, self.&recoveries)
}
/**
* Get details pertaining to the segments of indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link IndicesSegmentsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture segments(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.indicesExistsRequest(), requestClosure, self.&segments)
}
/**
* Create an index explicitly, which allows the index configuration to be specified.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link CreateIndexRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture create(IndicesAdminClient self, Closure requestClosure) {
// index must be set by the closure
doRequestAsync(self, Requests.createIndexRequest(null), requestClosure, self.&create)
}
/**
* Delete the specified indices.
*
* Note: Manually supply the reserved index name of "_all" to delete all indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link DeleteIndexRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture delete(IndicesAdminClient self, Closure requestClosure) {
// index must be set by the closure
doRequestAsync(self, Requests.deleteIndexRequest(null), requestClosure, self.&delete)
}
/**
* Close the specified indices. Closing an index prevents documents from being added, updated, or removed. This is
* a good way to make an index read-only.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link CloseIndexRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture close(IndicesAdminClient self, Closure requestClosure) {
// index must be set by the closure
doRequestAsync(self, Requests.closeIndexRequest(null), requestClosure, self.&close)
}
/**
* Open the specified indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link OpenIndexRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture open(IndicesAdminClient self, Closure requestClosure) {
// index must be set by the closure
doRequestAsync(self, Requests.openIndexRequest(null), requestClosure, self.&open)
}
/**
* Explicitly flush the specified indices. A successful flush of an index guarantees that items in its transaction
* log have been written to disk and starts a new transaction log.
*
* Note: By default, Elasticsearch will perform flush operations automatically.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link FlushRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture flush(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.flushRequest(), requestClosure, self.&flush)
}
/**
* Explicitly optimize the specified indices.
*
* Optimizing an index will reduce the number of segments that the index contains, which will speed up future search
* operations. Like other operations, Elasticsearch will automatically optimize indices in the background.
*
* The optimal number of segments is 1, but an active index will regularly have more than 1. A
* {@link IndicesAdminClient#close(CloseIndexRequest) closed} index can be safely optimized to 1 segment to
* speed up future search operations.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link OptimizeRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture optimize(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.optimizeRequest(), requestClosure, self.&optimize)
}
/**
* Get the mappings of one or more types.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetMappingsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getMappings(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new GetMappingsRequest(), requestClosure, self.&getMappings)
}
/**
* Get the mappings of one or more fields.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetFieldMappingsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getFieldMappings(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, new GetFieldMappingsRequest(), requestClosure, self.&getFieldMappings)
}
/**
* Add the mapping definition for a type into one or more indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link PutMappingRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture putMapping(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.putMappingRequest(), requestClosure, self.&putMapping)
}
/**
* Delete the mapping definition for a type in one or more indices.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link DeleteMappingRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture deleteMapping(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, Requests.deleteMappingRequest(), requestClosure, self.&deleteMapping)
}
/**
* Atomically add or remove index aliases.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link IndicesAliasesRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture aliases(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, Requests.indexAliasesRequest(), requestClosure, self.&aliases)
}
/**
* Get index aliases.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetAliasesRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getAliases(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new GetAliasesRequest(), requestClosure, self.&getAliases)
}
/**
* Determine if index aliases exist.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetAliasesRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture aliasesExist(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new GetAliasesRequest(), requestClosure, self.&aliasesExist)
}
/**
* Clear the indices specified caches.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link ClearIndicesCacheRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture clearCache(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, Requests.clearIndicesCacheRequest(), requestClosure, self.&clearCache)
}
/**
* Update the settings of one or more indices.
*
* Note: Some settings can only be set at the creation of an index, such as the number of shards.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link UpdateSettingsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture updateSettings(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, new UpdateSettingsRequest(), requestClosure, self.&updateSettings)
}
/**
* Add an index template to enable automatic type mappings.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link PutIndexTemplateRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture putTemplate(IndicesAdminClient self,
Closure requestClosure) {
// template name expected be supplied by the closure
doRequestAsync(self, new PutIndexTemplateRequest(null), requestClosure, self.&putTemplate)
}
/**
* Delete an index template.
*
* Note: This will not unmap indices that have made use of this template.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param name The name of the index template to delete.
* @return Never {@code null}.
* @throws NullPointerException if {@code self} is {@code null}
*/
static ListenableActionFuture deleteTemplate(IndicesAdminClient self, String name) {
doRequestAsync(self, new DeleteIndexTemplateRequest(name), self.&deleteTemplate)
}
/**
* Get index templates.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetIndexTemplatesRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getTemplates(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, new GetIndexTemplatesRequest(), requestClosure, self.&getTemplates)
}
/**
* Validate a query for correctness.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link ValidateQueryRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture validateQuery(IndicesAdminClient self,
Closure requestClosure) {
doRequestAsync(self, new ValidateQueryRequest(), requestClosure, self.&validateQuery)
}
/**
* Put an index search warmer.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link PutWarmerRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture putWarmer(IndicesAdminClient self, Closure requestClosure) {
// warmer name is expected to be set by the closure
doRequestAsync(self, new PutWarmerRequest(null), requestClosure, self.&putWarmer)
}
/**
* Delete one or more index search warmers.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link DeleteWarmerRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture deleteWarmer(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new DeleteWarmerRequest(), requestClosure, self.&deleteWarmer)
}
/**
* Get index search warmers.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetWarmersRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getWarmers(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new GetWarmersRequest(), requestClosure, self.&getWarmers)
}
/**
* Get index settings.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link GetSettingsRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null}
*/
static ListenableActionFuture getSettings(IndicesAdminClient self, Closure requestClosure) {
doRequestAsync(self, new GetSettingsRequest(), requestClosure, self.&getSettings)
}
/**
* Analyze the {@code text} using the provided index.
*
* @param self The {@code this} reference for the {@link IndicesAdminClient}.
* @param requestClosure The map-like closure that configures the {@link AnalyzeRequest}.
* @return Never {@code null}.
* @throws NullPointerException if any parameter is {@code null} except {@code text}
*/
static ListenableActionFuture analyze(IndicesAdminClient self,
String text,
Closure requestClosure) {
// text must currently be supplied to the constructor
doRequestAsync(self, new AnalyzeRequest(text), requestClosure, self.&analyze)
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy