Package org.opensearch.client.opensearch.api.indices

Class IndicesClient

java.lang.Object

org.opensearch.client.base.ApiClient<IndicesClient>

org.opensearch.client.opensearch.api.indices.IndicesClient

public class IndicesClient
extends ApiClient<IndicesClient>

Client for the indices namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
IndicesClient(Transport transport)
IndicesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
AddBlockResponse	addBlock(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)	Adds a block to an index.
AddBlockResponse	addBlock(AddBlockRequest request)	Adds a block to an index.
AnalyzeResponse	analyze(java.util.function.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.
ClearCacheResponse	clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)	Clears all or specific caches for one or more indices.
ClearCacheResponse	clearCache(ClearCacheRequest request)	Clears all or specific caches for one or more indices.
CloneResponse	clone(java.util.function.Function<CloneRequest.Builder,ObjectBuilder<CloneRequest>> fn)	Clones an index
CloneResponse	clone(CloneRequest request)	Clones an index
CloseResponse	close(java.util.function.Function<CloseRequest.Builder,ObjectBuilder<CloseRequest>> fn)	Closes an index.
CloseResponse	close(CloseRequest request)	Closes an index.
CreateResponse	create(java.util.function.Function<CreateRequest.Builder,ObjectBuilder<CreateRequest>> fn)	Creates an index with optional settings and mappings.
CreateResponse	create(CreateRequest request)	Creates an index with optional settings and mappings.
DeleteResponse	delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Deletes an index.
DeleteResponse	delete(DeleteRequest request)	Deletes an index.
DeleteAliasResponse	deleteAlias(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)	Deletes an alias.
DeleteAliasResponse	deleteAlias(DeleteAliasRequest request)	Deletes an alias.
DeleteIndexTemplateResponse	deleteIndexTemplate(java.util.function.Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn)	Deletes an index template.
DeleteIndexTemplateResponse	deleteIndexTemplate(DeleteIndexTemplateRequest request)	Deletes an index template.
DeleteTemplateResponse	deleteTemplate(java.util.function.Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn)	Deletes an index template.
DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest request)	Deletes an index template.
BooleanResponse	exists(java.util.function.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.
BooleanResponse	existsAlias(java.util.function.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.
BooleanResponse	existsIndexTemplate(java.util.function.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.
BooleanResponse	existsTemplate(java.util.function.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.
BooleanResponse	existsType(java.util.function.Function<ExistsTypeRequest.Builder,ObjectBuilder<ExistsTypeRequest>> fn)	Returns information about whether a particular document type exists.
BooleanResponse	existsType(ExistsTypeRequest request)	Returns information about whether a particular document type exists.
FlushResponse	flush(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)	Performs the flush operation on one or more indices.
FlushResponse	flush(FlushRequest request)	Performs the flush operation on one or more indices.
FlushSyncedResponse	flushSynced(java.util.function.Function<FlushSyncedRequest.Builder,ObjectBuilder<FlushSyncedRequest>> fn)	Performs a synced flush operation on one or more indices.
FlushSyncedResponse	flushSynced(FlushSyncedRequest request)	Performs a synced flush operation on one or more indices.
ForcemergeResponse	forcemerge(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)	Performs the force merge operation on one or more indices.
ForcemergeResponse	forcemerge(ForcemergeRequest request)	Performs the force merge operation on one or more indices.
GetResponse	get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)	Returns information about one or more indices.
GetResponse	get(GetRequest request)	Returns information about one or more indices.
GetAliasResponse	getAlias(java.util.function.Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)	Returns an alias.
GetAliasResponse	getAlias(GetAliasRequest request)	Returns an alias.
GetFieldMappingResponse	getFieldMapping(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)	Returns mapping for one or more fields.
GetFieldMappingResponse	getFieldMapping(GetFieldMappingRequest request)	Returns mapping for one or more fields.
GetIndexTemplateResponse	getIndexTemplate(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn)	Returns an index template.
GetIndexTemplateResponse	getIndexTemplate(GetIndexTemplateRequest request)	Returns an index template.
GetMappingResponse	getMapping(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn)	Returns mappings for one or more indices.
GetMappingResponse	getMapping(GetMappingRequest request)	Returns mappings for one or more indices.
GetSettingsResponse	getSettings(java.util.function.Function<GetSettingsRequest.Builder,ObjectBuilder<GetSettingsRequest>> fn)	Returns settings for one or more indices.
GetSettingsResponse	getSettings(GetSettingsRequest request)	Returns settings for one or more indices.
GetTemplateResponse	getTemplate(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn)	Returns an index template.
GetTemplateResponse	getTemplate(GetTemplateRequest request)	Returns an index template.
GetUpgradeResponse	getUpgrade(java.util.function.Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn)	DEPRECATED Returns a progress status of current upgrade.
GetUpgradeResponse	getUpgrade(GetUpgradeRequest request)	DEPRECATED Returns a progress status of current upgrade.
OpenResponse	open(java.util.function.Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn)	Opens an index.
OpenResponse	open(OpenRequest request)	Opens an index.
PutAliasResponse	putAlias(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn)	Creates or updates an alias.
PutAliasResponse	putAlias(PutAliasRequest request)	Creates or updates an alias.
PutIndexTemplateResponse	putIndexTemplate(java.util.function.Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)	Creates or updates an index template.
PutIndexTemplateResponse	putIndexTemplate(PutIndexTemplateRequest request)	Creates or updates an index template.
PutMappingResponse	putMapping(java.util.function.Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn)	Updates the index mappings.
PutMappingResponse	putMapping(PutMappingRequest request)	Updates the index mappings.
PutSettingsResponse	putSettings(java.util.function.Function<PutSettingsRequest.Builder,ObjectBuilder<PutSettingsRequest>> fn)	Updates the index settings.
PutSettingsResponse	putSettings(PutSettingsRequest request)	Updates the index settings.
PutTemplateResponse	putTemplate(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)	Creates or updates an index template.
PutTemplateResponse	putTemplate(PutTemplateRequest request)	Creates or updates an index template.
RecoveryResponse	recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)	Returns information about ongoing index shard recoveries.
RecoveryResponse	recovery(RecoveryRequest request)	Returns information about ongoing index shard recoveries.
RefreshResponse	refresh(java.util.function.Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn)	Performs the refresh operation in one or more indices.
RefreshResponse	refresh(RefreshRequest request)	Performs the refresh operation in one or more indices.
ResolveIndexResponse	resolveIndex(java.util.function.Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)	Returns information about any matching indices, aliases, and data streams
ResolveIndexResponse	resolveIndex(ResolveIndexRequest request)	Returns information about any matching indices, aliases, and data streams
RolloverResponse	rollover(java.util.function.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.
SegmentsResponse	segments(java.util.function.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.
ShardStoresResponse	shardStores(java.util.function.Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)	Provides store information for shard copies of indices.
ShardStoresResponse	shardStores(ShardStoresRequest request)	Provides store information for shard copies of indices.
ShrinkResponse	shrink(java.util.function.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.
SimulateIndexTemplateResponse	simulateIndexTemplate(java.util.function.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
SimulateTemplateResponse	simulateTemplate(java.util.function.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
SplitResponse	split(java.util.function.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.
StatsResponse	stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn)	Provides statistics on operations happening in an index.
StatsResponse	stats(StatsRequest request)	Provides statistics on operations happening in an index.
UpdateAliasesResponse	updateAliases(java.util.function.Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn)	Updates index aliases.
UpdateAliasesResponse	updateAliases(UpdateAliasesRequest request)	Updates index aliases.
UpgradeResponse	upgrade(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn)	DEPRECATED Upgrades to the current version of Lucene.
UpgradeResponse	upgrade(UpgradeRequest request)	DEPRECATED Upgrades to the current version of Lucene.
ValidateQueryResponse	validateQuery(java.util.function.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.
IndicesClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new IndicesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
IndicesClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new IndicesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

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

Constructor Details

IndicesClient

public IndicesClient(Transport transport)

IndicesClient

public IndicesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

addBlock

public AddBlockResponse addBlock(AddBlockRequest request) throws java.io.IOException

Adds a block to an index.

Throws:

java.io.IOException

addBlock

public final AddBlockResponse addBlock(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn) throws java.io.IOException

Adds a block to an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

analyze

public AnalyzeResponse analyze(AnalyzeRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

analyze

public final AnalyzeResponse analyze(java.util.function.Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

clearCache

public ClearCacheResponse clearCache(ClearCacheRequest request) throws java.io.IOException

Clears all or specific caches for one or more indices.

Throws:

java.io.IOException

clearCache

public final ClearCacheResponse clearCache(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn) throws java.io.IOException

Clears all or specific caches for one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

clone

public CloneResponse clone(CloneRequest request) throws java.io.IOException

Clones an index

Throws:

java.io.IOException

clone

public final CloneResponse clone(java.util.function.Function<CloneRequest.Builder,ObjectBuilder<CloneRequest>> fn) throws java.io.IOException

Clones an index

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

close

public CloseResponse close(CloseRequest request) throws java.io.IOException

Closes an index.

Throws:

java.io.IOException

close

public final CloseResponse close(java.util.function.Function<CloseRequest.Builder,ObjectBuilder<CloseRequest>> fn) throws java.io.IOException

Closes an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

create

public CreateResponse create(CreateRequest request) throws java.io.IOException

Creates an index with optional settings and mappings.

Throws:

java.io.IOException

create

public final CreateResponse create(java.util.function.Function<CreateRequest.Builder,ObjectBuilder<CreateRequest>> fn) throws java.io.IOException

Creates an index with optional settings and mappings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

delete

public DeleteResponse delete(DeleteRequest request) throws java.io.IOException

Deletes an index.

Throws:

java.io.IOException

delete

public final DeleteResponse delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn) throws java.io.IOException

Deletes an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

deleteAlias

public DeleteAliasResponse deleteAlias(DeleteAliasRequest request) throws java.io.IOException

Deletes an alias.

Throws:

java.io.IOException

deleteAlias

public final DeleteAliasResponse deleteAlias(java.util.function.Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn) throws java.io.IOException

Deletes an alias.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

deleteIndexTemplate

public DeleteIndexTemplateResponse deleteIndexTemplate(DeleteIndexTemplateRequest request) throws java.io.IOException

Deletes an index template.

Throws:

java.io.IOException

deleteIndexTemplate

public final DeleteIndexTemplateResponse deleteIndexTemplate(java.util.function.Function<DeleteIndexTemplateRequest.Builder,ObjectBuilder<DeleteIndexTemplateRequest>> fn) throws java.io.IOException

Deletes an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

deleteTemplate

public DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest request) throws java.io.IOException

Deletes an index template.

Throws:

java.io.IOException

deleteTemplate

public final DeleteTemplateResponse deleteTemplate(java.util.function.Function<DeleteTemplateRequest.Builder,ObjectBuilder<DeleteTemplateRequest>> fn) throws java.io.IOException

Deletes an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

exists

public BooleanResponse exists(ExistsRequest request) throws java.io.IOException

Returns information about whether a particular index exists.

Throws:

java.io.IOException

exists

public final BooleanResponse exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn) throws java.io.IOException

Returns information about whether a particular index exists.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

existsAlias

public BooleanResponse existsAlias(ExistsAliasRequest request) throws java.io.IOException

Returns information about whether a particular alias exists.

Throws:

java.io.IOException

existsAlias

public final BooleanResponse existsAlias(java.util.function.Function<ExistsAliasRequest.Builder,ObjectBuilder<ExistsAliasRequest>> fn) throws java.io.IOException

Returns information about whether a particular alias exists.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

existsIndexTemplate

public BooleanResponse existsIndexTemplate(ExistsIndexTemplateRequest request) throws java.io.IOException

Returns information about whether a particular index template exists.

Throws:

java.io.IOException

existsIndexTemplate

public final BooleanResponse existsIndexTemplate(java.util.function.Function<ExistsIndexTemplateRequest.Builder,ObjectBuilder<ExistsIndexTemplateRequest>> fn) throws java.io.IOException

Returns information about whether a particular index template exists.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

existsTemplate

public BooleanResponse existsTemplate(ExistsTemplateRequest request) throws java.io.IOException

Returns information about whether a particular index template exists.

Throws:

java.io.IOException

existsTemplate

public final BooleanResponse existsTemplate(java.util.function.Function<ExistsTemplateRequest.Builder,ObjectBuilder<ExistsTemplateRequest>> fn) throws java.io.IOException

Returns information about whether a particular index template exists.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

existsType

public BooleanResponse existsType(ExistsTypeRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

existsType

public final BooleanResponse existsType(java.util.function.Function<ExistsTypeRequest.Builder,ObjectBuilder<ExistsTypeRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

flush

public FlushResponse flush(FlushRequest request) throws java.io.IOException

Performs the flush operation on one or more indices.

Throws:

java.io.IOException

flush

public final FlushResponse flush(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn) throws java.io.IOException

Performs the flush operation on one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

flushSynced

public FlushSyncedResponse flushSynced(FlushSyncedRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

flushSynced

public final FlushSyncedResponse flushSynced(java.util.function.Function<FlushSyncedRequest.Builder,ObjectBuilder<FlushSyncedRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

forcemerge

public ForcemergeResponse forcemerge(ForcemergeRequest request) throws java.io.IOException

Performs the force merge operation on one or more indices.

Throws:

java.io.IOException

forcemerge

public final ForcemergeResponse forcemerge(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn) throws java.io.IOException

Performs the force merge operation on one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

get

public GetResponse get(GetRequest request) throws java.io.IOException

Returns information about one or more indices.

Throws:

java.io.IOException

get

public final GetResponse get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn) throws java.io.IOException

Returns information about one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getAlias

public GetAliasResponse getAlias(GetAliasRequest request) throws java.io.IOException

Returns an alias.

Throws:

java.io.IOException

getAlias

public final GetAliasResponse getAlias(java.util.function.Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn) throws java.io.IOException

Returns an alias.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getFieldMapping

public GetFieldMappingResponse getFieldMapping(GetFieldMappingRequest request) throws java.io.IOException

Returns mapping for one or more fields.

Throws:

java.io.IOException

getFieldMapping

public final GetFieldMappingResponse getFieldMapping(java.util.function.Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn) throws java.io.IOException

Returns mapping for one or more fields.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getIndexTemplate

public GetIndexTemplateResponse getIndexTemplate(GetIndexTemplateRequest request) throws java.io.IOException

Returns an index template.

Throws:

java.io.IOException

getIndexTemplate

public final GetIndexTemplateResponse getIndexTemplate(java.util.function.Function<GetIndexTemplateRequest.Builder,ObjectBuilder<GetIndexTemplateRequest>> fn) throws java.io.IOException

Returns an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getMapping

public GetMappingResponse getMapping(GetMappingRequest request) throws java.io.IOException

Returns mappings for one or more indices.

Throws:

java.io.IOException

getMapping

public final GetMappingResponse getMapping(java.util.function.Function<GetMappingRequest.Builder,ObjectBuilder<GetMappingRequest>> fn) throws java.io.IOException

Returns mappings for one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getSettings

public GetSettingsResponse getSettings(GetSettingsRequest request) throws java.io.IOException

Returns settings for one or more indices.

Throws:

java.io.IOException

getSettings

public final GetSettingsResponse getSettings(java.util.function.Function<GetSettingsRequest.Builder,ObjectBuilder<GetSettingsRequest>> fn) throws java.io.IOException

Returns settings for one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getTemplate

public GetTemplateResponse getTemplate(GetTemplateRequest request) throws java.io.IOException

Returns an index template.

Throws:

java.io.IOException

getTemplate

public final GetTemplateResponse getTemplate(java.util.function.Function<GetTemplateRequest.Builder,ObjectBuilder<GetTemplateRequest>> fn) throws java.io.IOException

Returns an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

getUpgrade

public GetUpgradeResponse getUpgrade(GetUpgradeRequest request) throws java.io.IOException

DEPRECATED Returns a progress status of current upgrade.

Throws:

java.io.IOException

getUpgrade

public final GetUpgradeResponse getUpgrade(java.util.function.Function<GetUpgradeRequest.Builder,ObjectBuilder<GetUpgradeRequest>> fn) throws java.io.IOException

DEPRECATED Returns a progress status of current upgrade.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

open

public OpenResponse open(OpenRequest request) throws java.io.IOException

Opens an index.

Throws:

java.io.IOException

open

public final OpenResponse open(java.util.function.Function<OpenRequest.Builder,ObjectBuilder<OpenRequest>> fn) throws java.io.IOException

Opens an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putAlias

public PutAliasResponse putAlias(PutAliasRequest request) throws java.io.IOException

Creates or updates an alias.

Throws:

java.io.IOException

putAlias

public final PutAliasResponse putAlias(java.util.function.Function<PutAliasRequest.Builder,ObjectBuilder<PutAliasRequest>> fn) throws java.io.IOException

Creates or updates an alias.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putIndexTemplate

public PutIndexTemplateResponse putIndexTemplate(PutIndexTemplateRequest request) throws java.io.IOException

Creates or updates an index template.

Throws:

java.io.IOException

putIndexTemplate

public final PutIndexTemplateResponse putIndexTemplate(java.util.function.Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn) throws java.io.IOException

Creates or updates an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putMapping

public PutMappingResponse putMapping(PutMappingRequest request) throws java.io.IOException

Updates the index mappings.

Throws:

java.io.IOException

putMapping

public final PutMappingResponse putMapping(java.util.function.Function<PutMappingRequest.Builder,ObjectBuilder<PutMappingRequest>> fn) throws java.io.IOException

Updates the index mappings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putSettings

public PutSettingsResponse putSettings(PutSettingsRequest request) throws java.io.IOException

Updates the index settings.

Throws:

java.io.IOException

putSettings

public final PutSettingsResponse putSettings(java.util.function.Function<PutSettingsRequest.Builder,ObjectBuilder<PutSettingsRequest>> fn) throws java.io.IOException

Updates the index settings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

putTemplate

public PutTemplateResponse putTemplate(PutTemplateRequest request) throws java.io.IOException

Creates or updates an index template.

Throws:

java.io.IOException

putTemplate

public final PutTemplateResponse putTemplate(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn) throws java.io.IOException

Creates or updates an index template.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

recovery

public RecoveryResponse recovery(RecoveryRequest request) throws java.io.IOException

Returns information about ongoing index shard recoveries.

Throws:

java.io.IOException

recovery

public final RecoveryResponse recovery(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn) throws java.io.IOException

Returns information about ongoing index shard recoveries.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

refresh

public RefreshResponse refresh(RefreshRequest request) throws java.io.IOException

Performs the refresh operation in one or more indices.

Throws:

java.io.IOException

refresh

public final RefreshResponse refresh(java.util.function.Function<RefreshRequest.Builder,ObjectBuilder<RefreshRequest>> fn) throws java.io.IOException

Performs the refresh operation in one or more indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

resolveIndex

public ResolveIndexResponse resolveIndex(ResolveIndexRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

resolveIndex

public final ResolveIndexResponse resolveIndex(java.util.function.Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

rollover

public RolloverResponse rollover(RolloverRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

rollover

public final RolloverResponse rollover(java.util.function.Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn) throws java.io.IOException

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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

segments

public SegmentsResponse segments(SegmentsRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

segments

public final SegmentsResponse segments(java.util.function.Function<SegmentsRequest.Builder,ObjectBuilder<SegmentsRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

shardStores

public ShardStoresResponse shardStores(ShardStoresRequest request) throws java.io.IOException

Provides store information for shard copies of indices.

Throws:

java.io.IOException

shardStores

public final ShardStoresResponse shardStores(java.util.function.Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn) throws java.io.IOException

Provides store information for shard copies of indices.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

shrink

public ShrinkResponse shrink(ShrinkRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

shrink

public final ShrinkResponse shrink(java.util.function.Function<ShrinkRequest.Builder,ObjectBuilder<ShrinkRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

simulateIndexTemplate

public SimulateIndexTemplateResponse simulateIndexTemplate(SimulateIndexTemplateRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

simulateIndexTemplate

public final SimulateIndexTemplateResponse simulateIndexTemplate(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

simulateTemplate

public SimulateTemplateResponse simulateTemplate(SimulateTemplateRequest request) throws java.io.IOException

Simulate resolving the given template name or body

Throws:

java.io.IOException

simulateTemplate

public final SimulateTemplateResponse simulateTemplate(java.util.function.Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn) throws java.io.IOException

Simulate resolving the given template name or body

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

split

public SplitResponse split(SplitRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

split

public final SplitResponse split(java.util.function.Function<SplitRequest.Builder,ObjectBuilder<SplitRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

stats

public StatsResponse stats(StatsRequest request) throws java.io.IOException

Provides statistics on operations happening in an index.

Throws:

java.io.IOException

stats

public final StatsResponse stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn) throws java.io.IOException

Provides statistics on operations happening in an index.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

updateAliases

public UpdateAliasesResponse updateAliases(UpdateAliasesRequest request) throws java.io.IOException

Updates index aliases.

Throws:

java.io.IOException

updateAliases

public final UpdateAliasesResponse updateAliases(java.util.function.Function<UpdateAliasesRequest.Builder,ObjectBuilder<UpdateAliasesRequest>> fn) throws java.io.IOException

Updates index aliases.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

upgrade

public UpgradeResponse upgrade(UpgradeRequest request) throws java.io.IOException

DEPRECATED Upgrades to the current version of Lucene.

Throws:

java.io.IOException

upgrade

public final UpgradeResponse upgrade(java.util.function.Function<UpgradeRequest.Builder,ObjectBuilder<UpgradeRequest>> fn) throws java.io.IOException

DEPRECATED Upgrades to the current version of Lucene.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

validateQuery

public ValidateQueryResponse validateQuery(ValidateQueryRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

validateQuery

public final ValidateQueryResponse validateQuery(java.util.function.Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public IndicesClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new IndicesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<IndicesClient>

withRequestOptions

public IndicesClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new IndicesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.