Package co.elastic.clients.elasticsearch.indices

Class ElasticsearchIndicesClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchIndicesClient>

co.elastic.clients.elasticsearch.indices.ElasticsearchIndicesClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchIndicesClient
extends ApiClient<ElasticsearchTransport,ElasticsearchIndicesClient>

Client for the indices namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIndicesClient(ElasticsearchTransport transport)
ElasticsearchIndicesClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
AddBlockResponse	addBlock(AddBlockRequest request)	Adds a block to an index.
final AddBlockResponse	addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)	Adds a block to an index.
AnalyzeResponse	analyze()	Performs the analysis process on a text and return the tokens breakdown of the text.
AnalyzeResponse	analyze(AnalyzeRequest request)	Performs the analysis process on a text and return the tokens breakdown of the text.
final AnalyzeResponse	analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)	Performs the analysis process on a text and return the tokens breakdown of the text.
ClearCacheResponse	clearCache()	Clears all or specific caches for one or more indices.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clears all or specific caches for one or more indices.
final ClearCacheResponse	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears all or specific caches for one or more indices.
CloneIndexResponse	clone(CloneIndexRequest request)	Clones an index
final CloneIndexResponse	clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)	Clones an index
CloseIndexResponse	close(CloseIndexRequest request)	Closes an index.
final CloseIndexResponse	close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)	Closes an index.
CreateIndexResponse	create(CreateIndexRequest request)	Creates an index with optional settings and mappings.
final CreateIndexResponse	create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)	Creates an index with optional settings and mappings.
CreateDataStreamResponse	createDataStream(CreateDataStreamRequest request)	Creates a data stream
final CreateDataStreamResponse	createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)	Creates a data stream
DataStreamsStatsResponse	dataStreamsStats()	Provides statistics on operations happening in a data stream.
DataStreamsStatsResponse	dataStreamsStats(DataStreamsStatsRequest request)	Provides statistics on operations happening in a data stream.
final DataStreamsStatsResponse	dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)	Provides statistics on operations happening in a data stream.
DeleteIndexResponse	delete(DeleteIndexRequest request)	Deletes an index.
final DeleteIndexResponse	delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)	Deletes an index.
DeleteAliasResponse	deleteAlias(DeleteAliasRequest request)	Deletes an alias.
final DeleteAliasResponse	deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Deletes an alias.
DeleteDataStreamResponse	deleteDataStream(DeleteDataStreamRequest request)	Deletes a data stream.
final DeleteDataStreamResponse	deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)	Deletes a data stream.
DeleteIndexTemplateResponse	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Deletes an index template.
final DeleteIndexTemplateResponse	deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Deletes an index template.
DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest request)	Deletes an index template.
final DeleteTemplateResponse	deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes an index template.
DiskUsageResponse	diskUsage(DiskUsageRequest request)	Analyzes the disk usage of each field of an index or data stream
final DiskUsageResponse	diskUsage(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)	Analyzes the disk usage of each field of an index or data stream
BooleanResponse	exists(ExistsRequest request)	Returns information about whether a particular index exists.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a particular index exists.
BooleanResponse	existsAlias(ExistsAliasRequest request)	Returns information about whether a particular alias exists.
final BooleanResponse	existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)	Returns information about whether a particular alias exists.
BooleanResponse	existsIndexTemplate(ExistsIndexTemplateRequest request)	Returns information about whether a particular index template exists.
final BooleanResponse	existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)	Returns information about whether a particular index template exists.
BooleanResponse	existsTemplate(ExistsTemplateRequest request)	Returns information about whether a particular index template exists.
final BooleanResponse	existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)	Returns information about whether a particular index template exists.
BooleanResponse	existsType(ExistsTypeRequest request)	Returns information about whether a particular document type exists.
final BooleanResponse	existsType(Function<ExistsTypeRequest.Builder,ObjectBuilder<ExistsTypeRequest>> fn)	Returns information about whether a particular document type exists.
FlushResponse	flush()	Performs the flush operation on one or more indices.
FlushResponse	flush(FlushRequest request)	Performs the flush operation on one or more indices.
final FlushResponse	flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Performs the flush operation on one or more indices.
FlushSyncedResponse	flushSynced()	Performs a synced flush operation on one or more indices.
FlushSyncedResponse	flushSynced(FlushSyncedRequest request)	Performs a synced flush operation on one or more indices.
final FlushSyncedResponse	flushSynced(Function<FlushSyncedRequest.Builder,ObjectBuilder<FlushSyncedRequest>> fn)	Performs a synced flush operation on one or more indices.
ForcemergeResponse	forcemerge()	Performs the force merge operation on one or more indices.
ForcemergeResponse	forcemerge(ForcemergeRequest request)	Performs the force merge operation on one or more indices.
final ForcemergeResponse	forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)	Performs the force merge operation on one or more indices.
FreezeResponse	freeze(FreezeRequest request)	Freezes an index.
final FreezeResponse	freeze(Function<FreezeRequest.Builder,ObjectBuilder<FreezeRequest>> fn)	Freezes an index.
GetIndexResponse	get(GetIndexRequest request)	Returns information about one or more indices.
final GetIndexResponse	get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)	Returns information about one or more indices.
GetAliasResponse	getAlias()	Returns an alias.
GetAliasResponse	getAlias(GetAliasRequest request)	Returns an alias.
final GetAliasResponse	getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Returns an alias.
GetDataStreamResponse	getDataStream()	Returns data streams.
GetDataStreamResponse	getDataStream(GetDataStreamRequest request)	Returns data streams.
final GetDataStreamResponse	getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)	Returns data streams.
GetFieldMappingResponse	getFieldMapping(GetFieldMappingRequest request)	Returns mapping for one or more fields.
final GetFieldMappingResponse	getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)	Returns mapping for one or more fields.
GetIndexTemplateResponse	getIndexTemplate()	Returns an index template.
GetIndexTemplateResponse	getIndexTemplate(GetIndexTemplateRequest request)	Returns an index template.
final GetIndexTemplateResponse	getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Returns an index template.
GetMappingResponse	getMapping()	Returns mappings for one or more indices.
GetMappingResponse	getMapping(GetMappingRequest request)	Returns mappings for one or more indices.
final GetMappingResponse	getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Returns mappings for one or more indices.
GetIndicesSettingsResponse	getSettings()	Returns settings for one or more indices.
GetIndicesSettingsResponse	getSettings(GetIndicesSettingsRequest request)	Returns settings for one or more indices.
final GetIndicesSettingsResponse	getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)	Returns settings for one or more indices.
GetTemplateResponse	getTemplate()	Returns an index template.
GetTemplateResponse	getTemplate(GetTemplateRequest request)	Returns an index template.
final GetTemplateResponse	getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Returns an index template.
GetUpgradeResponse	getUpgrade()	DEPRECATED Returns a progress status of current upgrade.
GetUpgradeResponse	getUpgrade(GetUpgradeRequest request)	DEPRECATED Returns a progress status of current upgrade.
final GetUpgradeResponse	getUpgrade(Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn)	DEPRECATED Returns a progress status of current upgrade.
MigrateToDataStreamResponse	migrateToDataStream(MigrateToDataStreamRequest request)	Migrates an alias to a data stream
final MigrateToDataStreamResponse	migrateToDataStream(Function<MigrateToDataStreamRequest.Builder,ObjectBuilder<MigrateToDataStreamRequest>> fn)	Migrates an alias to a data stream
OpenResponse	open(OpenRequest request)	Opens an index.
final OpenResponse	open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens an index.
PromoteDataStreamResponse	promoteDataStream(PromoteDataStreamRequest request)	Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
final PromoteDataStreamResponse	promoteDataStream(Function<PromoteDataStreamRequest.Builder,ObjectBuilder<PromoteDataStreamRequest>> fn)	Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
PutAliasResponse	putAlias(PutAliasRequest request)	Creates or updates an alias.
final PutAliasResponse	putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Creates or updates an alias.
PutIndexTemplateResponse	putIndexTemplate(PutIndexTemplateRequest request)	Creates or updates an index template.
final PutIndexTemplateResponse	putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Creates or updates an index template.
PutMappingResponse	putMapping(PutMappingRequest request)	Updates the index mappings.
final PutMappingResponse	putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Updates the index mappings.
PutIndicesSettingsResponse	putSettings()	Updates the index settings.
PutIndicesSettingsResponse	putSettings(PutIndicesSettingsRequest request)	Updates the index settings.
final PutIndicesSettingsResponse	putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	Updates the index settings.
PutTemplateResponse	putTemplate(PutTemplateRequest request)	Creates or updates an index template.
final PutTemplateResponse	putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Creates or updates an index template.
RecoveryResponse	recovery()	Returns information about ongoing index shard recoveries.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about ongoing index shard recoveries.
final RecoveryResponse	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing index shard recoveries.
RefreshResponse	refresh()	Performs the refresh operation in one or more indices.
RefreshResponse	refresh(RefreshRequest request)	Performs the refresh operation in one or more indices.
final RefreshResponse	refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	Performs the refresh operation in one or more indices.
ReloadSearchAnalyzersResponse	reloadSearchAnalyzers(ReloadSearchAnalyzersRequest request)	Reloads an index's search analyzers and their resources.
final ReloadSearchAnalyzersResponse	reloadSearchAnalyzers(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)	Reloads an index's search analyzers and their resources.
ResolveIndexResponse	resolveIndex(ResolveIndexRequest request)	Returns information about any matching indices, aliases, and data streams
final ResolveIndexResponse	resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Returns information about any matching indices, aliases, and data streams
RolloverResponse	rollover(RolloverRequest request)	Updates an alias to point to a new index when the existing index is considered to be too large or too old.
final RolloverResponse	rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)	Updates an alias to point to a new index when the existing index is considered to be too large or too old.
SegmentsResponse	segments()	Provides low-level information about segments in a Lucene index.
SegmentsResponse	segments(SegmentsRequest request)	Provides low-level information about segments in a Lucene index.
final SegmentsResponse	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Provides low-level information about segments in a Lucene index.
ShardStoresResponse	shardStores()	Provides store information for shard copies of indices.
ShardStoresResponse	shardStores(ShardStoresRequest request)	Provides store information for shard copies of indices.
final ShardStoresResponse	shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Provides store information for shard copies of indices.
ShrinkResponse	shrink(ShrinkRequest request)	Allow to shrink an existing index into a new index with fewer primary shards.
final ShrinkResponse	shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)	Allow to shrink an existing index into a new index with fewer primary shards.
SimulateIndexTemplateResponse	simulateIndexTemplate(SimulateIndexTemplateRequest request)	Simulate matching the given index name against the index templates in the system
final SimulateIndexTemplateResponse	simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)	Simulate matching the given index name against the index templates in the system
SimulateTemplateResponse	simulateTemplate()	Simulate resolving the given template name or body
SimulateTemplateResponse	simulateTemplate(SimulateTemplateRequest request)	Simulate resolving the given template name or body
final SimulateTemplateResponse	simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)	Simulate resolving the given template name or body
SplitResponse	split(SplitRequest request)	Allows you to split an existing index into a new index with more primary shards.
final SplitResponse	split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)	Allows you to split an existing index into a new index with more primary shards.
IndicesStatsResponse	stats()	Provides statistics on operations happening in an index.
IndicesStatsResponse	stats(IndicesStatsRequest request)	Provides statistics on operations happening in an index.
final IndicesStatsResponse	stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)	Provides statistics on operations happening in an index.
UnfreezeResponse	unfreeze(UnfreezeRequest request)	Unfreezes an index.
final UnfreezeResponse	unfreeze(Function<UnfreezeRequest.Builder,ObjectBuilder<UnfreezeRequest>> fn)	Unfreezes an index.
UpdateAliasesResponse	updateAliases()	Updates index aliases.
UpdateAliasesResponse	updateAliases(UpdateAliasesRequest request)	Updates index aliases.
final UpdateAliasesResponse	updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Updates index aliases.
UpgradeResponse	upgrade()	DEPRECATED Upgrades to the current version of Lucene.
UpgradeResponse	upgrade(UpgradeRequest request)	DEPRECATED Upgrades to the current version of Lucene.
final UpgradeResponse	upgrade(Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)	DEPRECATED Upgrades to the current version of Lucene.
ValidateQueryResponse	validateQuery()	Allows a user to validate a potentially expensive query without executing it.
ValidateQueryResponse	validateQuery(ValidateQueryRequest request)	Allows a user to validate a potentially expensive query without executing it.
final ValidateQueryResponse	validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)	Allows a user to validate a potentially expensive query without executing it.
ElasticsearchIndicesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchIndicesClient

public ElasticsearchIndicesClient(ElasticsearchTransport transport)

ElasticsearchIndicesClient

public ElasticsearchIndicesClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchIndicesClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchIndicesClient>

addBlock

public AddBlockResponse addBlock(AddBlockRequest request)
                          throws IOException,
ElasticsearchException

Adds a block to an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

addBlock

public final AddBlockResponse addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)
                                throws IOException,
ElasticsearchException

Adds a block to an index.

Parameters:

fn - a function that initializes a builder to create the AddBlockRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

analyze

public AnalyzeResponse analyze(AnalyzeRequest request)
                        throws IOException,
ElasticsearchException

Performs the analysis process on a text and return the tokens breakdown of the text.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

analyze

public final AnalyzeResponse analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)
                              throws IOException,
ElasticsearchException

Performs the analysis process on a text and return the tokens breakdown of the text.

Parameters:

fn - a function that initializes a builder to create the AnalyzeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

analyze

public AnalyzeResponse analyze()
                        throws IOException,
ElasticsearchException

Performs the analysis process on a text and return the tokens breakdown of the text.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request)
                              throws IOException,
ElasticsearchException

Clears all or specific caches for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public final ClearCacheResponse clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
                                    throws IOException,
ElasticsearchException

Clears all or specific caches for one or more indices.

Parameters:

fn - a function that initializes a builder to create the ClearCacheRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache()
                              throws IOException,
ElasticsearchException

Clears all or specific caches for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clone

public CloneIndexResponse clone(CloneIndexRequest request)
                         throws IOException,
ElasticsearchException

Clones an index

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clone

public final CloneIndexResponse clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)
                               throws IOException,
ElasticsearchException

Clones an index

Parameters:

fn - a function that initializes a builder to create the CloneIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

close

public CloseIndexResponse close(CloseIndexRequest request)
                         throws IOException,
ElasticsearchException

Closes an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

close

public final CloseIndexResponse close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)
                               throws IOException,
ElasticsearchException

Closes an index.

Parameters:

fn - a function that initializes a builder to create the CloseIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

public CreateIndexResponse create(CreateIndexRequest request)
                           throws IOException,
ElasticsearchException

Creates an index with optional settings and mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

public final CreateIndexResponse create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)
                                 throws IOException,
ElasticsearchException

Creates an index with optional settings and mappings.

Parameters:

fn - a function that initializes a builder to create the CreateIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createDataStream

public CreateDataStreamResponse createDataStream(CreateDataStreamRequest request)
                                          throws IOException,
ElasticsearchException

Creates a data stream

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createDataStream

public final CreateDataStreamResponse createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)
                                                throws IOException,
ElasticsearchException

Creates a data stream

Parameters:

fn - a function that initializes a builder to create the CreateDataStreamRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

dataStreamsStats

public DataStreamsStatsResponse dataStreamsStats(DataStreamsStatsRequest request)
                                          throws IOException,
ElasticsearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

dataStreamsStats

public final DataStreamsStatsResponse dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)
                                                throws IOException,
ElasticsearchException

Provides statistics on operations happening in a data stream.

Parameters:

fn - a function that initializes a builder to create the DataStreamsStatsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

dataStreamsStats

public DataStreamsStatsResponse dataStreamsStats()
                                          throws IOException,
ElasticsearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public DeleteIndexResponse delete(DeleteIndexRequest request)
                           throws IOException,
ElasticsearchException

Deletes an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public final DeleteIndexResponse delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)
                                 throws IOException,
ElasticsearchException

Deletes an index.

Parameters:

fn - a function that initializes a builder to create the DeleteIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAlias

public DeleteAliasResponse deleteAlias(DeleteAliasRequest request)
                                throws IOException,
ElasticsearchException

Deletes an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAlias

public final DeleteAliasResponse deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)
                                      throws IOException,
ElasticsearchException

Deletes an alias.

Parameters:

fn - a function that initializes a builder to create the DeleteAliasRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataStream

public DeleteDataStreamResponse deleteDataStream(DeleteDataStreamRequest request)
                                          throws IOException,
ElasticsearchException

Deletes a data stream.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataStream

public final DeleteDataStreamResponse deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)
                                                throws IOException,
ElasticsearchException

Deletes a data stream.

Parameters:

fn - a function that initializes a builder to create the DeleteDataStreamRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteIndexTemplate

public DeleteIndexTemplateResponse deleteIndexTemplate(DeleteIndexTemplateRequest request)
                                                throws IOException,
ElasticsearchException

Deletes an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteIndexTemplate

public final DeleteIndexTemplateResponse deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Deletes an index template.

Parameters:

fn - a function that initializes a builder to create the DeleteIndexTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTemplate

public DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest request)
                                      throws IOException,
ElasticsearchException

Deletes an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteTemplate

public final DeleteTemplateResponse deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)
                                            throws IOException,
ElasticsearchException

Deletes an index template.

Parameters:

fn - a function that initializes a builder to create the DeleteTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

diskUsage

public DiskUsageResponse diskUsage(DiskUsageRequest request)
                            throws IOException,
ElasticsearchException

Analyzes the disk usage of each field of an index or data stream

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

diskUsage

public final DiskUsageResponse diskUsage(Function<DiskUsageRequest.Builder,ObjectBuilder<DiskUsageRequest>> fn)
                                  throws IOException,
ElasticsearchException

Analyzes the disk usage of each field of an index or data stream

Parameters:

fn - a function that initializes a builder to create the DiskUsageRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

public BooleanResponse exists(ExistsRequest request)
                       throws IOException,
ElasticsearchException

Returns information about whether a particular index exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

public final BooleanResponse exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
                             throws IOException,
ElasticsearchException

Returns information about whether a particular index exists.

Parameters:

fn - a function that initializes a builder to create the ExistsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsAlias

public BooleanResponse existsAlias(ExistsAliasRequest request)
                            throws IOException,
ElasticsearchException

Returns information about whether a particular alias exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsAlias

public final BooleanResponse existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)
                                  throws IOException,
ElasticsearchException

Returns information about whether a particular alias exists.

Parameters:

fn - a function that initializes a builder to create the ExistsAliasRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsIndexTemplate

public BooleanResponse existsIndexTemplate(ExistsIndexTemplateRequest request)
                                    throws IOException,
ElasticsearchException

Returns information about whether a particular index template exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsIndexTemplate

public final BooleanResponse existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)
                                          throws IOException,
ElasticsearchException

Returns information about whether a particular index template exists.

Parameters:

fn - a function that initializes a builder to create the ExistsIndexTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsTemplate

public BooleanResponse existsTemplate(ExistsTemplateRequest request)
                               throws IOException,
ElasticsearchException

Returns information about whether a particular index template exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsTemplate

public final BooleanResponse existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)
                                     throws IOException,
ElasticsearchException

Returns information about whether a particular index template exists.

Parameters:

fn - a function that initializes a builder to create the ExistsTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsType

public BooleanResponse existsType(ExistsTypeRequest request)
                           throws IOException,
ElasticsearchException

Returns information about whether a particular document type exists. (DEPRECATED)

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsType

public final BooleanResponse existsType(Function<ExistsTypeRequest.Builder,ObjectBuilder<ExistsTypeRequest>> fn)
                                 throws IOException,
ElasticsearchException

Returns information about whether a particular document type exists. (DEPRECATED)

Parameters:

fn - a function that initializes a builder to create the ExistsTypeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flush

public FlushResponse flush(FlushRequest request)
                    throws IOException,
ElasticsearchException

Performs the flush operation on one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flush

public final FlushResponse flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)
                          throws IOException,
ElasticsearchException

Performs the flush operation on one or more indices.

Parameters:

fn - a function that initializes a builder to create the FlushRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flush

public FlushResponse flush()
                    throws IOException,
ElasticsearchException

Performs the flush operation on one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flushSynced

public FlushSyncedResponse flushSynced(FlushSyncedRequest request)
                                throws IOException,
ElasticsearchException

Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flushSynced

public final FlushSyncedResponse flushSynced(Function<FlushSyncedRequest.Builder,ObjectBuilder<FlushSyncedRequest>> fn)
                                      throws IOException,
ElasticsearchException

Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead

Parameters:

fn - a function that initializes a builder to create the FlushSyncedRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flushSynced

public FlushSyncedResponse flushSynced()
                                throws IOException,
ElasticsearchException

Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forcemerge

public ForcemergeResponse forcemerge(ForcemergeRequest request)
                              throws IOException,
ElasticsearchException

Performs the force merge operation on one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forcemerge

public final ForcemergeResponse forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)
                                    throws IOException,
ElasticsearchException

Performs the force merge operation on one or more indices.

Parameters:

fn - a function that initializes a builder to create the ForcemergeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forcemerge

public ForcemergeResponse forcemerge()
                              throws IOException,
ElasticsearchException

Performs the force merge operation on one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

freeze

public FreezeResponse freeze(FreezeRequest request)
                      throws IOException,
ElasticsearchException

Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

freeze

public final FreezeResponse freeze(Function<FreezeRequest.Builder,ObjectBuilder<FreezeRequest>> fn)
                            throws IOException,
ElasticsearchException

Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only.

Parameters:

fn - a function that initializes a builder to create the FreezeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetIndexResponse get(GetIndexRequest request)
                     throws IOException,
ElasticsearchException

Returns information about one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final GetIndexResponse get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)
                           throws IOException,
ElasticsearchException

Returns information about one or more indices.

Parameters:

fn - a function that initializes a builder to create the GetIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAlias

public GetAliasResponse getAlias(GetAliasRequest request)
                          throws IOException,
ElasticsearchException

Returns an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAlias

public final GetAliasResponse getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)
                                throws IOException,
ElasticsearchException

Returns an alias.

Parameters:

fn - a function that initializes a builder to create the GetAliasRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAlias

public GetAliasResponse getAlias()
                          throws IOException,
ElasticsearchException

Returns an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataStream

public GetDataStreamResponse getDataStream(GetDataStreamRequest request)
                                    throws IOException,
ElasticsearchException

Returns data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataStream

public final GetDataStreamResponse getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)
                                          throws IOException,
ElasticsearchException

Returns data streams.

Parameters:

fn - a function that initializes a builder to create the GetDataStreamRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataStream

public GetDataStreamResponse getDataStream()
                                    throws IOException,
ElasticsearchException

Returns data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFieldMapping

public GetFieldMappingResponse getFieldMapping(GetFieldMappingRequest request)
                                        throws IOException,
ElasticsearchException

Returns mapping for one or more fields.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFieldMapping

public final GetFieldMappingResponse getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)
                                              throws IOException,
ElasticsearchException

Returns mapping for one or more fields.

Parameters:

fn - a function that initializes a builder to create the GetFieldMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIndexTemplate

public GetIndexTemplateResponse getIndexTemplate(GetIndexTemplateRequest request)
                                          throws IOException,
ElasticsearchException

Returns an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIndexTemplate

public final GetIndexTemplateResponse getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)
                                                throws IOException,
ElasticsearchException

Returns an index template.

Parameters:

fn - a function that initializes a builder to create the GetIndexTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIndexTemplate

public GetIndexTemplateResponse getIndexTemplate()
                                          throws IOException,
ElasticsearchException

Returns an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMapping

public GetMappingResponse getMapping(GetMappingRequest request)
                              throws IOException,
ElasticsearchException

Returns mappings for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMapping

public final GetMappingResponse getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)
                                    throws IOException,
ElasticsearchException

Returns mappings for one or more indices.

Parameters:

fn - a function that initializes a builder to create the GetMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMapping

public GetMappingResponse getMapping()
                              throws IOException,
ElasticsearchException

Returns mappings for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetIndicesSettingsResponse getSettings(GetIndicesSettingsRequest request)
                                       throws IOException,
ElasticsearchException

Returns settings for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public final GetIndicesSettingsResponse getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)
                                             throws IOException,
ElasticsearchException

Returns settings for one or more indices.

Parameters:

fn - a function that initializes a builder to create the GetIndicesSettingsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetIndicesSettingsResponse getSettings()
                                       throws IOException,
ElasticsearchException

Returns settings for one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTemplate

public GetTemplateResponse getTemplate(GetTemplateRequest request)
                                throws IOException,
ElasticsearchException

Returns an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTemplate

public final GetTemplateResponse getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)
                                      throws IOException,
ElasticsearchException

Returns an index template.

Parameters:

fn - a function that initializes a builder to create the GetTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTemplate

public GetTemplateResponse getTemplate()
                                throws IOException,
ElasticsearchException

Returns an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUpgrade

public GetUpgradeResponse getUpgrade(GetUpgradeRequest request)
                              throws IOException,
ElasticsearchException

DEPRECATED Returns a progress status of current upgrade.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUpgrade

public final GetUpgradeResponse getUpgrade(Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn)
                                    throws IOException,
ElasticsearchException

DEPRECATED Returns a progress status of current upgrade.

Parameters:

fn - a function that initializes a builder to create the GetUpgradeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUpgrade

public GetUpgradeResponse getUpgrade()
                              throws IOException,
ElasticsearchException

DEPRECATED Returns a progress status of current upgrade.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataStream

public MigrateToDataStreamResponse migrateToDataStream(MigrateToDataStreamRequest request)
                                                throws IOException,
ElasticsearchException

Migrates an alias to a data stream

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataStream

public final MigrateToDataStreamResponse migrateToDataStream(Function<MigrateToDataStreamRequest.Builder,ObjectBuilder<MigrateToDataStreamRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Migrates an alias to a data stream

Parameters:

fn - a function that initializes a builder to create the MigrateToDataStreamRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

open

public OpenResponse open(OpenRequest request)
                  throws IOException,
ElasticsearchException

Opens an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

open

public final OpenResponse open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)
                        throws IOException,
ElasticsearchException

Opens an index.

Parameters:

fn - a function that initializes a builder to create the OpenRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

promoteDataStream

public PromoteDataStreamResponse promoteDataStream(PromoteDataStreamRequest request)
                                            throws IOException,
ElasticsearchException

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

promoteDataStream

public final PromoteDataStreamResponse promoteDataStream(Function<PromoteDataStreamRequest.Builder,ObjectBuilder<PromoteDataStreamRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

Parameters:

fn - a function that initializes a builder to create the PromoteDataStreamRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAlias

public PutAliasResponse putAlias(PutAliasRequest request)
                          throws IOException,
ElasticsearchException

Creates or updates an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAlias

public final PutAliasResponse putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)
                                throws IOException,
ElasticsearchException

Creates or updates an alias.

Parameters:

fn - a function that initializes a builder to create the PutAliasRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIndexTemplate

public PutIndexTemplateResponse putIndexTemplate(PutIndexTemplateRequest request)
                                          throws IOException,
ElasticsearchException

Creates or updates an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIndexTemplate

public final PutIndexTemplateResponse putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)
                                                throws IOException,
ElasticsearchException

Creates or updates an index template.

Parameters:

fn - a function that initializes a builder to create the PutIndexTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putMapping

public PutMappingResponse putMapping(PutMappingRequest request)
                              throws IOException,
ElasticsearchException

Updates the index mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putMapping

public final PutMappingResponse putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)
                                    throws IOException,
ElasticsearchException

Updates the index mappings.

Parameters:

fn - a function that initializes a builder to create the PutMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public PutIndicesSettingsResponse putSettings(PutIndicesSettingsRequest request)
                                       throws IOException,
ElasticsearchException

Updates the index settings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public final PutIndicesSettingsResponse putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)
                                             throws IOException,
ElasticsearchException

Updates the index settings.

Parameters:

fn - a function that initializes a builder to create the PutIndicesSettingsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public PutIndicesSettingsResponse putSettings()
                                       throws IOException,
ElasticsearchException

Updates the index settings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTemplate

public PutTemplateResponse putTemplate(PutTemplateRequest request)
                                throws IOException,
ElasticsearchException

Creates or updates an index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTemplate

public final PutTemplateResponse putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)
                                      throws IOException,
ElasticsearchException

Creates or updates an index template.

Parameters:

fn - a function that initializes a builder to create the PutTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery(RecoveryRequest request)
                          throws IOException,
ElasticsearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public final RecoveryResponse recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)
                                throws IOException,
ElasticsearchException

Returns information about ongoing index shard recoveries.

Parameters:

fn - a function that initializes a builder to create the RecoveryRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

recovery

public RecoveryResponse recovery()
                          throws IOException,
ElasticsearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

refresh

public RefreshResponse refresh(RefreshRequest request)
                        throws IOException,
ElasticsearchException

Performs the refresh operation in one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

refresh

public final RefreshResponse refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)
                              throws IOException,
ElasticsearchException

Performs the refresh operation in one or more indices.

Parameters:

fn - a function that initializes a builder to create the RefreshRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

refresh

public RefreshResponse refresh()
                        throws IOException,
ElasticsearchException

Performs the refresh operation in one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reloadSearchAnalyzers

public ReloadSearchAnalyzersResponse reloadSearchAnalyzers(ReloadSearchAnalyzersRequest request)
                                                    throws IOException,
ElasticsearchException

Reloads an index's search analyzers and their resources.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reloadSearchAnalyzers

public final ReloadSearchAnalyzersResponse reloadSearchAnalyzers(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Reloads an index's search analyzers and their resources.

Parameters:

fn - a function that initializes a builder to create the ReloadSearchAnalyzersRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resolveIndex

public ResolveIndexResponse resolveIndex(ResolveIndexRequest request)
                                  throws IOException,
ElasticsearchException

Returns information about any matching indices, aliases, and data streams

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resolveIndex

public final ResolveIndexResponse resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)
                                        throws IOException,
ElasticsearchException

Returns information about any matching indices, aliases, and data streams

Parameters:

fn - a function that initializes a builder to create the ResolveIndexRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollover

public RolloverResponse rollover(RolloverRequest request)
                          throws IOException,
ElasticsearchException

Updates an alias to point to a new index when the existing index is considered to be too large or too old.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollover

public final RolloverResponse rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)
                                throws IOException,
ElasticsearchException

Updates an alias to point to a new index when the existing index is considered to be too large or too old.

Parameters:

fn - a function that initializes a builder to create the RolloverRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments(SegmentsRequest request)
                          throws IOException,
ElasticsearchException

Provides low-level information about segments in a Lucene index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public final SegmentsResponse segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)
                                throws IOException,
ElasticsearchException

Provides low-level information about segments in a Lucene index.

Parameters:

fn - a function that initializes a builder to create the SegmentsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

public SegmentsResponse segments()
                          throws IOException,
ElasticsearchException

Provides low-level information about segments in a Lucene index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shardStores

public ShardStoresResponse shardStores(ShardStoresRequest request)
                                throws IOException,
ElasticsearchException

Provides store information for shard copies of indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shardStores

public final ShardStoresResponse shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)
                                      throws IOException,
ElasticsearchException

Provides store information for shard copies of indices.

Parameters:

fn - a function that initializes a builder to create the ShardStoresRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shardStores

public ShardStoresResponse shardStores()
                                throws IOException,
ElasticsearchException

Provides store information for shard copies of indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shrink

public ShrinkResponse shrink(ShrinkRequest request)
                      throws IOException,
ElasticsearchException

Allow to shrink an existing index into a new index with fewer primary shards.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shrink

public final ShrinkResponse shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)
                            throws IOException,
ElasticsearchException

Allow to shrink an existing index into a new index with fewer primary shards.

Parameters:

fn - a function that initializes a builder to create the ShrinkRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateIndexTemplate

public SimulateIndexTemplateResponse simulateIndexTemplate(SimulateIndexTemplateRequest request)
                                                    throws IOException,
ElasticsearchException

Simulate matching the given index name against the index templates in the system

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateIndexTemplate

public final SimulateIndexTemplateResponse simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Simulate matching the given index name against the index templates in the system

Parameters:

fn - a function that initializes a builder to create the SimulateIndexTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateTemplate

public SimulateTemplateResponse simulateTemplate(SimulateTemplateRequest request)
                                          throws IOException,
ElasticsearchException

Simulate resolving the given template name or body

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateTemplate

public final SimulateTemplateResponse simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)
                                                throws IOException,
ElasticsearchException

Simulate resolving the given template name or body

Parameters:

fn - a function that initializes a builder to create the SimulateTemplateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateTemplate

public SimulateTemplateResponse simulateTemplate()
                                          throws IOException,
ElasticsearchException

Simulate resolving the given template name or body

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

split

public SplitResponse split(SplitRequest request)
                    throws IOException,
ElasticsearchException

Allows you to split an existing index into a new index with more primary shards.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

split

public final SplitResponse split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)
                          throws IOException,
ElasticsearchException

Allows you to split an existing index into a new index with more primary shards.

Parameters:

fn - a function that initializes a builder to create the SplitRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public IndicesStatsResponse stats(IndicesStatsRequest request)
                           throws IOException,
ElasticsearchException

Provides statistics on operations happening in an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public final IndicesStatsResponse stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)
                                 throws IOException,
ElasticsearchException

Provides statistics on operations happening in an index.

Parameters:

fn - a function that initializes a builder to create the IndicesStatsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public IndicesStatsResponse stats()
                           throws IOException,
ElasticsearchException

Provides statistics on operations happening in an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

unfreeze

public UnfreezeResponse unfreeze(UnfreezeRequest request)
                          throws IOException,
ElasticsearchException

Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

unfreeze

public final UnfreezeResponse unfreeze(Function<UnfreezeRequest.Builder,ObjectBuilder<UnfreezeRequest>> fn)
                                throws IOException,
ElasticsearchException

Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

Parameters:

fn - a function that initializes a builder to create the UnfreezeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateAliases

public UpdateAliasesResponse updateAliases(UpdateAliasesRequest request)
                                    throws IOException,
ElasticsearchException

Updates index aliases.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateAliases

public final UpdateAliasesResponse updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)
                                          throws IOException,
ElasticsearchException

Updates index aliases.

Parameters:

fn - a function that initializes a builder to create the UpdateAliasesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateAliases

public UpdateAliasesResponse updateAliases()
                                    throws IOException,
ElasticsearchException

Updates index aliases.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgrade

public UpgradeResponse upgrade(UpgradeRequest request)
                        throws IOException,
ElasticsearchException

DEPRECATED Upgrades to the current version of Lucene.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgrade

public final UpgradeResponse upgrade(Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)
                              throws IOException,
ElasticsearchException

DEPRECATED Upgrades to the current version of Lucene.

Parameters:

fn - a function that initializes a builder to create the UpgradeRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

upgrade

public UpgradeResponse upgrade()
                        throws IOException,
ElasticsearchException

DEPRECATED Upgrades to the current version of Lucene.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateQuery

public ValidateQueryResponse validateQuery(ValidateQueryRequest request)
                                    throws IOException,
ElasticsearchException

Allows a user to validate a potentially expensive query without executing it.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateQuery

public final ValidateQueryResponse validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)
                                          throws IOException,
ElasticsearchException

Allows a user to validate a potentially expensive query without executing it.

Parameters:

fn - a function that initializes a builder to create the ValidateQueryRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateQuery

public ValidateQueryResponse validateQuery()
                                    throws IOException,
ElasticsearchException

Allows a user to validate a potentially expensive query without executing it.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co