org.elasticsearch.client
Interface IndicesAdminClient

All Known Implementing Classes:

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<ClearIndicesCacheResponse>	clearCache(ClearIndicesCacheRequest request) Clear indices cache.
void	clearCache(ClearIndicesCacheRequest request, ActionListener<ClearIndicesCacheResponse> listener) Clear indices cache.
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<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<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.
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<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<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.

Method Detail

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.indicesStatus(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.indicesStatus(String...)

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)

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)

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...)

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...)

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...)

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...)

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...)

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()

clearCache

ActionFuture<ClearIndicesCacheResponse> clearCache(ClearIndicesCacheRequest request)

Clear indices cache.

Parameters:

request - The clear indices cache request

Returns:

The result future

See Also:

Requests.clearIndicesCache(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.clearIndicesCache(String...)