Package co.elastic.clients.elasticsearch.indices

Class ElasticsearchIndicesClient

java.lang.Object

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

co.elastic.clients.elasticsearch.indices.ElasticsearchIndicesClient

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 analysis on a text string and returns the resulting tokens.
AnalyzeResponse	analyze(AnalyzeRequest request)	Performs analysis on a text string and returns the resulting tokens.
final AnalyzeResponse	analyze(Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)	Performs analysis on a text string and returns the resulting tokens.
ClearCacheResponse	clearCache()	Clears the caches of one or more indices.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clears the caches of one or more indices.
final ClearCacheResponse	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears the caches of one or more indices.
CloneIndexResponse	clone(CloneIndexRequest request)	Clones an existing index.
final CloneIndexResponse	clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)	Clones an existing 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 a new index.
final CreateIndexResponse	create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)	Creates a new index.
CreateDataStreamResponse	createDataStream(CreateDataStreamRequest request)	Creates a data stream.
final CreateDataStreamResponse	createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)	Creates a data stream.
DataStreamsStatsResponse	dataStreamsStats()	Retrieves statistics for one or more data streams.
DataStreamsStatsResponse	dataStreamsStats(DataStreamsStatsRequest request)	Retrieves statistics for one or more data streams.
final DataStreamsStatsResponse	dataStreamsStats(Function<DataStreamsStatsRequest.Builder,ObjectBuilder<DataStreamsStatsRequest>> fn)	Retrieves statistics for one or more data streams.
DeleteIndexResponse	delete(DeleteIndexRequest request)	Deletes one or more indices.
final DeleteIndexResponse	delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)	Deletes one or more indices.
DeleteAliasResponse	deleteAlias(DeleteAliasRequest request)	Removes a data stream or index from an alias.
final DeleteAliasResponse	deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Removes a data stream or index from an alias.
DeleteDataLifecycleResponse	deleteDataLifecycle(DeleteDataLifecycleRequest request)	Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle
final DeleteDataLifecycleResponse	deleteDataLifecycle(Function<DeleteDataLifecycleRequest.Builder,ObjectBuilder<DeleteDataLifecycleRequest>> fn)	Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle
DeleteDataStreamResponse	deleteDataStream(DeleteDataStreamRequest request)	Deletes one or more data streams and their backing indices.
final DeleteDataStreamResponse	deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)	Deletes one or more data streams and their backing indices.
DeleteIndexTemplateResponse	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Delete an index template.
final DeleteIndexTemplateResponse	deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Delete an index template.
DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest request)	Deletes a legacy index template.
final DeleteTemplateResponse	deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes a legacy 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.
DownsampleResponse	downsample(DownsampleRequest request)	Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.
final DownsampleResponse	downsample(Function<DownsampleRequest.Builder,ObjectBuilder<DownsampleRequest>> fn)	Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.
BooleanResponse	exists(ExistsRequest request)	Checks if a data stream, index, or alias exists.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Checks if a data stream, index, or alias exists.
BooleanResponse	existsAlias(ExistsAliasRequest request)	Checks if an alias exists.
final BooleanResponse	existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)	Checks if an 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)	Check existence of index templates.
final BooleanResponse	existsTemplate(Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn)	Check existence of index templates.
ExplainDataLifecycleResponse	explainDataLifecycle(ExplainDataLifecycleRequest request)	Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
final ExplainDataLifecycleResponse	explainDataLifecycle(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)	Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
FieldUsageStatsResponse	fieldUsageStats(FieldUsageStatsRequest request)	Returns field usage information for each shard and field of an index.
final FieldUsageStatsResponse	fieldUsageStats(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)	Returns field usage information for each shard and field of an index.
FlushResponse	flush()	Flushes one or more data streams or indices.
FlushResponse	flush(FlushRequest request)	Flushes one or more data streams or indices.
final FlushResponse	flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Flushes one or more data streams or 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.
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()	Retrieves information for one or more aliases.
GetAliasResponse	getAlias(GetAliasRequest request)	Retrieves information for one or more aliases.
final GetAliasResponse	getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Retrieves information for one or more aliases.
GetDataLifecycleResponse	getDataLifecycle(GetDataLifecycleRequest request)	Retrieves the data stream lifecycle configuration of one or more data streams.
final GetDataLifecycleResponse	getDataLifecycle(Function<GetDataLifecycleRequest.Builder,ObjectBuilder<GetDataLifecycleRequest>> fn)	Retrieves the data stream lifecycle configuration of one or more data streams.
GetDataStreamResponse	getDataStream()	Retrieves information about one or more data streams.
GetDataStreamResponse	getDataStream(GetDataStreamRequest request)	Retrieves information about one or more data streams.
final GetDataStreamResponse	getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)	Retrieves information about one or more data streams.
GetFieldMappingResponse	getFieldMapping(GetFieldMappingRequest request)	Retrieves mapping definitions for one or more fields.
final GetFieldMappingResponse	getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)	Retrieves mapping definitions for one or more fields.
GetIndexTemplateResponse	getIndexTemplate()	Get index templates.
GetIndexTemplateResponse	getIndexTemplate(GetIndexTemplateRequest request)	Get index templates.
final GetIndexTemplateResponse	getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Get index templates.
GetMappingResponse	getMapping()	Retrieves mapping definitions for one or more indices.
GetMappingResponse	getMapping(GetMappingRequest request)	Retrieves mapping definitions for one or more indices.
final GetMappingResponse	getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Retrieves mapping definitions for one or more indices.
GetIndicesSettingsResponse	getSettings()	Returns setting information for one or more indices.
GetIndicesSettingsResponse	getSettings(GetIndicesSettingsRequest request)	Returns setting information for one or more indices.
final GetIndicesSettingsResponse	getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)	Returns setting information for one or more indices.
GetTemplateResponse	getTemplate()	Get index templates.
GetTemplateResponse	getTemplate(GetTemplateRequest request)	Get index templates.
final GetTemplateResponse	getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Get index templates.
MigrateToDataStreamResponse	migrateToDataStream(MigrateToDataStreamRequest request)	Converts an index alias to a data stream.
final MigrateToDataStreamResponse	migrateToDataStream(Function<MigrateToDataStreamRequest.Builder,ObjectBuilder<MigrateToDataStreamRequest>> fn)	Converts an index alias to a data stream.
ModifyDataStreamResponse	modifyDataStream(ModifyDataStreamRequest request)	Performs one or more data stream modification actions in a single atomic operation.
final ModifyDataStreamResponse	modifyDataStream(Function<ModifyDataStreamRequest.Builder,ObjectBuilder<ModifyDataStreamRequest>> fn)	Performs one or more data stream modification actions in a single atomic operation.
OpenResponse	open(OpenRequest request)	Opens a closed index.
final OpenResponse	open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens a closed 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)	Adds a data stream or index to an alias.
final PutAliasResponse	putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Adds a data stream or index to an alias.
PutDataLifecycleResponse	putDataLifecycle(PutDataLifecycleRequest request)	Update the data lifecycle of the specified data streams.
final PutDataLifecycleResponse	putDataLifecycle(Function<PutDataLifecycleRequest.Builder,ObjectBuilder<PutDataLifecycleRequest>> fn)	Update the data lifecycle of the specified data streams.
PutIndexTemplateResponse	putIndexTemplate(PutIndexTemplateRequest request)	Create or update an index template.
final PutIndexTemplateResponse	putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Create or update an index template.
PutMappingResponse	putMapping(PutMappingRequest request)	Adds new fields to an existing data stream or index.
final PutMappingResponse	putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Adds new fields to an existing data stream or index.
PutIndicesSettingsResponse	putSettings()	Changes a dynamic index setting in real time.
PutIndicesSettingsResponse	putSettings(PutIndicesSettingsRequest request)	Changes a dynamic index setting in real time.
final PutIndicesSettingsResponse	putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	Changes a dynamic index setting in real time.
PutTemplateResponse	putTemplate(PutTemplateRequest request)	Create or update an index template.
final PutTemplateResponse	putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Create or update an index template.
RecoveryResponse	recovery()	Returns information about ongoing and completed shard recoveries for one or more indices.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about ongoing and completed shard recoveries for one or more indices.
final RecoveryResponse	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing and completed shard recoveries for one or more indices.
RefreshResponse	refresh()	A refresh makes recent operations performed on one or more indices available for search.
RefreshResponse	refresh(RefreshRequest request)	A refresh makes recent operations performed on one or more indices available for search.
final RefreshResponse	refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	A refresh makes recent operations performed on one or more indices available for search.
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.
ResolveClusterResponse	resolveCluster(ResolveClusterRequest request)	Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
final ResolveClusterResponse	resolveCluster(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> fn)	Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
ResolveIndexResponse	resolveIndex(ResolveIndexRequest request)	Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
final ResolveIndexResponse	resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
RolloverResponse	rollover(RolloverRequest request)	Creates a new index for a data stream or index alias.
final RolloverResponse	rollover(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)	Creates a new index for a data stream or index alias.
SegmentsResponse	segments()	Returns low-level information about the Lucene segments in index shards.
SegmentsResponse	segments(SegmentsRequest request)	Returns low-level information about the Lucene segments in index shards.
final SegmentsResponse	segments(Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn)	Returns low-level information about the Lucene segments in index shards.
ShardStoresResponse	shardStores()	Retrieves store information about replica shards in one or more indices.
ShardStoresResponse	shardStores(ShardStoresRequest request)	Retrieves store information about replica shards in one or more indices.
final ShardStoresResponse	shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Retrieves store information about replica shards in one or more indices.
ShrinkResponse	shrink(ShrinkRequest request)	Shrinks an existing index into a new index with fewer primary shards.
final ShrinkResponse	shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)	Shrinks an existing index into a new index with fewer primary shards.
SimulateIndexTemplateResponse	simulateIndexTemplate(SimulateIndexTemplateRequest request)	Simulate an index.
final SimulateIndexTemplateResponse	simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)	Simulate an index.
SimulateTemplateResponse	simulateTemplate()	Simulate an index template.
SimulateTemplateResponse	simulateTemplate(SimulateTemplateRequest request)	Simulate an index template.
final SimulateTemplateResponse	simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)	Simulate an index template.
SplitResponse	split(SplitRequest request)	Splits an existing index into a new index with more primary shards.
final SplitResponse	split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)	Splits an existing index into a new index with more primary shards.
IndicesStatsResponse	stats()	Returns statistics for one or more indices.
IndicesStatsResponse	stats(IndicesStatsRequest request)	Returns statistics for one or more indices.
final IndicesStatsResponse	stats(Function<IndicesStatsRequest.Builder,ObjectBuilder<IndicesStatsRequest>> fn)	Returns statistics for one or more indices.
UnfreezeResponse	unfreeze(UnfreezeRequest request)	Unfreezes an index.
final UnfreezeResponse	unfreeze(Function<UnfreezeRequest.Builder,ObjectBuilder<UnfreezeRequest>> fn)	Unfreezes an index.
UpdateAliasesResponse	updateAliases()	Adds a data stream or index to an alias.
UpdateAliasesResponse	updateAliases(UpdateAliasesRequest request)	Adds a data stream or index to an alias.
final UpdateAliasesResponse	updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Adds a data stream or index to an alias.
ValidateQueryResponse	validateQuery()	Validates a potentially expensive query without executing it.
ValidateQueryResponse	validateQuery(ValidateQueryRequest request)	Validates a potentially expensive query without executing it.
final ValidateQueryResponse	validateQuery(Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)	Validates 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, 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 analysis on a text string and returns the resulting tokens.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

analyze

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

Performs analysis on a text string and returns the resulting tokens.

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 analysis on a text string and returns the resulting tokens.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request)
                              throws IOException,
ElasticsearchException

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing 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 the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing 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 the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clone

public CloneIndexResponse clone(CloneIndexRequest request)
                         throws IOException,
ElasticsearchException

Clones an existing 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 existing 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 a new index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

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

Creates a new index.

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. You must have a matching index template with data stream enabled.

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. You must have a matching index template with data stream enabled.

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

Retrieves statistics for one or more data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

dataStreamsStats

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

Retrieves statistics for one or more data streams.

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

Retrieves statistics for one or more data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public DeleteIndexResponse delete(DeleteIndexRequest request)
                           throws IOException,
ElasticsearchException

Deletes one or more indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

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

Deletes one or more indices.

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

Removes a data stream or index from 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

Removes a data stream or index from an alias.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataLifecycle

public DeleteDataLifecycleResponse deleteDataLifecycle(DeleteDataLifecycleRequest request)
                                                throws IOException,
ElasticsearchException

Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataLifecycle

public final DeleteDataLifecycleResponse deleteDataLifecycle(Function<DeleteDataLifecycleRequest.Builder,ObjectBuilder<DeleteDataLifecycleRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataStream

public DeleteDataStreamResponse deleteDataStream(DeleteDataStreamRequest request)
                                          throws IOException,
ElasticsearchException

Deletes one or more data streams and their backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteDataStream

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

Deletes one or more data streams and their backing indices.

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

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteIndexTemplate

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

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

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 a legacy 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 a legacy 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

downsample

public DownsampleResponse downsample(DownsampleRequest request)
                              throws IOException,
ElasticsearchException

Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

downsample

public final DownsampleResponse downsample(Function<DownsampleRequest.Builder,ObjectBuilder<DownsampleRequest>> fn)
                                    throws IOException,
ElasticsearchException

Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

public BooleanResponse exists(ExistsRequest request)
                       throws IOException,
ElasticsearchException

Checks if a data stream, index, or alias exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

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

Checks if a data stream, index, or alias 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

Checks if an 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

Checks if an 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

Check existence of index templates. 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

Check existence of index templates. 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

explainDataLifecycle

public ExplainDataLifecycleResponse explainDataLifecycle(ExplainDataLifecycleRequest request)
                                                  throws IOException,
ElasticsearchException

Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explainDataLifecycle

public final ExplainDataLifecycleResponse explainDataLifecycle(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldUsageStats

public FieldUsageStatsResponse fieldUsageStats(FieldUsageStatsRequest request)
                                        throws IOException,
ElasticsearchException

Returns field usage information for each shard and field of an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldUsageStats

public final FieldUsageStatsResponse fieldUsageStats(Function<FieldUsageStatsRequest.Builder,ObjectBuilder<FieldUsageStatsRequest>> fn)
                                              throws IOException,
ElasticsearchException

Returns field usage information for each shard and field of an index.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flush

public FlushResponse flush(FlushRequest request)
                    throws IOException,
ElasticsearchException

Flushes one or more data streams or indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

flush

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

Flushes one or more data streams or 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

Flushes one or more data streams or indices.

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

get

public GetIndexResponse get(GetIndexRequest request)
                     throws IOException,
ElasticsearchException

Returns information about one or more indices. For data streams, the API returns information about the stream’s backing 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. For data streams, the API returns information about the stream’s backing 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

Retrieves information for one or more aliases.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAlias

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

Retrieves information for one or more aliases.

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

Retrieves information for one or more aliases.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataLifecycle

public GetDataLifecycleResponse getDataLifecycle(GetDataLifecycleRequest request)
                                          throws IOException,
ElasticsearchException

Retrieves the data stream lifecycle configuration of one or more data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataLifecycle

public final GetDataLifecycleResponse getDataLifecycle(Function<GetDataLifecycleRequest.Builder,ObjectBuilder<GetDataLifecycleRequest>> fn)
                                                throws IOException,
ElasticsearchException

Retrieves the data stream lifecycle configuration of one or more data streams.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getDataStream

public GetDataStreamResponse getDataStream(GetDataStreamRequest request)
                                    throws IOException,
ElasticsearchException

Retrieves information about one or more 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

Retrieves information about one or more 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

Retrieves information about one or more data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFieldMapping

public GetFieldMappingResponse getFieldMapping(GetFieldMappingRequest request)
                                        throws IOException,
ElasticsearchException

Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFieldMapping

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

Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

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

Get index templates. Returns information about one or more index templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getIndexTemplate

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

Get index templates. Returns information about one or more index templates.

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

Get index templates. Returns information about one or more index templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMapping

public GetMappingResponse getMapping(GetMappingRequest request)
                              throws IOException,
ElasticsearchException

Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getMapping

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

Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing 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

Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetIndicesSettingsResponse getSettings(GetIndicesSettingsRequest request)
                                       throws IOException,
ElasticsearchException

Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing 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 setting information for one or more indices. For data streams, returns setting information for the stream’s backing 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 setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTemplate

public GetTemplateResponse getTemplate(GetTemplateRequest request)
                                throws IOException,
ElasticsearchException

Get index templates. Retrieves information about one or more index templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getTemplate

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

Get index templates. Retrieves information about one or more index templates.

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

Get index templates. Retrieves information about one or more index templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataStream

public MigrateToDataStreamResponse migrateToDataStream(MigrateToDataStreamRequest request)
                                                throws IOException,
ElasticsearchException

Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

migrateToDataStream

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

Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

modifyDataStream

public ModifyDataStreamResponse modifyDataStream(ModifyDataStreamRequest request)
                                          throws IOException,
ElasticsearchException

Performs one or more data stream modification actions in a single atomic operation.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

modifyDataStream

public final ModifyDataStreamResponse modifyDataStream(Function<ModifyDataStreamRequest.Builder,ObjectBuilder<ModifyDataStreamRequest>> fn)
                                                throws IOException,
ElasticsearchException

Performs one or more data stream modification actions in a single atomic operation.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

open

public OpenResponse open(OpenRequest request)
                  throws IOException,
ElasticsearchException

Opens a closed index. For data streams, the API opens any closed backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

open

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

Opens a closed index. For data streams, the API opens any closed backing indices.

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

Adds a data stream or index to 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

Adds a data stream or index to an alias.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataLifecycle

public PutDataLifecycleResponse putDataLifecycle(PutDataLifecycleRequest request)
                                          throws IOException,
ElasticsearchException

Update the data lifecycle of the specified data streams.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putDataLifecycle

public final PutDataLifecycleResponse putDataLifecycle(Function<PutDataLifecycleRequest.Builder,ObjectBuilder<PutDataLifecycleRequest>> fn)
                                                throws IOException,
ElasticsearchException

Update the data lifecycle of the specified data streams.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIndexTemplate

public PutIndexTemplateResponse putIndexTemplate(PutIndexTemplateRequest request)
                                          throws IOException,
ElasticsearchException

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putIndexTemplate

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

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

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

Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putMapping

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

Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.

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

Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

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

Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default.

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

Changes a dynamic index setting in real time. For data streams, index setting changes are applied to all backing indices by default.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTemplate

public PutTemplateResponse putTemplate(PutTemplateRequest request)
                                throws IOException,
ElasticsearchException

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putTemplate

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

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

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 and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

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 and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

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 and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

refresh

public RefreshResponse refresh(RefreshRequest request)
                        throws IOException,
ElasticsearchException

A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

refresh

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

A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing 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

A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing 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

resolveCluster

public ResolveClusterResponse resolveCluster(ResolveClusterRequest request)
                                      throws IOException,
ElasticsearchException

Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resolveCluster

public final ResolveClusterResponse resolveCluster(Function<ResolveClusterRequest.Builder,ObjectBuilder<ResolveClusterRequest>> fn)
                                            throws IOException,
ElasticsearchException

Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resolveIndex

public ResolveIndexResponse resolveIndex(ResolveIndexRequest request)
                                  throws IOException,
ElasticsearchException

Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resolveIndex

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

Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

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

Creates a new index for a data stream or index alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rollover

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

Creates a new index for a data stream or index alias.

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

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

segments

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

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

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

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shardStores

public ShardStoresResponse shardStores(ShardStoresRequest request)
                                throws IOException,
ElasticsearchException

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shardStores

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

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing 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

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

shrink

public ShrinkResponse shrink(ShrinkRequest request)
                      throws IOException,
ElasticsearchException

Shrinks 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

Shrinks 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 an index. Returns the index configuration that would be applied to the specified index from an existing index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateIndexTemplate

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

Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.

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 an index template. Returns the index configuration that would be applied by a particular index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

simulateTemplate

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

Simulate an index template. Returns the index configuration that would be applied by a particular index template.

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 an index template. Returns the index configuration that would be applied by a particular index template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

split

public SplitResponse split(SplitRequest request)
                    throws IOException,
ElasticsearchException

Splits 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

Splits 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

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

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

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

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

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

unfreeze

public UnfreezeResponse unfreeze(UnfreezeRequest request)
                          throws IOException,
ElasticsearchException

Unfreezes an index.

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.

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

Adds a data stream or index to an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateAliases

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

Adds a data stream or index to an alias.

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

Adds a data stream or index to an alias.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

validateQuery

public ValidateQueryResponse validateQuery(ValidateQueryRequest request)
                                    throws IOException,
ElasticsearchException

Validates 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

Validates 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

Validates a potentially expensive query without executing it.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co