org.elasticsearch.client
Interface IndicesAdminClient

All Known Subinterfaces:

InternalIndicesAdminClient

All Known Implementing Classes:

AbstractIndicesAdminClient, InternalTransportIndicesAdminClient, NodeIndicesAdminClient

public interface IndicesAdminClient

Administrative actions/operations against indices.

See Also:

AdminClient.indices()

Method Summary

ActionFuture<IndicesAliasesResponse>	aliases(IndicesAliasesRequest request) Allows to add/remove aliases from indices.
void	aliases(IndicesAliasesRequest request, ActionListener<IndicesAliasesResponse> listener) Allows to add/remove aliases from indices.
ActionFuture<AnalyzeResponse>	analyze(AnalyzeRequest request) Analyze text under the provided index.
void	analyze(AnalyzeRequest request, ActionListener<AnalyzeResponse> listener) Analyze text under the provided index.
ActionFuture<ClearIndicesCacheResponse>	clearCache(ClearIndicesCacheRequest request) Clear indices cache.
void	clearCache(ClearIndicesCacheRequest request, ActionListener<ClearIndicesCacheResponse> listener) Clear indices cache.
ActionFuture<CloseIndexResponse>	close(CloseIndexRequest request) Closes an index based on the index name.
void	close(CloseIndexRequest request, ActionListener<CloseIndexResponse> listener) Closes an index based on the index name.
ActionFuture<CreateIndexResponse>	create(CreateIndexRequest request) Creates an index using an explicit request allowing to specify the settings of the index.
void	create(CreateIndexRequest request, ActionListener<CreateIndexResponse> listener) Creates an index using an explicit request allowing to specify the settings of the index.
ActionFuture<DeleteIndexResponse>	delete(DeleteIndexRequest request) Deletes an index based on the index name.
void	delete(DeleteIndexRequest request, ActionListener<DeleteIndexResponse> listener) Deletes an index based on the index name.
ActionFuture<DeleteMappingResponse>	deleteMapping(DeleteMappingRequest request) Deletes mapping (and all its data) from one or more indices.
void	deleteMapping(DeleteMappingRequest request, ActionListener<DeleteMappingResponse> listener) Deletes mapping definition for a type into one or more indices.
ActionFuture<DeleteIndexTemplateResponse>	deleteTemplate(DeleteIndexTemplateRequest request) Deletes index template.
void	deleteTemplate(DeleteIndexTemplateRequest request, ActionListener<DeleteIndexTemplateResponse> listener) Deletes an index template.
ActionFuture<DeleteWarmerResponse>	deleteWarmer(DeleteWarmerRequest request) Deletes an index warmer.
void	deleteWarmer(DeleteWarmerRequest request, ActionListener<DeleteWarmerResponse> listener) Deletes an index warmer.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> ActionFuture<Response>	execute(IndicesAction<Request,Response,RequestBuilder> action, Request request)
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> void	execute(IndicesAction<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)
ActionFuture<IndicesExistsResponse>	exists(IndicesExistsRequest request) Indices Exists.
void	exists(IndicesExistsRequest request, ActionListener<IndicesExistsResponse> listener) The status of one or more indices.
ActionFuture<FlushResponse>	flush(FlushRequest request) Explicitly flush one or more indices (releasing memory from the node).
void	flush(FlushRequest request, ActionListener<FlushResponse> listener) Explicitly flush one or more indices (releasing memory from the node).
ActionFuture<GatewaySnapshotResponse>	gatewaySnapshot(GatewaySnapshotRequest request) Explicitly perform gateway snapshot for one or more indices.
void	gatewaySnapshot(GatewaySnapshotRequest request, ActionListener<GatewaySnapshotResponse> listener) Explicitly perform gateway snapshot for one or more indices.
ActionFuture<OpenIndexResponse>	open(OpenIndexRequest request) OPen an index based on the index name.
void	open(OpenIndexRequest request, ActionListener<OpenIndexResponse> listener) Open an index based on the index name.
ActionFuture<OptimizeResponse>	optimize(OptimizeRequest request) Explicitly optimize one or more indices into a the number of segments.
void	optimize(OptimizeRequest request, ActionListener<OptimizeResponse> listener) Explicitly optimize one or more indices into a the number of segments.
IndicesAliasesRequestBuilder	prepareAliases() Allows to add/remove aliases from indices.
AnalyzeRequestBuilder	prepareAnalyze(String text) Analyze text.
AnalyzeRequestBuilder	prepareAnalyze(String index, String text) Analyze text under the provided index.
ClearIndicesCacheRequestBuilder	prepareClearCache(String... indices) Clear indices cache.
CloseIndexRequestBuilder	prepareClose(String index) Closes an index based on the index name.
CreateIndexRequestBuilder	prepareCreate(String index) Creates an index using an explicit request allowing to specify the settings of the index.
DeleteIndexRequestBuilder	prepareDelete(String... indices) Deletes an index based on the index name.
DeleteMappingRequestBuilder	prepareDeleteMapping(String... indices) Deletes mapping definition for a type into one or more indices.
DeleteIndexTemplateRequestBuilder	prepareDeleteTemplate(String name) Deletes an index template.
DeleteWarmerRequestBuilder	prepareDeleteWarmer() Deletes an index warmer.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> RequestBuilder	prepareExecute(IndicesAction<Request,Response,RequestBuilder> action)
IndicesExistsRequestBuilder	prepareExists(String... indices) Indices exists.
FlushRequestBuilder	prepareFlush(String... indices) Explicitly flush one or more indices (releasing memory from the node).
GatewaySnapshotRequestBuilder	prepareGatewaySnapshot(String... indices) Explicitly perform gateway snapshot for one or more indices.
OpenIndexRequestBuilder	prepareOpen(String index) Opens an index based on the index name.
OptimizeRequestBuilder	prepareOptimize(String... indices) Explicitly optimize one or more indices into a the number of segments.
PutMappingRequestBuilder	preparePutMapping(String... indices) Add mapping definition for a type into one or more indices.
PutIndexTemplateRequestBuilder	preparePutTemplate(String name) Puts an index template.
PutWarmerRequestBuilder	preparePutWarmer(String name) Puts an index search warmer to be applies when applicable.
RefreshRequestBuilder	prepareRefresh(String... indices) Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).
IndicesSegmentsRequestBuilder	prepareSegments(String... indices) The segments of one or more indices.
IndicesStatsRequestBuilder	prepareStats(String... indices) Indices stats.
IndicesStatusRequestBuilder	prepareStatus(String... indices) The status of one or more indices.
UpdateSettingsRequestBuilder	prepareUpdateSettings(String... indices) Update indices settings.
ValidateQueryRequestBuilder	prepareValidateQuery(String... indices) Validate a query for correctness.
ActionFuture<PutMappingResponse>	putMapping(PutMappingRequest request) Add mapping definition for a type into one or more indices.
void	putMapping(PutMappingRequest request, ActionListener<PutMappingResponse> listener) Add mapping definition for a type into one or more indices.
ActionFuture<PutIndexTemplateResponse>	putTemplate(PutIndexTemplateRequest request) Puts an index template.
void	putTemplate(PutIndexTemplateRequest request, ActionListener<PutIndexTemplateResponse> listener) Puts an index template.
ActionFuture<PutWarmerResponse>	putWarmer(PutWarmerRequest request) Puts an index search warmer to be applies when applicable.
void	putWarmer(PutWarmerRequest request, ActionListener<PutWarmerResponse> listener) Puts an index search warmer to be applies when applicable.
ActionFuture<RefreshResponse>	refresh(RefreshRequest request) Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).
void	refresh(RefreshRequest request, ActionListener<RefreshResponse> listener) Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).
ActionFuture<IndicesSegmentResponse>	segments(IndicesSegmentsRequest request) The segments of one or more indices.
void	segments(IndicesSegmentsRequest request, ActionListener<IndicesSegmentResponse> listener) The segments of one or more indices.
ActionFuture<IndicesStats>	stats(IndicesStatsRequest request) Indices stats.
void	stats(IndicesStatsRequest request, ActionListener<IndicesStats> listener) Indices stats.
ActionFuture<IndicesStatusResponse>	status(IndicesStatusRequest request) The status of one or more indices.
void	status(IndicesStatusRequest request, ActionListener<IndicesStatusResponse> listener) The status of one or more indices.
ActionFuture<UpdateSettingsResponse>	updateSettings(UpdateSettingsRequest request) Updates settings of one or more indices.
void	updateSettings(UpdateSettingsRequest request, ActionListener<UpdateSettingsResponse> listener) Updates settings of one or more indices.
ActionFuture<ValidateQueryResponse>	validateQuery(ValidateQueryRequest request) Validate a query for correctness.
void	validateQuery(ValidateQueryRequest request, ActionListener<ValidateQueryResponse> listener) Validate a query for correctness.

Method Detail

execute

<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> ActionFuture<Response> execute(IndicesAction<Request,Response,RequestBuilder> action,
                                                                                                                                                             Request request)

execute

<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> void execute(IndicesAction<Request,Response,RequestBuilder> action,
                                                                                                                                           Request request,
                                                                                                                                           ActionListener<Response> listener)

prepareExecute

<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> RequestBuilder prepareExecute(IndicesAction<Request,Response,RequestBuilder> action)

exists

ActionFuture<IndicesExistsResponse> exists(IndicesExistsRequest request)

Indices Exists.

Parameters:

request - The indices exists request

Returns:

The result future

See Also:

Requests.indicesExistsRequest(String...)

exists

void exists(IndicesExistsRequest request,
            ActionListener<IndicesExistsResponse> listener)

The status of one or more indices.

Parameters:

request - The indices status request

listener - A listener to be notified with a result

See Also:

Requests.indicesExistsRequest(String...)

prepareExists

IndicesExistsRequestBuilder prepareExists(String... indices)

Indices exists.

stats

ActionFuture<IndicesStats> stats(IndicesStatsRequest request)

Indices stats.

stats

void stats(IndicesStatsRequest request,
           ActionListener<IndicesStats> listener)

Indices stats.

prepareStats

IndicesStatsRequestBuilder prepareStats(String... indices)

Indices stats.

status

ActionFuture<IndicesStatusResponse> status(IndicesStatusRequest request)

The status of one or more indices.

Parameters:

request - The indices status request

Returns:

The result future

See Also:

Requests.indicesStatusRequest(String...)

status

void status(IndicesStatusRequest request,
            ActionListener<IndicesStatusResponse> listener)

The status of one or more indices.

Parameters:

request - The indices status request

listener - A listener to be notified with a result

See Also:

Requests.indicesStatusRequest(String...)

prepareStatus

IndicesStatusRequestBuilder prepareStatus(String... indices)

The status of one or more indices.

segments

ActionFuture<IndicesSegmentResponse> segments(IndicesSegmentsRequest request)

The segments of one or more indices.

Parameters:

request - The indices segments request

Returns:

The result future

See Also:

Requests.indicesSegmentsRequest(String...)

segments

void segments(IndicesSegmentsRequest request,
              ActionListener<IndicesSegmentResponse> listener)

The segments of one or more indices.

Parameters:

request - The indices segments request

listener - A listener to be notified with a result

See Also:

Requests.indicesSegmentsRequest(String...)

prepareSegments

IndicesSegmentsRequestBuilder prepareSegments(String... indices)

The segments of one or more indices.

create

ActionFuture<CreateIndexResponse> create(CreateIndexRequest request)

Creates an index using an explicit request allowing to specify the settings of the index.

Parameters:

request - The create index request

Returns:

The result future

See Also:

Requests.createIndexRequest(String)

create

void create(CreateIndexRequest request,
            ActionListener<CreateIndexResponse> listener)

Creates an index using an explicit request allowing to specify the settings of the index.

Parameters:

request - The create index request

listener - A listener to be notified with a result

See Also:

Requests.createIndexRequest(String)

prepareCreate

CreateIndexRequestBuilder prepareCreate(String index)

Creates an index using an explicit request allowing to specify the settings of the index.

Parameters:

index - The index name to create

delete

ActionFuture<DeleteIndexResponse> delete(DeleteIndexRequest request)

Deletes an index based on the index name.

Parameters:

request - The delete index request

Returns:

The result future

See Also:

Requests.deleteIndexRequest(String)

delete

void delete(DeleteIndexRequest request,
            ActionListener<DeleteIndexResponse> listener)

Deletes an index based on the index name.

Parameters:

request - The delete index request

listener - A listener to be notified with a result

See Also:

Requests.deleteIndexRequest(String)

prepareDelete

DeleteIndexRequestBuilder prepareDelete(String... indices)

Deletes an index based on the index name.

Parameters:

indices - The indices to delete. Empty array to delete all indices.

close

ActionFuture<CloseIndexResponse> close(CloseIndexRequest request)

Closes an index based on the index name.

Parameters:

request - The close index request

Returns:

The result future

See Also:

Requests.closeIndexRequest(String)

close

void close(CloseIndexRequest request,
           ActionListener<CloseIndexResponse> listener)

Closes an index based on the index name.

Parameters:

request - The close index request

listener - A listener to be notified with a result

See Also:

Requests.closeIndexRequest(String)

prepareClose

CloseIndexRequestBuilder prepareClose(String index)

Closes an index based on the index name.

Parameters:

index - The index name to close

open

ActionFuture<OpenIndexResponse> open(OpenIndexRequest request)

OPen an index based on the index name.

Parameters:

request - The close index request

Returns:

The result future

See Also:

Requests.openIndexRequest(String)

open

void open(OpenIndexRequest request,
          ActionListener<OpenIndexResponse> listener)

Open an index based on the index name.

Parameters:

request - The close index request

listener - A listener to be notified with a result

See Also:

Requests.openIndexRequest(String)

prepareOpen

OpenIndexRequestBuilder prepareOpen(String index)

Opens an index based on the index name.

Parameters:

index - The index name to close

refresh

ActionFuture<RefreshResponse> refresh(RefreshRequest request)

Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).

Parameters:

request - The refresh request

Returns:

The result future

See Also:

Requests.refreshRequest(String...)

refresh

void refresh(RefreshRequest request,
             ActionListener<RefreshResponse> listener)

Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).

Parameters:

request - The refresh request

listener - A listener to be notified with a result

See Also:

Requests.refreshRequest(String...)

prepareRefresh

RefreshRequestBuilder prepareRefresh(String... indices)

Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).

flush

ActionFuture<FlushResponse> flush(FlushRequest request)

Explicitly flush one or more indices (releasing memory from the node).

Parameters:

request - The flush request

Returns:

A result future

See Also:

Requests.flushRequest(String...)

flush

void flush(FlushRequest request,
           ActionListener<FlushResponse> listener)

Explicitly flush one or more indices (releasing memory from the node).

Parameters:

request - The flush request

listener - A listener to be notified with a result

See Also:

Requests.flushRequest(String...)

prepareFlush

FlushRequestBuilder prepareFlush(String... indices)

Explicitly flush one or more indices (releasing memory from the node).

optimize

ActionFuture<OptimizeResponse> optimize(OptimizeRequest request)

Explicitly optimize one or more indices into a the number of segments.

Parameters:

request - The optimize request

Returns:

A result future

See Also:

Requests.optimizeRequest(String...)

optimize

void optimize(OptimizeRequest request,
              ActionListener<OptimizeResponse> listener)

Explicitly optimize one or more indices into a the number of segments.

Parameters:

request - The optimize request

listener - A listener to be notified with a result

See Also:

Requests.optimizeRequest(String...)

prepareOptimize

OptimizeRequestBuilder prepareOptimize(String... indices)

Explicitly optimize one or more indices into a the number of segments.

putMapping

ActionFuture<PutMappingResponse> putMapping(PutMappingRequest request)

Add mapping definition for a type into one or more indices.

Parameters:

request - The create mapping request

Returns:

A result future

See Also:

Requests.putMappingRequest(String...)

putMapping

void putMapping(PutMappingRequest request,
                ActionListener<PutMappingResponse> listener)

Add mapping definition for a type into one or more indices.

Parameters:

request - The create mapping request

listener - A listener to be notified with a result

See Also:

Requests.putMappingRequest(String...)

preparePutMapping

PutMappingRequestBuilder preparePutMapping(String... indices)

Add mapping definition for a type into one or more indices.

deleteMapping

ActionFuture<DeleteMappingResponse> deleteMapping(DeleteMappingRequest request)

Deletes mapping (and all its data) from one or more indices.

Parameters:

request - The delete mapping request

Returns:

A result future

See Also:

Requests.deleteMappingRequest(String...)

deleteMapping

void deleteMapping(DeleteMappingRequest request,
                   ActionListener<DeleteMappingResponse> listener)

Deletes mapping definition for a type into one or more indices.

Parameters:

request - The delete mapping request

listener - A listener to be notified with a result

See Also:

Requests.deleteMappingRequest(String...)

prepareDeleteMapping

DeleteMappingRequestBuilder prepareDeleteMapping(String... indices)

Deletes mapping definition for a type into one or more indices.

gatewaySnapshot

ActionFuture<GatewaySnapshotResponse> gatewaySnapshot(GatewaySnapshotRequest request)

Explicitly perform gateway snapshot for one or more indices.

Parameters:

request - The gateway snapshot request

Returns:

The result future

See Also:

Requests.gatewaySnapshotRequest(String...)

gatewaySnapshot

void gatewaySnapshot(GatewaySnapshotRequest request,
                     ActionListener<GatewaySnapshotResponse> listener)

Explicitly perform gateway snapshot for one or more indices.

Parameters:

request - The gateway snapshot request

listener - A listener to be notified with a result

See Also:

Requests.gatewaySnapshotRequest(String...)

prepareGatewaySnapshot

GatewaySnapshotRequestBuilder prepareGatewaySnapshot(String... indices)

Explicitly perform gateway snapshot for one or more indices.

aliases

ActionFuture<IndicesAliasesResponse> aliases(IndicesAliasesRequest request)

Allows to add/remove aliases from indices.

Parameters:

request - The index aliases request

Returns:

The result future

See Also:

Requests.indexAliasesRequest()

aliases

void aliases(IndicesAliasesRequest request,
             ActionListener<IndicesAliasesResponse> listener)

Allows to add/remove aliases from indices.

Parameters:

request - The index aliases request

listener - A listener to be notified with a result

See Also:

Requests.indexAliasesRequest()

prepareAliases

IndicesAliasesRequestBuilder prepareAliases()

Allows to add/remove aliases from indices.

clearCache

ActionFuture<ClearIndicesCacheResponse> clearCache(ClearIndicesCacheRequest request)

Clear indices cache.

Parameters:

request - The clear indices cache request

Returns:

The result future

See Also:

Requests.clearIndicesCacheRequest(String...)

clearCache

void clearCache(ClearIndicesCacheRequest request,
                ActionListener<ClearIndicesCacheResponse> listener)

Clear indices cache.

Parameters:

request - The clear indices cache request

listener - A listener to be notified with a result

See Also:

Requests.clearIndicesCacheRequest(String...)

prepareClearCache

ClearIndicesCacheRequestBuilder prepareClearCache(String... indices)

Clear indices cache.

updateSettings

ActionFuture<UpdateSettingsResponse> updateSettings(UpdateSettingsRequest request)

Updates settings of one or more indices.

Parameters:

request - the update settings request

Returns:

The result future

updateSettings

void updateSettings(UpdateSettingsRequest request,
                    ActionListener<UpdateSettingsResponse> listener)

Updates settings of one or more indices.

Parameters:

request - the update settings request

listener - A listener to be notified with the response

prepareUpdateSettings

UpdateSettingsRequestBuilder prepareUpdateSettings(String... indices)

Update indices settings.

analyze

ActionFuture<AnalyzeResponse> analyze(AnalyzeRequest request)

Analyze text under the provided index.

analyze

void analyze(AnalyzeRequest request,
             ActionListener<AnalyzeResponse> listener)

Analyze text under the provided index.

prepareAnalyze

AnalyzeRequestBuilder prepareAnalyze(@Nullable
                                     String index,
                                     String text)

Analyze text under the provided index.

Parameters:

index - The index name

text - The text to analyze

prepareAnalyze

AnalyzeRequestBuilder prepareAnalyze(String text)

Analyze text.

Parameters:

text - The text to analyze

putTemplate

ActionFuture<PutIndexTemplateResponse> putTemplate(PutIndexTemplateRequest request)

Puts an index template.

putTemplate

void putTemplate(PutIndexTemplateRequest request,
                 ActionListener<PutIndexTemplateResponse> listener)

Puts an index template.

preparePutTemplate

PutIndexTemplateRequestBuilder preparePutTemplate(String name)

Puts an index template.

Parameters:

name - The name of the template.

deleteTemplate

ActionFuture<DeleteIndexTemplateResponse> deleteTemplate(DeleteIndexTemplateRequest request)

Deletes index template.

deleteTemplate

void deleteTemplate(DeleteIndexTemplateRequest request,
                    ActionListener<DeleteIndexTemplateResponse> listener)

Deletes an index template.

prepareDeleteTemplate

DeleteIndexTemplateRequestBuilder prepareDeleteTemplate(String name)

Deletes an index template.

Parameters:

name - The name of the template.

validateQuery

ActionFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request)

Validate a query for correctness.

Parameters:

request - The count request

Returns:

The result future

See Also:

Requests.countRequest(String...)

validateQuery

void validateQuery(ValidateQueryRequest request,
                   ActionListener<ValidateQueryResponse> listener)

Validate a query for correctness.

Parameters:

request - The count request

listener - A listener to be notified of the result

See Also:

Requests.countRequest(String...)

prepareValidateQuery

ValidateQueryRequestBuilder prepareValidateQuery(String... indices)

Validate a query for correctness.

putWarmer

ActionFuture<PutWarmerResponse> putWarmer(PutWarmerRequest request)

Puts an index search warmer to be applies when applicable.

putWarmer

void putWarmer(PutWarmerRequest request,
               ActionListener<PutWarmerResponse> listener)

Puts an index search warmer to be applies when applicable.

preparePutWarmer

PutWarmerRequestBuilder preparePutWarmer(String name)

Puts an index search warmer to be applies when applicable.

deleteWarmer

ActionFuture<DeleteWarmerResponse> deleteWarmer(DeleteWarmerRequest request)

Deletes an index warmer.

deleteWarmer

void deleteWarmer(DeleteWarmerRequest request,
                  ActionListener<DeleteWarmerResponse> listener)

Deletes an index warmer.

prepareDeleteWarmer

DeleteWarmerRequestBuilder prepareDeleteWarmer()

Deletes an index warmer.