Package org.opensearch.client.opensearch.indices

Class OpenSearchIndicesClientBase<Self extends OpenSearchIndicesClientBase<Self>>

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,Self>

org.opensearch.client.opensearch.indices.OpenSearchIndicesClientBase<Self>

Direct Known Subclasses:

OpenSearchIndicesClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchIndicesClientBase<Self extends OpenSearchIndicesClientBase<Self>>
extends ApiClient<OpenSearchTransport,Self>

Client for the indices namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchIndicesClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final AddBlockResponse	addBlock(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)	Adds a block to an index.
AddBlockResponse	addBlock(AddBlockRequest request)	Adds a block to an index.
final AnalyzeResponse	analyze()	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.
AnalyzeResponse	analyze(AnalyzeRequest request)	Performs the analysis process on a text and return the tokens breakdown of the text.
final ClearCacheResponse	clearCache()	Clears all or specific caches for one or more indexes.
final ClearCacheResponse	clearCache(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears all or specific caches for one or more indexes.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clears all or specific caches for one or more indexes.
final CloneIndexResponse	clone(Function<CloneIndexRequest.Builder,ObjectBuilder<CloneIndexRequest>> fn)	Clones an index.
CloneIndexResponse	clone(CloneIndexRequest request)	Clones an index.
final CloseIndexResponse	close(Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)	Closes an index.
CloseIndexResponse	close(CloseIndexRequest request)	Closes an index.
final CreateIndexResponse	create(Function<CreateIndexRequest.Builder,ObjectBuilder<CreateIndexRequest>> fn)	Creates an index with optional settings and mappings.
CreateIndexResponse	create(CreateIndexRequest request)	Creates an index with optional settings and mappings.
final CreateDataStreamResponse	createDataStream(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)	Creates or updates a data stream.
CreateDataStreamResponse	createDataStream(CreateDataStreamRequest request)	Creates or updates a data stream.
final DataStreamsStatsResponse	dataStreamsStats()	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.
DataStreamsStatsResponse	dataStreamsStats(DataStreamsStatsRequest request)	Provides statistics on operations happening in a data stream.
final DeleteIndexResponse	delete(Function<DeleteIndexRequest.Builder,ObjectBuilder<DeleteIndexRequest>> fn)	Deletes an index.
DeleteIndexResponse	delete(DeleteIndexRequest request)	Deletes an index.
final DeleteAliasResponse	deleteAlias(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Deletes an alias.
DeleteAliasResponse	deleteAlias(DeleteAliasRequest request)	Deletes an alias.
final DeleteDataStreamResponse	deleteDataStream(Function<DeleteDataStreamRequest.Builder,ObjectBuilder<DeleteDataStreamRequest>> fn)	Deletes a data stream.
DeleteDataStreamResponse	deleteDataStream(DeleteDataStreamRequest request)	Deletes a data stream.
final DeleteIndexTemplateResponse	deleteIndexTemplate(Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Deletes an index template.
DeleteIndexTemplateResponse	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Deletes an index template.
final DeleteTemplateResponse	deleteTemplate(Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes an index template.
DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest request)	Deletes an index template.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a particular index exists.
BooleanResponse	exists(ExistsRequest request)	Returns information about whether a particular index exists.
final BooleanResponse	existsAlias(Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn)	Returns information about whether a particular alias exists.
BooleanResponse	existsAlias(ExistsAliasRequest request)	Returns information about whether a particular alias exists.
final BooleanResponse	existsIndexTemplate(Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn)	Returns information about whether a particular index template exists.
BooleanResponse	existsIndexTemplate(ExistsIndexTemplateRequest 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	existsTemplate(ExistsTemplateRequest request)	Returns information about whether a particular index template exists.
final FlushResponse	flush()	Performs the flush operation on one or more indexes.
final FlushResponse	flush(Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Performs the flush operation on one or more indexes.
FlushResponse	flush(FlushRequest request)	Performs the flush operation on one or more indexes.
final ForcemergeResponse	forcemerge()	Performs the force merge operation on one or more indexes.
final ForcemergeResponse	forcemerge(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)	Performs the force merge operation on one or more indexes.
ForcemergeResponse	forcemerge(ForcemergeRequest request)	Performs the force merge operation on one or more indexes.
final GetIndexResponse	get(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)	Returns information about one or more indexes.
GetIndexResponse	get(GetIndexRequest request)	Returns information about one or more indexes.
final GetAliasResponse	getAlias()	Returns an alias.
final GetAliasResponse	getAlias(Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Returns an alias.
GetAliasResponse	getAlias(GetAliasRequest request)	Returns an alias.
final GetDataStreamResponse	getDataStream()	Returns data streams.
final GetDataStreamResponse	getDataStream(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)	Returns data streams.
GetDataStreamResponse	getDataStream(GetDataStreamRequest request)	Returns data streams.
final GetIndexTemplateResponse	getIndexTemplate()	Returns an index template.
final GetIndexTemplateResponse	getIndexTemplate(Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Returns an index template.
GetIndexTemplateResponse	getIndexTemplate(GetIndexTemplateRequest request)	Returns an index template.
final GetMappingResponse	getMapping()	Returns mappings for one or more indexes.
final GetMappingResponse	getMapping(Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Returns mappings for one or more indexes.
GetMappingResponse	getMapping(GetMappingRequest request)	Returns mappings for one or more indexes.
final GetIndicesSettingsResponse	getSettings()	Returns settings for one or more indexes.
final GetIndicesSettingsResponse	getSettings(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)	Returns settings for one or more indexes.
GetIndicesSettingsResponse	getSettings(GetIndicesSettingsRequest request)	Returns settings for one or more indexes.
final GetTemplateResponse	getTemplate()	Returns an index template.
final GetTemplateResponse	getTemplate(Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Returns an index template.
GetTemplateResponse	getTemplate(GetTemplateRequest request)	Returns an index template.
final OpenResponse	open(Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens an index.
OpenResponse	open(OpenRequest request)	Opens an index.
final PutAliasResponse	putAlias()	Creates or updates an alias.
final PutAliasResponse	putAlias(Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Creates or updates an alias.
PutAliasResponse	putAlias(PutAliasRequest request)	Creates or updates an alias.
final PutIndexTemplateResponse	putIndexTemplate(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Creates or updates an index template.
PutIndexTemplateResponse	putIndexTemplate(PutIndexTemplateRequest request)	Creates or updates an index template.
final PutMappingResponse	putMapping(Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Updates the index mappings.
PutMappingResponse	putMapping(PutMappingRequest request)	Updates the index mappings.
final PutIndicesSettingsResponse	putSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	Updates the index settings.
PutIndicesSettingsResponse	putSettings(PutIndicesSettingsRequest request)	Updates the index settings.
final PutTemplateResponse	putTemplate(Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Creates or updates an index template.
PutTemplateResponse	putTemplate(PutTemplateRequest request)	Creates or updates an index template.
final RecoveryResponse	recovery()	Returns information about ongoing index shard recoveries.
final RecoveryResponse	recovery(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing index shard recoveries.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about ongoing index shard recoveries.
final RefreshResponse	refresh()	Performs the refresh operation in one or more indexes.
final RefreshResponse	refresh(Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	Performs the refresh operation in one or more indexes.
RefreshResponse	refresh(RefreshRequest request)	Performs the refresh operation in one or more indexes.
final ResolveIndexResponse	resolveIndex(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Returns information about any matching indexes, aliases, and data streams.
ResolveIndexResponse	resolveIndex(ResolveIndexRequest request)	Returns information about any matching indexes, aliases, and data streams.
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.
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 SegmentsResponse	segments()	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.
SegmentsResponse	segments(SegmentsRequest request)	Provides low-level information about segments in a Lucene index.
final ShardStoresResponse	shardStores()	Provides store information for shard copies of indexes.
final ShardStoresResponse	shardStores(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Provides store information for shard copies of indexes.
ShardStoresResponse	shardStores(ShardStoresRequest request)	Provides store information for shard copies of indexes.
final ShrinkResponse	shrink(Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn)	Allow to shrink an existing index into a new index with fewer primary shards.
ShrinkResponse	shrink(ShrinkRequest request)	Allow to shrink an existing index into a new index with fewer primary shards.
final SimulateIndexTemplateResponse	simulateIndexTemplate(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)	Simulate matching the given index name against the index templates in the system.
SimulateIndexTemplateResponse	simulateIndexTemplate(SimulateIndexTemplateRequest request)	Simulate matching the given index name against the index templates in the system.
final SimulateTemplateResponse	simulateTemplate(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)	Simulate resolving the given template name or body.
SimulateTemplateResponse	simulateTemplate(SimulateTemplateRequest request)	Simulate resolving the given template name or body.
final SplitResponse	split(Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn)	Allows you to split an existing index into a new index with more primary shards.
SplitResponse	split(SplitRequest request)	Allows you to split an existing index into a new index with more primary shards.
final IndicesStatsResponse	stats()	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.
IndicesStatsResponse	stats(IndicesStatsRequest request)	Provides statistics on operations happening in an index.
final UpdateAliasesResponse	updateAliases()	Updates index aliases.
final UpdateAliasesResponse	updateAliases(Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Updates index aliases.
UpdateAliasesResponse	updateAliases(UpdateAliasesRequest request)	Updates index aliases.
final ValidateQueryResponse	validateQuery()	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.
ValidateQueryResponse	validateQuery(ValidateQueryRequest request)	Allows a user to validate a potentially expensive query without executing it.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchIndicesClientBase

public OpenSearchIndicesClientBase(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

addBlock

public AddBlockResponse addBlock(AddBlockRequest request)
                          throws IOException,
OpenSearchException

Adds a block to an index.

Throws:

IOException

OpenSearchException

addBlock

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

Adds a block to an index.

Parameters:

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

Throws:

IOException

OpenSearchException

analyze

public AnalyzeResponse analyze(AnalyzeRequest request)
                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

analyze

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

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

OpenSearchException

analyze

public final AnalyzeResponse analyze()
                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request)
                              throws IOException,
OpenSearchException

Clears all or specific caches for one or more indexes.

Throws:

IOException

OpenSearchException

clearCache

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

Clears all or specific caches for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

clearCache

public final ClearCacheResponse clearCache()
                                    throws IOException,
OpenSearchException

Clears all or specific caches for one or more indexes.

Throws:

IOException

OpenSearchException

clone

public CloneIndexResponse clone(CloneIndexRequest request)
                         throws IOException,
OpenSearchException

Clones an index.

Throws:

IOException

OpenSearchException

clone

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

Clones an index.

Parameters:

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

Throws:

IOException

OpenSearchException

close

public CloseIndexResponse close(CloseIndexRequest request)
                         throws IOException,
OpenSearchException

Closes an index.

Throws:

IOException

OpenSearchException

close

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

Closes an index.

Parameters:

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

Throws:

IOException

OpenSearchException

create

public CreateIndexResponse create(CreateIndexRequest request)
                           throws IOException,
OpenSearchException

Creates an index with optional settings and mappings.

Throws:

IOException

OpenSearchException

create

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

Creates an index with optional settings and mappings.

Parameters:

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

Throws:

IOException

OpenSearchException

createDataStream

public CreateDataStreamResponse createDataStream(CreateDataStreamRequest request)
                                          throws IOException,
OpenSearchException

Creates or updates a data stream.

Throws:

IOException

OpenSearchException

createDataStream

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

Creates or updates a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

dataStreamsStats

public DataStreamsStatsResponse dataStreamsStats(DataStreamsStatsRequest request)
                                          throws IOException,
OpenSearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

OpenSearchException

dataStreamsStats

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

Provides statistics on operations happening in a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

dataStreamsStats

public final DataStreamsStatsResponse dataStreamsStats()
                                                throws IOException,
OpenSearchException

Provides statistics on operations happening in a data stream.

Throws:

IOException

OpenSearchException

delete

public DeleteIndexResponse delete(DeleteIndexRequest request)
                           throws IOException,
OpenSearchException

Deletes an index.

Throws:

IOException

OpenSearchException

delete

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

Deletes an index.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteAlias

public DeleteAliasResponse deleteAlias(DeleteAliasRequest request)
                                throws IOException,
OpenSearchException

Deletes an alias.

Throws:

IOException

OpenSearchException

deleteAlias

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

Deletes an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteDataStream

public DeleteDataStreamResponse deleteDataStream(DeleteDataStreamRequest request)
                                          throws IOException,
OpenSearchException

Deletes a data stream.

Throws:

IOException

OpenSearchException

deleteDataStream

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

Deletes a data stream.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteIndexTemplate

public DeleteIndexTemplateResponse deleteIndexTemplate(DeleteIndexTemplateRequest request)
                                                throws IOException,
OpenSearchException

Deletes an index template.

Throws:

IOException

OpenSearchException

deleteIndexTemplate

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

Deletes an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteTemplate

public DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest request)
                                      throws IOException,
OpenSearchException

Deletes an index template.

Throws:

IOException

OpenSearchException

deleteTemplate

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

Deletes an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

exists

public BooleanResponse exists(ExistsRequest request)
                       throws IOException,
OpenSearchException

Returns information about whether a particular index exists.

Throws:

IOException

OpenSearchException

exists

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

Returns information about whether a particular index exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsAlias

public BooleanResponse existsAlias(ExistsAliasRequest request)
                            throws IOException,
OpenSearchException

Returns information about whether a particular alias exists.

Throws:

IOException

OpenSearchException

existsAlias

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

Returns information about whether a particular alias exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsIndexTemplate

public BooleanResponse existsIndexTemplate(ExistsIndexTemplateRequest request)
                                    throws IOException,
OpenSearchException

Returns information about whether a particular index template exists.

Throws:

IOException

OpenSearchException

existsIndexTemplate

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

Returns information about whether a particular index template exists.

Parameters:

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

Throws:

IOException

OpenSearchException

existsTemplate

public BooleanResponse existsTemplate(ExistsTemplateRequest request)
                               throws IOException,
OpenSearchException

Returns information about whether a particular index template exists.

Throws:

IOException

OpenSearchException

existsTemplate

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

Returns information about whether a particular index template exists.

Parameters:

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

Throws:

IOException

OpenSearchException

flush

public FlushResponse flush(FlushRequest request)
                    throws IOException,
OpenSearchException

Performs the flush operation on one or more indexes.

Throws:

IOException

OpenSearchException

flush

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

Performs the flush operation on one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

flush

public final FlushResponse flush()
                          throws IOException,
OpenSearchException

Performs the flush operation on one or more indexes.

Throws:

IOException

OpenSearchException

forcemerge

public ForcemergeResponse forcemerge(ForcemergeRequest request)
                              throws IOException,
OpenSearchException

Performs the force merge operation on one or more indexes.

Throws:

IOException

OpenSearchException

forcemerge

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

Performs the force merge operation on one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

forcemerge

public final ForcemergeResponse forcemerge()
                                    throws IOException,
OpenSearchException

Performs the force merge operation on one or more indexes.

Throws:

IOException

OpenSearchException

get

public GetIndexResponse get(GetIndexRequest request)
                     throws IOException,
OpenSearchException

Returns information about one or more indexes.

Throws:

IOException

OpenSearchException

get

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

Returns information about one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getAlias

public GetAliasResponse getAlias(GetAliasRequest request)
                          throws IOException,
OpenSearchException

Returns an alias.

Throws:

IOException

OpenSearchException

getAlias

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

Returns an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

getAlias

public final GetAliasResponse getAlias()
                                throws IOException,
OpenSearchException

Returns an alias.

Throws:

IOException

OpenSearchException

getDataStream

public GetDataStreamResponse getDataStream(GetDataStreamRequest request)
                                    throws IOException,
OpenSearchException

Returns data streams.

Throws:

IOException

OpenSearchException

getDataStream

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

Returns data streams.

Parameters:

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

Throws:

IOException

OpenSearchException

getDataStream

public final GetDataStreamResponse getDataStream()
                                          throws IOException,
OpenSearchException

Returns data streams.

Throws:

IOException

OpenSearchException

getIndexTemplate

public GetIndexTemplateResponse getIndexTemplate(GetIndexTemplateRequest request)
                                          throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getIndexTemplate

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

Returns an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

getIndexTemplate

public final GetIndexTemplateResponse getIndexTemplate()
                                                throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getMapping

public GetMappingResponse getMapping(GetMappingRequest request)
                              throws IOException,
OpenSearchException

Returns mappings for one or more indexes.

Throws:

IOException

OpenSearchException

getMapping

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

Returns mappings for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getMapping

public final GetMappingResponse getMapping()
                                    throws IOException,
OpenSearchException

Returns mappings for one or more indexes.

Throws:

IOException

OpenSearchException

getSettings

public GetIndicesSettingsResponse getSettings(GetIndicesSettingsRequest request)
                                       throws IOException,
OpenSearchException

Returns settings for one or more indexes.

Throws:

IOException

OpenSearchException

getSettings

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

Returns settings for one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

getSettings

public final GetIndicesSettingsResponse getSettings()
                                             throws IOException,
OpenSearchException

Returns settings for one or more indexes.

Throws:

IOException

OpenSearchException

getTemplate

public GetTemplateResponse getTemplate(GetTemplateRequest request)
                                throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

getTemplate

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

Returns an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

getTemplate

public final GetTemplateResponse getTemplate()
                                      throws IOException,
OpenSearchException

Returns an index template.

Throws:

IOException

OpenSearchException

open

public OpenResponse open(OpenRequest request)
                  throws IOException,
OpenSearchException

Opens an index.

Throws:

IOException

OpenSearchException

open

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

Opens an index.

Parameters:

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

Throws:

IOException

OpenSearchException

putAlias

public PutAliasResponse putAlias(PutAliasRequest request)
                          throws IOException,
OpenSearchException

Creates or updates an alias.

Throws:

IOException

OpenSearchException

putAlias

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

Creates or updates an alias.

Parameters:

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

Throws:

IOException

OpenSearchException

putAlias

public final PutAliasResponse putAlias()
                                throws IOException,
OpenSearchException

Creates or updates an alias.

Throws:

IOException

OpenSearchException

putIndexTemplate

public PutIndexTemplateResponse putIndexTemplate(PutIndexTemplateRequest request)
                                          throws IOException,
OpenSearchException

Creates or updates an index template.

Throws:

IOException

OpenSearchException

putIndexTemplate

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

Creates or updates an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

putMapping

public PutMappingResponse putMapping(PutMappingRequest request)
                              throws IOException,
OpenSearchException

Updates the index mappings.

Throws:

IOException

OpenSearchException

putMapping

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

Updates the index mappings.

Parameters:

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

Throws:

IOException

OpenSearchException

putSettings

public PutIndicesSettingsResponse putSettings(PutIndicesSettingsRequest request)
                                       throws IOException,
OpenSearchException

Updates the index settings.

Throws:

IOException

OpenSearchException

putSettings

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

Updates the index settings.

Parameters:

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

Throws:

IOException

OpenSearchException

putTemplate

public PutTemplateResponse putTemplate(PutTemplateRequest request)
                                throws IOException,
OpenSearchException

Creates or updates an index template.

Throws:

IOException

OpenSearchException

putTemplate

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

Creates or updates an index template.

Parameters:

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

Throws:

IOException

OpenSearchException

recovery

public RecoveryResponse recovery(RecoveryRequest request)
                          throws IOException,
OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

OpenSearchException

recovery

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

Returns information about ongoing index shard recoveries.

Parameters:

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

Throws:

IOException

OpenSearchException

recovery

public final RecoveryResponse recovery()
                                throws IOException,
OpenSearchException

Returns information about ongoing index shard recoveries.

Throws:

IOException

OpenSearchException

refresh

public RefreshResponse refresh(RefreshRequest request)
                        throws IOException,
OpenSearchException

Performs the refresh operation in one or more indexes.

Throws:

IOException

OpenSearchException

refresh

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

Performs the refresh operation in one or more indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

refresh

public final RefreshResponse refresh()
                              throws IOException,
OpenSearchException

Performs the refresh operation in one or more indexes.

Throws:

IOException

OpenSearchException

resolveIndex

public ResolveIndexResponse resolveIndex(ResolveIndexRequest request)
                                  throws IOException,
OpenSearchException

Returns information about any matching indexes, aliases, and data streams.

Throws:

IOException

OpenSearchException

resolveIndex

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

Returns information about any matching indexes, aliases, and data streams.

Parameters:

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

Throws:

IOException

OpenSearchException

rollover

public RolloverResponse rollover(RolloverRequest request)
                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

rollover

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

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

OpenSearchException

segments

public SegmentsResponse segments(SegmentsRequest request)
                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

segments

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

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

Parameters:

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

Throws:

IOException

OpenSearchException

segments

public final SegmentsResponse segments()
                                throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

shardStores

public ShardStoresResponse shardStores(ShardStoresRequest request)
                                throws IOException,
OpenSearchException

Provides store information for shard copies of indexes.

Throws:

IOException

OpenSearchException

shardStores

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

Provides store information for shard copies of indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

shardStores

public final ShardStoresResponse shardStores()
                                      throws IOException,
OpenSearchException

Provides store information for shard copies of indexes.

Throws:

IOException

OpenSearchException

shrink

public ShrinkResponse shrink(ShrinkRequest request)
                      throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

shrink

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

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

OpenSearchException

simulateIndexTemplate

public SimulateIndexTemplateResponse simulateIndexTemplate(SimulateIndexTemplateRequest request)
                                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

simulateIndexTemplate

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

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

OpenSearchException

simulateTemplate

public SimulateTemplateResponse simulateTemplate(SimulateTemplateRequest request)
                                          throws IOException,
OpenSearchException

Simulate resolving the given template name or body.

Throws:

IOException

OpenSearchException

simulateTemplate

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

Simulate resolving the given template name or body.

Parameters:

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

Throws:

IOException

OpenSearchException

split

public SplitResponse split(SplitRequest request)
                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

split

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

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

OpenSearchException

stats

public IndicesStatsResponse stats(IndicesStatsRequest request)
                           throws IOException,
OpenSearchException

Provides statistics on operations happening in an index.

Throws:

IOException

OpenSearchException

stats

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

Provides statistics on operations happening in an index.

Parameters:

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

Throws:

IOException

OpenSearchException

stats

public final IndicesStatsResponse stats()
                                 throws IOException,
OpenSearchException

Provides statistics on operations happening in an index.

Throws:

IOException

OpenSearchException

updateAliases

public UpdateAliasesResponse updateAliases(UpdateAliasesRequest request)
                                    throws IOException,
OpenSearchException

Updates index aliases.

Throws:

IOException

OpenSearchException

updateAliases

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

Updates index aliases.

Parameters:

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

Throws:

IOException

OpenSearchException

updateAliases

public final UpdateAliasesResponse updateAliases()
                                          throws IOException,
OpenSearchException

Updates index aliases.

Throws:

IOException

OpenSearchException

validateQuery

public ValidateQueryResponse validateQuery(ValidateQueryRequest request)
                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

validateQuery

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

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

OpenSearchException

validateQuery

public final ValidateQueryResponse validateQuery()
                                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException