Package org.elasticsearch.client

Interface IndicesAdminClient

All Superinterfaces:

ElasticsearchClient

public interface IndicesAdminClient
extends ElasticsearchClient

Administrative actions/operations against indices.

See Also:

• AdminClient.indices()

Method Summary

Modifier and Type	Method	Description
void	addBlock(AddIndexBlockRequest request, ActionListener<AddIndexBlockResponse> listener)	Adds a block to an index
ActionFuture<AcknowledgedResponse>	aliases(IndicesAliasesRequest request)	Allows to add/remove aliases from indices.
void	aliases(IndicesAliasesRequest request, ActionListener<AcknowledgedResponse> listener)	Allows to add/remove aliases from indices.
ActionFuture<AliasesExistResponse>	aliasesExist(GetAliasesRequest request)	Check to existence of index aliases.
void	aliasesExist(GetAliasesRequest request, ActionListener<AliasesExistResponse> listener)	Check the existence of specified index aliases.
ActionFuture<AnalyzeAction.Response>	analyze(AnalyzeAction.Request request)	Analyze text under the provided index.
void	analyze(AnalyzeAction.Request request, ActionListener<AnalyzeAction.Response> 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<AcknowledgedResponse>	delete(DeleteIndexRequest request)	Deletes an index based on the index name.
void	delete(DeleteIndexRequest request, ActionListener<AcknowledgedResponse> listener)	Deletes an index based on the index name.
ActionFuture<AcknowledgedResponse>	deleteTemplate(DeleteIndexTemplateRequest request)	Deletes index template.
void	deleteTemplate(DeleteIndexTemplateRequest request, ActionListener<AcknowledgedResponse> listener)	Deletes an index template.
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<ForceMergeResponse>	forceMerge(ForceMergeRequest request)	Explicitly force merge one or more indices into a the number of segments.
void	forceMerge(ForceMergeRequest request, ActionListener<ForceMergeResponse> listener)	Explicitly force merge one or more indices into a the number of segments.
ActionFuture<GetAliasesResponse>	getAliases(GetAliasesRequest request)	Get specific index aliases that exists in particular indices and / or by name.
void	getAliases(GetAliasesRequest request, ActionListener<GetAliasesResponse> listener)	Get specific index aliases that exists in particular indices and / or by name.
ActionFuture<GetFieldMappingsResponse>	getFieldMappings(GetFieldMappingsRequest request)	Get the mappings of specific fields
void	getFieldMappings(GetFieldMappingsRequest request, ActionListener<GetFieldMappingsResponse> listener)	Get the mappings of specific fields
ActionFuture<GetIndexResponse>	getIndex(GetIndexRequest request)	Get index metadata for particular indices.
void	getIndex(GetIndexRequest request, ActionListener<GetIndexResponse> listener)	Get index metadata for particular indices.
ActionFuture<GetMappingsResponse>	getMappings(GetMappingsRequest request)	Get the complete mappings of one or more types
void	getMappings(GetMappingsRequest request, ActionListener<GetMappingsResponse> listener)	Get the complete mappings of one or more types
ActionFuture<GetSettingsResponse>	getSettings(GetSettingsRequest request)	Executed a per index settings get request.
void	getSettings(GetSettingsRequest request, ActionListener<GetSettingsResponse> listener)	Executed a per index settings get request and returns the settings for the indices specified.
ActionFuture<GetIndexTemplatesResponse>	getTemplates(GetIndexTemplatesRequest request)	Gets index template.
void	getTemplates(GetIndexTemplatesRequest request, ActionListener<GetIndexTemplatesResponse> listener)	Gets an index template.
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.
AddIndexBlockRequestBuilder	prepareAddBlock(IndexMetadata.APIBlock block, String... indices)	Adds a block to an index
IndicesAliasesRequestBuilder	prepareAliases()	Allows to add/remove aliases from indices.
AliasesExistRequestBuilder	prepareAliasesExist(String... aliases)	Allows to check to existence of aliases from indices.
AnalyzeRequestBuilder	prepareAnalyze()	Analyze text/texts.
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... indices)	Closes one or more indices based on their 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.
DeleteIndexTemplateRequestBuilder	prepareDeleteTemplate(String name)	Deletes an index template.
IndicesExistsRequestBuilder	prepareExists(String... indices)	Indices exists.
FlushRequestBuilder	prepareFlush(String... indices)	Explicitly flush one or more indices (releasing memory from the node).
ForceMergeRequestBuilder	prepareForceMerge(String... indices)	Explicitly force merge one or more indices into a the number of segments.
GetAliasesRequestBuilder	prepareGetAliases(String... aliases)	Get specific index aliases that exists in particular indices and / or by name.
GetFieldMappingsRequestBuilder	prepareGetFieldMappings(String... indices)	Get the mappings of specific fields
GetIndexRequestBuilder	prepareGetIndex()	Get index metadata for particular indices.
GetMappingsRequestBuilder	prepareGetMappings(String... indices)	Get the complete mappings of one or more types
GetSettingsRequestBuilder	prepareGetSettings(String... indices)	Returns a builder for a per index settings get request.
GetIndexTemplatesRequestBuilder	prepareGetTemplates(String... name)	Gets an index template (optional).
OpenIndexRequestBuilder	prepareOpen(String... indices)	Opens one or more indices based on their index name.
PutMappingRequestBuilder	preparePutMapping(String... indices)	Add mapping definition for a type into one or more indices.
PutIndexTemplateRequestBuilder	preparePutTemplate(String name)	Puts an index template.
RecoveryRequestBuilder	prepareRecoveries(String... indices)	Indices recoveries
RefreshRequestBuilder	prepareRefresh(String... indices)	Explicitly refresh one or more indices (making the content indexed since the last refresh searchable).
ResizeRequestBuilder	prepareResizeIndex(String sourceIndex, String targetIndex)	Resize an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.
RolloverRequestBuilder	prepareRolloverIndex(String sourceAlias)	Swaps the index pointed to by an alias given all provided conditions are satisfied
IndicesSegmentsRequestBuilder	prepareSegments(String... indices)	The segments of one or more indices.
IndicesShardStoreRequestBuilder	prepareShardStores(String... indices)	The shard stores info of one or more indices.
IndicesStatsRequestBuilder	prepareStats(String... indices)	Indices stats.
SyncedFlushRequestBuilder	prepareSyncedFlush(String... indices)	Explicitly sync flush one or more indices (write sync id to shards for faster recovery).
TypesExistsRequestBuilder	prepareTypesExists(String... index)	Deprecated. Types are deprecated and are in the process of being removed.
UpdateSettingsRequestBuilder	prepareUpdateSettings(String... indices)	Update indices settings.
UpgradeRequestBuilder	prepareUpgrade(String... indices)	Check upgrade status of one or more indices
UpgradeStatusRequestBuilder	prepareUpgradeStatus(String... indices)	Explicitly upgrade one or more indices
ValidateQueryRequestBuilder	prepareValidateQuery(String... indices)	Validate a query for correctness.
ActionFuture<AcknowledgedResponse>	putMapping(PutMappingRequest request)	Add mapping definition for a type into one or more indices.
void	putMapping(PutMappingRequest request, ActionListener<AcknowledgedResponse> listener)	Add mapping definition for a type into one or more indices.
ActionFuture<AcknowledgedResponse>	putTemplate(PutIndexTemplateRequest request)	Puts an index template.
void	putTemplate(PutIndexTemplateRequest request, ActionListener<AcknowledgedResponse> listener)	Puts an index template.
ActionFuture<RecoveryResponse>	recoveries(RecoveryRequest request)	Indices recoveries
void	recoveries(RecoveryRequest request, ActionListener<RecoveryResponse> listener)	Indices recoveries
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<ResizeResponse>	resizeIndex(ResizeRequest request)	Resize an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.
void	resizeIndex(ResizeRequest request, ActionListener<ResizeResponse> listener)	Shrinks an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.
ActionFuture<ResolveIndexAction.Response>	resolveIndex(ResolveIndexAction.Request request)	Resolves names and wildcard expressions to indices, aliases, and data streams
void	resolveIndex(ResolveIndexAction.Request request, ActionListener<ResolveIndexAction.Response> listener)	Resolves names and wildcard expressions to indices, aliases, and data streams
ActionFuture<RolloverResponse>	rolloverIndex(RolloverRequest request)	Swaps the index pointed to by an alias given all provided conditions are satisfied
void	rolloverIndex(RolloverRequest request, ActionListener<RolloverResponse> listener)	Swaps the index pointed to by an alias given all provided conditions are satisfied
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<IndicesShardStoresResponse>	shardStores(IndicesShardStoresRequest request)	The shard stores info of one or more indices.
void	shardStores(IndicesShardStoresRequest request, ActionListener<IndicesShardStoresResponse> listener)	The shard stores info of one or more indices.
ActionFuture<IndicesStatsResponse>	stats(IndicesStatsRequest request)	Indices stats.
void	stats(IndicesStatsRequest request, ActionListener<IndicesStatsResponse> listener)	Indices stats.
ActionFuture<SyncedFlushResponse>	syncedFlush(SyncedFlushRequest request)	Explicitly sync flush one or more indices (write sync id to shards for faster recovery).
void	syncedFlush(SyncedFlushRequest request, ActionListener<SyncedFlushResponse> listener)	Explicitly sync flush one or more indices (write sync id to shards for faster recovery).
ActionFuture<TypesExistsResponse>	typesExists(TypesExistsRequest request)	Deprecated. Types are deprecated and are in the process of being removed.
void	typesExists(TypesExistsRequest request, ActionListener<TypesExistsResponse> listener)	Deprecated. Types are deprecated and are in the process of being removed.
ActionFuture<AcknowledgedResponse>	updateSettings(UpdateSettingsRequest request)	Updates settings of one or more indices.
void	updateSettings(UpdateSettingsRequest request, ActionListener<AcknowledgedResponse> listener)	Updates settings of one or more indices.
ActionFuture<UpgradeResponse>	upgrade(UpgradeRequest request)	Explicitly upgrade one or more indices
void	upgrade(UpgradeRequest request, ActionListener<UpgradeResponse> listener)	Explicitly upgrade one or more indices
ActionFuture<UpgradeStatusResponse>	upgradeStatus(UpgradeStatusRequest request)	Check upgrade status of one or more indices
void	upgradeStatus(UpgradeStatusRequest request, ActionListener<UpgradeStatusResponse> listener)	Check upgrade status 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.

Methods inherited from interface org.elasticsearch.client.ElasticsearchClient

execute, execute, threadPool

Method Details

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.

typesExists

@Deprecated
ActionFuture<TypesExistsResponse> typesExists(TypesExistsRequest request)

Deprecated.

Types are deprecated and are in the process of being removed.

Types exists.

Parameters:

request - The types exists request

Returns:

The result future

typesExists

@Deprecated
void typesExists(TypesExistsRequest request,
 ActionListener<TypesExistsResponse> listener)

Deprecated.

Types are deprecated and are in the process of being removed.

Types exists.

Parameters:

request - The types exists

listener - A listener to be notified with a result

prepareTypesExists

@Deprecated
TypesExistsRequestBuilder prepareTypesExists(String... index)

Deprecated.

Types are deprecated and are in the process of being removed.

Types exists.

stats

ActionFuture<IndicesStatsResponse> stats(IndicesStatsRequest request)

Indices stats.

stats

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

Indices stats.

prepareStats

IndicesStatsRequestBuilder prepareStats(String... indices)

Indices stats.

recoveries

ActionFuture<RecoveryResponse> recoveries(RecoveryRequest request)

Indices recoveries

recoveries

void recoveries(RecoveryRequest request,
 ActionListener<RecoveryResponse> listener)

Indices recoveries

prepareRecoveries

RecoveryRequestBuilder prepareRecoveries(String... indices)

Indices recoveries

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.

shardStores

ActionFuture<IndicesShardStoresResponse> shardStores(IndicesShardStoresRequest request)

The shard stores info of one or more indices.

Parameters:

request - The indices shard stores request

Returns:

The result future

See Also:

• Requests.indicesShardStoresRequest(String...)

shardStores

void shardStores(IndicesShardStoresRequest request,
 ActionListener<IndicesShardStoresResponse> listener)

The shard stores info of one or more indices.

Parameters:

request - The indices shard stores request

listener - A listener to be notified with a result

See Also:

• Requests.indicesShardStoresRequest(String...)

prepareShardStores

IndicesShardStoreRequestBuilder prepareShardStores(String... indices)

The shard stores info 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<AcknowledgedResponse> 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<AcknowledgedResponse> 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. Use "_all" 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... indices)

Closes one or more indices based on their index name.

Parameters:

indices - The name of the indices 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)

prepareAddBlock

AddIndexBlockRequestBuilder prepareAddBlock(IndexMetadata.APIBlock block,
 String... indices)

Adds a block to an index

Parameters:

block - The block to add

indices - The name of the indices to add the block to

addBlock

void addBlock(AddIndexBlockRequest request,
 ActionListener<AddIndexBlockResponse> listener)

Adds a block to an index

Parameters:

request - The add index block request

listener - A listener to be notified with a result

See Also:

• Requests.openIndexRequest(String)

prepareOpen

OpenIndexRequestBuilder prepareOpen(String... indices)

Opens one or more indices based on their index name.

Parameters:

indices - The name of the indices 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).

syncedFlush

ActionFuture<SyncedFlushResponse> syncedFlush(SyncedFlushRequest request)

Explicitly sync flush one or more indices (write sync id to shards for faster recovery).

Parameters:

request - The sync flush request

Returns:

A result future

See Also:

• Requests.syncedFlushRequest(String...)

syncedFlush

void syncedFlush(SyncedFlushRequest request,
 ActionListener<SyncedFlushResponse> listener)

Explicitly sync flush one or more indices (write sync id to shards for faster recovery).

Parameters:

request - The sync flush request

listener - A listener to be notified with a result

See Also:

• Requests.syncedFlushRequest(String...)

prepareSyncedFlush

SyncedFlushRequestBuilder prepareSyncedFlush(String... indices)

Explicitly sync flush one or more indices (write sync id to shards for faster recovery).

forceMerge

ActionFuture<ForceMergeResponse> forceMerge(ForceMergeRequest request)

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

Parameters:

request - The optimize request

Returns:

A result future

See Also:

• Requests.forceMergeRequest(String...)

forceMerge

void forceMerge(ForceMergeRequest request,
 ActionListener<ForceMergeResponse> listener)

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

Parameters:

request - The force merge request

listener - A listener to be notified with a result

See Also:

• Requests.forceMergeRequest(String...)

prepareForceMerge

ForceMergeRequestBuilder prepareForceMerge(String... indices)

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

upgrade

ActionFuture<UpgradeResponse> upgrade(UpgradeRequest request)

Explicitly upgrade one or more indices

Parameters:

request - The upgrade request

Returns:

A result future

See Also:

• Requests.upgradeRequest(String...)

upgrade

void upgrade(UpgradeRequest request,
 ActionListener<UpgradeResponse> listener)

Explicitly upgrade one or more indices

Parameters:

request - The upgrade request

listener - A listener to be notified with a result

See Also:

• Requests.upgradeRequest(String...)

prepareUpgradeStatus

UpgradeStatusRequestBuilder prepareUpgradeStatus(String... indices)

Explicitly upgrade one or more indices

upgradeStatus

ActionFuture<UpgradeStatusResponse> upgradeStatus(UpgradeStatusRequest request)

Check upgrade status of one or more indices

Parameters:

request - The upgrade request

Returns:

A result future

See Also:

• Requests.upgradeRequest(String...)

upgradeStatus

void upgradeStatus(UpgradeStatusRequest request,
 ActionListener<UpgradeStatusResponse> listener)

Check upgrade status of one or more indices

Parameters:

request - The upgrade request

listener - A listener to be notified with a result

See Also:

• Requests.upgradeRequest(String...)

prepareUpgrade

UpgradeRequestBuilder prepareUpgrade(String... indices)

Check upgrade status of one or more indices

getMappings

void getMappings(GetMappingsRequest request,
 ActionListener<GetMappingsResponse> listener)

Get the complete mappings of one or more types

getMappings

ActionFuture<GetMappingsResponse> getMappings(GetMappingsRequest request)

Get the complete mappings of one or more types

prepareGetMappings

GetMappingsRequestBuilder prepareGetMappings(String... indices)

Get the complete mappings of one or more types

getFieldMappings

void getFieldMappings(GetFieldMappingsRequest request,
 ActionListener<GetFieldMappingsResponse> listener)

Get the mappings of specific fields

prepareGetFieldMappings

GetFieldMappingsRequestBuilder prepareGetFieldMappings(String... indices)

Get the mappings of specific fields

getFieldMappings

ActionFuture<GetFieldMappingsResponse> getFieldMappings(GetFieldMappingsRequest request)

Get the mappings of specific fields

putMapping

ActionFuture<AcknowledgedResponse> 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<AcknowledgedResponse> 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.

aliases

ActionFuture<AcknowledgedResponse> 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<AcknowledgedResponse> 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.

getAliases

ActionFuture<GetAliasesResponse> getAliases(GetAliasesRequest request)

Get specific index aliases that exists in particular indices and / or by name.

Parameters:

request - The result future

getAliases

void getAliases(GetAliasesRequest request,
 ActionListener<GetAliasesResponse> listener)

Get specific index aliases that exists in particular indices and / or by name.

Parameters:

request - The index aliases request

listener - A listener to be notified with a result

prepareGetAliases

GetAliasesRequestBuilder prepareGetAliases(String... aliases)

Get specific index aliases that exists in particular indices and / or by name.

prepareAliasesExist

AliasesExistRequestBuilder prepareAliasesExist(String... aliases)

Allows to check to existence of aliases from indices.

aliasesExist

ActionFuture<AliasesExistResponse> aliasesExist(GetAliasesRequest request)

Check to existence of index aliases.

Parameters:

request - The result future

aliasesExist

void aliasesExist(GetAliasesRequest request,
 ActionListener<AliasesExistResponse> listener)

Check the existence of specified index aliases.

Parameters:

request - The index aliases request

listener - A listener to be notified with a result

getIndex

ActionFuture<GetIndexResponse> getIndex(GetIndexRequest request)

Get index metadata for particular indices.

Parameters:

request - The result future

getIndex

void getIndex(GetIndexRequest request,
 ActionListener<GetIndexResponse> listener)

Get index metadata for particular indices.

Parameters:

request - The index aliases request

listener - A listener to be notified with a result

prepareGetIndex

GetIndexRequestBuilder prepareGetIndex()

Get index metadata for particular 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<AcknowledgedResponse> 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<AcknowledgedResponse> 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<AnalyzeAction.Response> analyze(AnalyzeAction.Request request)

Analyze text under the provided index.

analyze

void analyze(AnalyzeAction.Request request,
 ActionListener<AnalyzeAction.Response> 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

prepareAnalyze

AnalyzeRequestBuilder prepareAnalyze()

Analyze text/texts.

putTemplate

ActionFuture<AcknowledgedResponse> putTemplate(PutIndexTemplateRequest request)

Puts an index template.

putTemplate

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

Puts an index template.

preparePutTemplate

PutIndexTemplateRequestBuilder preparePutTemplate(String name)

Puts an index template.

Parameters:

name - The name of the template.

deleteTemplate

ActionFuture<AcknowledgedResponse> deleteTemplate(DeleteIndexTemplateRequest request)

Deletes index template.

deleteTemplate

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

Deletes an index template.

prepareDeleteTemplate

DeleteIndexTemplateRequestBuilder prepareDeleteTemplate(String name)

Deletes an index template.

Parameters:

name - The name of the template.

getTemplates

ActionFuture<GetIndexTemplatesResponse> getTemplates(GetIndexTemplatesRequest request)

Gets index template.

getTemplates

void getTemplates(GetIndexTemplatesRequest request,
 ActionListener<GetIndexTemplatesResponse> listener)

Gets an index template.

prepareGetTemplates

GetIndexTemplatesRequestBuilder prepareGetTemplates(String... name)

Gets an index template (optional).

validateQuery

ActionFuture<ValidateQueryResponse> validateQuery(ValidateQueryRequest request)

Validate a query for correctness.

Parameters:

request - The count request

Returns:

The result future

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

prepareValidateQuery

ValidateQueryRequestBuilder prepareValidateQuery(String... indices)

Validate a query for correctness.

getSettings

void getSettings(GetSettingsRequest request,
 ActionListener<GetSettingsResponse> listener)

Executed a per index settings get request and returns the settings for the indices specified. Note: this is a per index request and will not include settings that are set on the cluster level. This request is not exhaustive, it will not return default values for setting.

getSettings

ActionFuture<GetSettingsResponse> getSettings(GetSettingsRequest request)

Executed a per index settings get request.

See Also:

• getSettings(org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest)

prepareGetSettings

GetSettingsRequestBuilder prepareGetSettings(String... indices)

Returns a builder for a per index settings get request.

Parameters:

indices - the indices to fetch the setting for.

See Also:

• getSettings(org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest)

prepareResizeIndex

ResizeRequestBuilder prepareResizeIndex(String sourceIndex,
 String targetIndex)

Resize an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.

resizeIndex

ActionFuture<ResizeResponse> resizeIndex(ResizeRequest request)

Resize an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.

resizeIndex

void resizeIndex(ResizeRequest request,
 ActionListener<ResizeResponse> listener)

Shrinks an index using an explicit request allowing to specify the settings, mappings and aliases of the target index of the index.

prepareRolloverIndex

RolloverRequestBuilder prepareRolloverIndex(String sourceAlias)

Swaps the index pointed to by an alias given all provided conditions are satisfied

rolloverIndex

ActionFuture<RolloverResponse> rolloverIndex(RolloverRequest request)

Swaps the index pointed to by an alias given all provided conditions are satisfied

rolloverIndex

void rolloverIndex(RolloverRequest request,
 ActionListener<RolloverResponse> listener)

Swaps the index pointed to by an alias given all provided conditions are satisfied

resolveIndex

void resolveIndex(ResolveIndexAction.Request request,
 ActionListener<ResolveIndexAction.Response> listener)

Resolves names and wildcard expressions to indices, aliases, and data streams

resolveIndex

ActionFuture<ResolveIndexAction.Response> resolveIndex(ResolveIndexAction.Request request)

Resolves names and wildcard expressions to indices, aliases, and data streams