Index

A B C D E F G H I L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ABORTING - Enum constant in enum class org.opensearch.client.core.IndexerState

Something (internal or external) has requested the indexer abort and shutdown.

AcknowledgedResponse - Class in org.opensearch.client.core

AcknowledgedResponse(boolean) - Constructor for class org.opensearch.client.core.AcknowledgedResponse

add(TermVectorsRequest) - Method in class org.opensearch.client.core.MultiTermVectorsRequest

Adds another TermVectorsRequest to this MultiTermVectorsRequest

addCharFilter(String) - Method in class org.opensearch.client.indices.AnalyzeRequest.CustomAnalyzerBuilder

addCharFilter(Map<String, Object>) - Method in class org.opensearch.client.indices.AnalyzeRequest.CustomAnalyzerBuilder

addFeatures(GetIndexRequest.Feature...) - Method in class org.opensearch.client.indices.GetIndexRequest

addGroup(TaskGroup.Builder) - Method in class org.opensearch.client.tasks.TaskGroup.Builder

addMaxIndexAgeCondition(TimeValue) - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Adds condition to check if the index is at least age old

addMaxIndexDocsCondition(long) - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Adds condition to check if the index has at least numDocs

addMaxIndexSizeCondition(ByteSizeValue) - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Adds a size-based condition to check if the index size is at least size.

addTokenFilter(String) - Method in class org.opensearch.client.indices.AnalyzeRequest.CustomAnalyzerBuilder

addTokenFilter(Map<String, Object>) - Method in class org.opensearch.client.indices.AnalyzeRequest.CustomAnalyzerBuilder

addValidationError(String) - Method in exception org.opensearch.client.ValidationException

Add a new validation error to the accumulating validation errors

addValidationErrors(ValidationException) - Method in exception org.opensearch.client.ValidationException

Adds validation errors from an existing ValidationException to the accumulating validation errors

alias(Alias) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds an alias that will be associated with the index when it gets created

alias(Alias) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Adds an alias that will be added when the index gets created.

aliases() - Method in class org.opensearch.client.indices.CreateIndexRequest

aliases() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

aliases() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

aliases(String) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Sets the aliases that will be associated with the index when it gets created

aliases(String, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the aliases that will be associated with the index when it gets created

aliases(Collection<Alias>) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds aliases that will be associated with the index when it gets created

aliases(Map<String, ?>) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the aliases that will be associated with the index when it gets created

aliases(Map<String, ?>) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Sets the aliases that will be associated with the index when it gets created

aliases(BytesReference) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Sets the aliases that will be associated with the index when it gets created

aliases(BytesReference, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the aliases that will be associated with the index when it gets created

aliases(XContentBuilder) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the aliases that will be associated with the index when it gets created

aliases(XContentBuilder) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Sets the aliases that will be associated with the index when it gets created

ALIASES - Enum constant in enum class org.opensearch.client.indices.GetIndexRequest.Feature

analyze(AnalyzeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Calls the analyze API

analyzeAsync(AnalyzeRequest, RequestOptions, ActionListener<AnalyzeResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously calls the analyze API

analyzer() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the named analyzer used for analysis, if defined

analyzer() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

AnalyzeRequest - Class in org.opensearch.client.indices

A request to analyze text

AnalyzeRequest.CustomAnalyzerBuilder - Class in org.opensearch.client.indices

Helper class to build custom analyzer definitions

AnalyzeResponse - Class in org.opensearch.client.indices

AnalyzeResponse.AnalyzeToken - Class in org.opensearch.client.indices

AnalyzeToken() - Constructor for class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

AnalyzeTokenList(String, List<AnalyzeResponse.AnalyzeToken>) - Constructor for class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

attributes() - Method in class org.opensearch.client.indices.AnalyzeRequest

attributes(String...) - Method in class org.opensearch.client.indices.AnalyzeRequest

B

BroadcastResponse - Class in org.opensearch.client.core

Represents a response to a request that is broadcast to a collection of shards.

BroadcastResponse(BroadcastResponse.Shards) - Constructor for class org.opensearch.client.core.BroadcastResponse

BroadcastResponse.Shards - Class in org.opensearch.client.core

Represents the results of a collection of shards on which a request was executed against.

build() - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

build() - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

build() - Method in class org.opensearch.client.tasks.TaskGroup.Builder

build(String...) - Method in class org.opensearch.client.indices.AnalyzeRequest.CustomAnalyzerBuilder

buildCustomAnalyzer(String) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom analyzer built from global components

buildCustomAnalyzer(String, String) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom analyzer built from components defined on an index

buildCustomAnalyzer(String, Map<String, Object>) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom analyzer built from components defined on an index

buildCustomAnalyzer(Map<String, Object>) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom analyzer built from global components

buildCustomNormalizer() - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom normalizer built from global components

buildCustomNormalizer(String) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a custom normalizer built from components defined on an index

builder(String) - Static method in class org.opensearch.client.indices.IndexTemplateMetadata

builder(TaskInfo) - Static method in class org.opensearch.client.tasks.TaskGroup

Builder() - Constructor for class org.opensearch.client.tasks.CancelTasksRequest.Builder

Builder(String) - Constructor for class org.opensearch.client.indices.IndexTemplateMetadata.Builder

Builder(IndexTemplateMetadata) - Constructor for class org.opensearch.client.indices.IndexTemplateMetadata.Builder

bulk(BulkRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a bulk request using the Bulk API.

bulkAsync(BulkRequest, RequestOptions, ActionListener<BulkResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a bulk request using the Bulk API.

C

cancel(CancelTasksRequest, RequestOptions) - Method in class org.opensearch.client.TasksClient

Cancel one or more cluster tasks using the Task Management API.

cancelAsync(CancelTasksRequest, RequestOptions, ActionListener<CancelTasksResponse>) - Method in class org.opensearch.client.TasksClient

Asynchronously cancel one or more cluster tasks using the Task Management API.

CancelTasksRequest - Class in org.opensearch.client.tasks

CancelTasksRequest.Builder - Class in org.opensearch.client.tasks

CancelTasksResponse - Class in org.opensearch.client.tasks

cancel tasks response that contains - task failures - node failures - tasks

cause() - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

cause() - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

cause() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

cause(String) - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

The cause for this component template creation.

cause(String) - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

The cause for this index template creation.

cause(String) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The cause for this index template creation.

charfilters() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

charFilters() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the custom character filters used for analysis, if defined

cleanupRepository(CleanupRepositoryRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Cleans up a snapshot repository.

cleanupRepositoryAsync(CleanupRepositoryRequest, RequestOptions, ActionListener<CleanupRepositoryResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously cleans up a snapshot repository.

clearCache(ClearIndicesCacheRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Clears the cache of one or more indices using the Clear Cache API.

clearCacheAsync(ClearIndicesCacheRequest, RequestOptions, ActionListener<ClearIndicesCacheResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously clears the cache of one or more indices using the Clear Cache API.

clearScroll(ClearScrollRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Clears one or more scroll ids using the Clear Scroll API.

clearScrollAsync(ClearScrollRequest, RequestOptions, ActionListener<ClearScrollResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously clears one or more scroll ids using the Clear Scroll API.

clone(CloneSnapshotRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Clones a snapshot.

clone(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.clone(ResizeRequest, RequestOptions)

clone(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Clones an index using the Clone Index API.

cloneAsync(CloneSnapshotRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously clones a snapshot.

cloneAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.cloneAsync(ResizeRequest, RequestOptions, ActionListener)

cloneAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously clones an index using the Clone Index API.

close() - Method in class org.opensearch.client.RestHighLevelClient

close(CloseIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Closes an index using the Close Index API.

closeAsync(CloseIndexRequest, RequestOptions, ActionListener<CloseIndexResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously closes an index using the Close Index API.

CloseIndexRequest - Class in org.opensearch.client.indices

A request to close an index.

CloseIndexRequest(String...) - Constructor for class org.opensearch.client.indices.CloseIndexRequest

Creates a new close index request

CloseIndexResponse - Class in org.opensearch.client.indices

CloseIndexResponse(boolean, boolean, List<CloseIndexResponse.IndexResult>) - Constructor for class org.opensearch.client.indices.CloseIndexResponse

CloseIndexResponse.IndexResult - Class in org.opensearch.client.indices

CloseIndexResponse.ShardResult - Class in org.opensearch.client.indices

CloseIndexResponse.ShardResult.Failure - Class in org.opensearch.client.indices

cluster() - Method in class org.opensearch.client.RestHighLevelClient

Provides a ClusterClient which can be used to access the Cluster API.

ClusterClient - Class in org.opensearch.client

A wrapper for the RestHighLevelClient that provides methods for accessing the Cluster API.

clusterManagerNodeTimeout() - Method in class org.opensearch.client.TimedRequest

Returns the timeout for the request to be completed on the cluster-manager node

COMPLETED - Static variable in class org.opensearch.client.tasks.GetTaskResponse

COMPONENT_TEMPLATE - Static variable in class org.opensearch.client.indices.GetComponentTemplatesResponse

COMPONENT_TEMPLATES - Static variable in class org.opensearch.client.indices.GetComponentTemplatesResponse

componentTemplate(ComponentTemplate) - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

The component template to create.

ComponentTemplatesExistRequest - Class in org.opensearch.client.indices

A request to check for the existence of component templates

ComponentTemplatesExistRequest(String) - Constructor for class org.opensearch.client.indices.ComponentTemplatesExistRequest

Create a request to check for the existence of component template.

ComposableIndexTemplateExistRequest - Class in org.opensearch.client.indices

A request to check for the existence of index templates

ComposableIndexTemplateExistRequest(String) - Constructor for class org.opensearch.client.indices.ComposableIndexTemplateExistRequest

Create a request to check for the existence of index template.

convertExistsResponse(Response) - Static method in class org.opensearch.client.RestHighLevelClient

count(CountRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a count request using the Count API.

countAsync(CountRequest, RequestOptions, ActionListener<CountResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a count request using the Count API.

CountRequest - Class in org.opensearch.client.core

Encapsulates a request to _count API against one, several or all indices.

CountRequest() - Constructor for class org.opensearch.client.core.CountRequest

CountRequest(String...) - Constructor for class org.opensearch.client.core.CountRequest

Constructs a new count request against the indices.

CountRequest(String[], QueryBuilder) - Constructor for class org.opensearch.client.core.CountRequest

Constructs a new search request against the provided indices with the given query.

CountRequest(String[], SearchSourceBuilder) - Constructor for class org.opensearch.client.core.CountRequest

Deprecated.

The count api only supports a query. Use CountRequest(String[], QueryBuilder) instead.

CountResponse - Class in org.opensearch.client.core

A response to _count API request.

CountResponse(long, Boolean, CountResponse.ShardStats) - Constructor for class org.opensearch.client.core.CountResponse

CountResponse.ShardStats - Class in org.opensearch.client.core

Encapsulates _shards section of count api response.

create() - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

create() - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

create() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

create(boolean) - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

Set to true to force only creation, not an update of an component template.

create(boolean) - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

Set to true to force only creation, not an update of an index template.

create(boolean) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Set to true to force only creation, not an update of an index template.

create(CreateSnapshotRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Creates a snapshot.

create(CreateIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Creates an index using the Create Index API.

createAsync(CreateSnapshotRequest, RequestOptions, ActionListener<CreateSnapshotResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously creates a snapshot.

createAsync(CreateIndexRequest, RequestOptions, ActionListener<CreateIndexResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously creates an index using the Create Index API.

createDataStream(CreateDataStreamRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Creates a data stream using the Create Data Stream API.

createDataStreamAsync(CreateDataStreamRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously creates a data stream using the Create Data Stream API.

CreateDataStreamRequest - Class in org.opensearch.client.indices

CreateDataStreamRequest(String) - Constructor for class org.opensearch.client.indices.CreateDataStreamRequest

CreateIndexRequest - Class in org.opensearch.client.indices

A request to create an index.

CreateIndexRequest(String) - Constructor for class org.opensearch.client.indices.CreateIndexRequest

Constructs a new request to create an index with the specified name.

CreateIndexResponse - Class in org.opensearch.client.indices

A response for a create index action.

CreateIndexResponse(boolean, boolean, String) - Constructor for class org.opensearch.client.indices.CreateIndexResponse

createPit(CreatePitRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Create PIT context using create PIT API

createPitAsync(CreatePitRequest, RequestOptions, ActionListener<CreatePitResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously Create PIT context using create PIT API

createRepository(PutRepositoryRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Creates a snapshot repository.

createRepositoryAsync(PutRepositoryRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously creates a snapshot repository.

D

DataStream - Class in org.opensearch.client.indices

DataStream(String, String, List<String>, long, ClusterHealthStatus, String) - Constructor for class org.opensearch.client.indices.DataStream

dataStreamsStats(DataStreamsStatsRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Gets statistics about one or more data streams using the Get Data Streams Stats API.

dataStreamsStatsAsync(DataStreamsStatsRequest, RequestOptions, ActionListener<DataStreamsStatsResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously gets statistics about one or more data streams using the Get Data Streams Stats API.

DataStreamsStatsRequest - Class in org.opensearch.client.indices

DataStreamsStatsRequest(String...) - Constructor for class org.opensearch.client.indices.DataStreamsStatsRequest

DataStreamsStatsResponse - Class in org.opensearch.client.indices

DataStreamsStatsResponse(BroadcastResponse.Shards, int, int, ByteSizeValue, Map<String, DataStreamsStatsResponse.DataStreamStats>) - Constructor for class org.opensearch.client.indices.DataStreamsStatsResponse

DataStreamsStatsResponse.DataStreamStats - Class in org.opensearch.client.indices

DataStreamStats(String, int, ByteSizeValue, long) - Constructor for class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

declareCommonNodesResponseParsing(ConstructingObjectParser<T, Void>) - Static method in class org.opensearch.client.NodesResponse

declareShardsField(ConstructingObjectParser<T, Void>) - Static method in class org.opensearch.client.core.BroadcastResponse

DEFAULT_ACK_TIMEOUT - Static variable in class org.opensearch.client.TimedRequest

DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT - Static variable in class org.opensearch.client.TimedRequest

DEFAULT_MASTER_NODE_TIMEOUT - Static variable in class org.opensearch.client.TimedRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by TimedRequest.DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT

delete(DeleteSnapshotRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Deletes a snapshot.

delete(DeleteIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deletes an index using the Delete Index API.

delete(DeleteRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Deletes a document by id using the Delete API.

deleteAlias(DeleteAliasRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Synchronously calls the delete alias api

deleteAliasAsync(DeleteAliasRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously calls the delete alias api

DeleteAliasRequest - Class in org.opensearch.client.indices

DeleteAliasRequest(String, String) - Constructor for class org.opensearch.client.indices.DeleteAliasRequest

deleteAllPits(RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Delete all point in time searches using delete all PITs API

deleteAllPitsAsync(RequestOptions, ActionListener<DeletePitResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously Delete all point in time searches using delete all PITs API

deleteAsync(DeleteSnapshotRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously deletes a snapshot.

deleteAsync(DeleteIndexRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously deletes an index using the Delete Index API.

deleteAsync(DeleteRequest, RequestOptions, ActionListener<DeleteResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously deletes a document by id using the Delete API.

deleteByQuery(DeleteByQueryRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a delete by query request.

deleteByQueryAsync(DeleteByQueryRequest, RequestOptions, ActionListener<BulkByScrollResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a delete by query request.

deleteByQueryRethrottle(RethrottleRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a delete by query rethrottle request.

deleteByQueryRethrottleAsync(RethrottleRequest, RequestOptions, ActionListener<ListTasksResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously execute an delete by query rethrottle request.

deleteComponentTemplate(DeleteComponentTemplateRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Delete a component template using the Component Templates API

deleteComponentTemplateAsync(DeleteComponentTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously delete a component template using the Component Templates API

DeleteComponentTemplateRequest - Class in org.opensearch.client.indices

DeleteComponentTemplateRequest(String) - Constructor for class org.opensearch.client.indices.DeleteComponentTemplateRequest

DeleteComposableIndexTemplateRequest - Class in org.opensearch.client.indices

DeleteComposableIndexTemplateRequest(String) - Constructor for class org.opensearch.client.indices.DeleteComposableIndexTemplateRequest

deleteDataStream(DeleteDataStreamRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deletes a data stream using the Delete Data Stream API.

deleteDataStreamAsync(DeleteDataStreamRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously deletes a data stream using the Delete Data Stream API.

DeleteDataStreamRequest - Class in org.opensearch.client.indices

DeleteDataStreamRequest(String) - Constructor for class org.opensearch.client.indices.DeleteDataStreamRequest

deleteIndexTemplate(DeleteComposableIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Delete an index template using the Index Templates API

deleteIndexTemplateAsync(DeleteComposableIndexTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously delete an index template using the Index Templates API

deletePipeline(DeletePipelineRequest, RequestOptions) - Method in class org.opensearch.client.IngestClient

Delete an existing pipeline.

deletePipelineAsync(DeletePipelineRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IngestClient

Asynchronously delete an existing pipeline.

deletePit(DeletePitRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Delete point in time searches using delete PIT API

deletePitAsync(DeletePitRequest, RequestOptions, ActionListener<DeletePitResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously Delete point in time searches using delete PIT API

deleteRepository(DeleteRepositoryRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Deletes a snapshot repository.

deleteRepositoryAsync(DeleteRepositoryRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously deletes a snapshot repository.

deleteScript(DeleteStoredScriptRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Delete stored script by id.

deleteScriptAsync(DeleteStoredScriptRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously delete stored script by id.

DeleteSnapshotLifecyclePolicyRequest - Class in org.opensearch.client.slm

DeleteSnapshotLifecyclePolicyRequest(String) - Constructor for class org.opensearch.client.slm.DeleteSnapshotLifecyclePolicyRequest

deleteTemplate(DeleteIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Delete an index template using the Index Templates API

deleteTemplateAsync(DeleteIndexTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously delete an index template using the Index Templates API

detail() - Method in class org.opensearch.client.indices.AnalyzeResponse

DetailAnalyzeResponse - Class in org.opensearch.client.indices

DetailAnalyzeResponse.AnalyzeTokenList - Class in org.opensearch.client.indices

DetailAnalyzeResponse.CharFilteredText - Class in org.opensearch.client.indices

dryRun(boolean) - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Sets if the rollover should not be executed when conditions are met

E

EMPTY - Static variable in class org.opensearch.client.slm.SnapshotRetentionConfiguration

EMPTY - Static variable in interface org.opensearch.client.Validatable

equals(Object) - Method in class org.opensearch.client.cluster.ProxyModeInfo

equals(Object) - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

equals(Object) - Method in class org.opensearch.client.cluster.SniffModeInfo

equals(Object) - Method in class org.opensearch.client.core.AcknowledgedResponse

equals(Object) - Method in class org.opensearch.client.core.CountRequest

equals(Object) - Method in class org.opensearch.client.core.IndexerJobStats

equals(Object) - Method in class org.opensearch.client.core.MainResponse

equals(Object) - Method in class org.opensearch.client.core.MainResponse.Version

equals(Object) - Method in class org.opensearch.client.core.MultiTermVectorsResponse

equals(Object) - Method in class org.opensearch.client.core.PageParams

equals(Object) - Method in class org.opensearch.client.core.TermVectorsResponse

equals(Object) - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector

equals(Object) - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

equals(Object) - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

equals(Object) - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

equals(Object) - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

equals(Object) - Method in class org.opensearch.client.indices.AnalyzeResponse

equals(Object) - Method in class org.opensearch.client.indices.CreateIndexResponse

equals(Object) - Method in class org.opensearch.client.indices.DataStream

equals(Object) - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

equals(Object) - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

equals(Object) - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

equals(Object) - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.CharFilteredText

equals(Object) - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

equals(Object) - Method in class org.opensearch.client.indices.GetComponentTemplatesResponse

equals(Object) - Method in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

equals(Object) - Method in class org.opensearch.client.indices.GetDataStreamResponse

equals(Object) - Method in class org.opensearch.client.indices.GetFieldMappingsResponse

equals(Object) - Method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

equals(Object) - Method in class org.opensearch.client.indices.GetIndexTemplatesResponse

equals(Object) - Method in class org.opensearch.client.indices.IndexTemplateMetadata

equals(Object) - Method in class org.opensearch.client.indices.ResizeResponse

equals(Object) - Method in class org.opensearch.client.indices.rollover.RolloverResponse

equals(Object) - Method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

equals(Object) - Method in class org.opensearch.client.NodesResponseHeader

equals(Object) - Method in class org.opensearch.client.slm.DeleteSnapshotLifecyclePolicyRequest

equals(Object) - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyRequest

equals(Object) - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

equals(Object) - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyRequest

equals(Object) - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

equals(Object) - Method in class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

equals(Object) - Method in class org.opensearch.client.slm.PutSnapshotLifecyclePolicyRequest

equals(Object) - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

equals(Object) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

equals(Object) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

equals(Object) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata.SnapshotInProgress

equals(Object) - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

equals(Object) - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

equals(Object) - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

equals(Object) - Method in class org.opensearch.client.tasks.CancelTasksRequest

equals(Object) - Method in class org.opensearch.client.tasks.CancelTasksResponse

equals(Object) - Method in class org.opensearch.client.tasks.GetTaskRequest

equals(Object) - Method in class org.opensearch.client.tasks.ListTasksResponse

equals(Object) - Method in class org.opensearch.client.tasks.OpenSearchException

equals(Object) - Method in class org.opensearch.client.tasks.TaskGroup

equals(Object) - Method in class org.opensearch.client.tasks.TaskId

equals(Object) - Method in class org.opensearch.client.tasks.TaskInfo

equals(Object) - Method in class org.opensearch.client.tasks.TaskOperationFailure

equals(Object) - Method in class org.opensearch.client.tasks.TaskSubmissionResponse

ExecuteSnapshotLifecyclePolicyRequest - Class in org.opensearch.client.slm

ExecuteSnapshotLifecyclePolicyRequest(String) - Constructor for class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyRequest

ExecuteSnapshotLifecyclePolicyResponse - Class in org.opensearch.client.slm

ExecuteSnapshotLifecyclePolicyResponse(String) - Constructor for class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

ExecuteSnapshotLifecycleRetentionRequest - Class in org.opensearch.client.slm

ExecuteSnapshotLifecycleRetentionRequest() - Constructor for class org.opensearch.client.slm.ExecuteSnapshotLifecycleRetentionRequest

exists(GetRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Checks for the existence of a document.

exists(GetIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Checks if the index (indices) exists or not.

existsAlias(GetAliasesRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Checks if one or more aliases exist using the Aliases Exist API.

existsAliasAsync(GetAliasesRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.IndicesClient

Asynchronously checks if one or more aliases exist using the Aliases Exist API.

existsAsync(GetRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously checks for the existence of a document.

existsAsync(GetIndexRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.IndicesClient

Asynchronously checks if the index (indices) exists or not.

existsComponentTemplate(ComponentTemplatesExistRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Uses the Component Templates API to determine if component templates exist

existsComponentTemplateAsync(ComponentTemplatesExistRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.ClusterClient

Uses the Index Templates API to determine if index templates exist

existsIndexTemplate(ComposableIndexTemplateExistRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Uses the Index Templates API to determine if index templates exist

existsIndexTemplateAsync(ComposableIndexTemplateExistRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.IndicesClient

Uses the Index Templates API to determine if index templates exist

existsSource(GetRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.existsSource(GetSourceRequest, RequestOptions) instead

existsSource(GetSourceRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Checks for the existence of a document with a "_source" field.

existsSourceAsync(GetRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.existsSourceAsync(GetSourceRequest, RequestOptions, ActionListener) instead

existsSourceAsync(GetSourceRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously checks for the existence of a document with a "_source" field.

existsTemplate(IndexTemplatesExistRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Uses the Index Templates API to determine if index templates exist

existsTemplateAsync(IndexTemplatesExistRequest, RequestOptions, ActionListener<Boolean>) - Method in class org.opensearch.client.IndicesClient

Uses the Index Templates API to determine if index templates exist

explain() - Method in class org.opensearch.client.indices.AnalyzeRequest

explain(boolean) - Method in class org.opensearch.client.indices.AnalyzeRequest

Set whether or not detailed explanations of analysis should be returned

explain(ExplainRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a request using the Explain API.

explainAsync(ExplainRequest, RequestOptions, ActionListener<ExplainResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a request using the Explain API.

F

failed() - Method in class org.opensearch.client.core.BroadcastResponse.Shards

The number of shards on which a request failed to be executed against.

FAILED - Static variable in class org.opensearch.client.NodesResponseHeader

failures() - Method in class org.opensearch.client.core.BroadcastResponse.Shards

The failures corresponding to the shards on which a request failed to be executed against.

FAILURES - Static variable in class org.opensearch.client.NodesResponseHeader

features() - Method in class org.opensearch.client.indices.GetIndexRequest

features(GetIndexRequest.Feature...) - Method in class org.opensearch.client.indices.GetIndexRequest

fetchSourceContext() - Method in class org.opensearch.client.core.GetSourceRequest

fetchSourceContext(FetchSourceContext) - Method in class org.opensearch.client.core.GetSourceRequest

Allows setting the FetchSourceContext for this request, controlling if and how _source should be returned.

field() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the field to take an Analyzer from, if defined

fieldCaps(FieldCapabilitiesRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a request using the Field Capabilities API.

fieldCapsAsync(FieldCapabilitiesRequest, RequestOptions, ActionListener<FieldCapabilitiesResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a request using the Field Capabilities API.

FieldMappingMetadata(String, BytesReference) - Constructor for class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

fieldMappings(String, String) - Method in class org.opensearch.client.indices.GetFieldMappingsResponse

Returns the mappings of a specific index and field.

fields() - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

fields(String...) - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

FieldStatistics(long, int, long) - Constructor for class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

flush(FlushRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Flush one or more indices using the Flush API.

flushAsync(FlushRequest, RequestOptions, ActionListener<FlushResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously flush one or more indices using the Flush API.

forcemerge(ForceMergeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Force merge one or more indices using the Force Merge API.

forceMerge(ForceMergeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.forcemerge(ForceMergeRequest, RequestOptions) instead

forcemergeAsync(ForceMergeRequest, RequestOptions, ActionListener<ForceMergeResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously force merge one or more indices using the Force Merge API.

forceMergeAsync(ForceMergeRequest, RequestOptions, ActionListener<ForceMergeResponse>) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.forcemergeAsync(ForceMergeRequest, RequestOptions, ActionListener) instead

from(GetRequest) - Static method in class org.opensearch.client.core.GetSourceRequest

FROM - Static variable in class org.opensearch.client.core.PageParams

fromString(String) - Static method in enum class org.opensearch.client.core.IndexerState

fromXContent(XContentParser) - Static method in class org.opensearch.client.cluster.RemoteInfoResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.AcknowledgedResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.BroadcastResponse

Parses a broadcast response.

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.CountResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.GetSourceResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.MainResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.MultiTermVectorsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.ShardsAcknowledgedResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.TermVectorsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

fromXContent(XContentParser) - Static method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

fromXContent(XContentParser) - Static method in class org.opensearch.client.GetAliasesResponse

Parse the get aliases response

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.AnalyzeResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.CloseIndexResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.CreateIndexResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.DataStream

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.DataStreamsStatsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.DetailAnalyzeResponse.CharFilteredText

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.DetailAnalyzeResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetComponentTemplatesResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetDataStreamResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetFieldMappingsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetIndexResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetIndexTemplatesResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.GetMappingsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.ResizeResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.rollover.RolloverResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.tasks.CancelTasksResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.tasks.GetTaskResponse

fromXContent(XContentParser) - Static method in class org.opensearch.client.tasks.TaskOperationFailure

fromXContent(XContentParser) - Static method in class org.opensearch.client.tasks.TaskSubmissionResponse

fromXContent(XContentParser, String) - Static method in class org.opensearch.client.cluster.RemoteConnectionInfo

fromXContent(XContentParser, String) - Static method in class org.opensearch.client.core.TermVectorsResponse.TermVector

fromXContent(XContentParser, String) - Static method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

fromXContent(XContentParser, String) - Static method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

fromXContent(XContentParser, Void) - Static method in class org.opensearch.client.NodesResponseHeader

fullName() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

G

generateParser(String, Function<Boolean, T>, String) - Static method in class org.opensearch.client.core.AcknowledgedResponse

GENERATION_FIELD - Static variable in class org.opensearch.client.indices.DataStream

get(GetSnapshotsRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Get snapshots.

get(GetRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Retrieves a document by id using the Get API.

get(GetIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Retrieve information about one or more indexes

get(GetTaskRequest, RequestOptions) - Method in class org.opensearch.client.TasksClient

Get a task using the Task Management API.

getAction() - Method in class org.opensearch.client.tasks.TaskInfo

getActions() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getAddress() - Method in class org.opensearch.client.cluster.ProxyModeInfo

getAlias() - Method in class org.opensearch.client.indices.DeleteAliasRequest

getAlias() - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Returns the alias of the rollover operation

getAlias(GetAliasesRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Gets one or more aliases using the Get Index Aliases API.

getAliasAsync(GetAliasesRequest, RequestOptions, ActionListener<GetAliasesResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously gets one or more aliases using the Get Index Aliases API.

getAliases() - Method in class org.opensearch.client.GetAliasesResponse

Return the requested aliases

getAliases() - Method in class org.opensearch.client.indices.GetIndexResponse

getAliases() - Method in class org.opensearch.client.indices.ResizeRequest

Returns the Aliases to be used on the target index

GetAliasesResponse - Class in org.opensearch.client

Response obtained from the get aliases API.

getAllPits(RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Get all point in time searches using list all PITs API

getAllPitsAsync(RequestOptions, ActionListener<GetAllPitNodesResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously get all point in time searches using list all PITs API

getAsync(GetSnapshotsRequest, RequestOptions, ActionListener<GetSnapshotsResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously get snapshots.

getAsync(GetRequest, RequestOptions, ActionListener<GetResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously retrieves a document by id using the Get API.

getAsync(GetIndexRequest, RequestOptions, ActionListener<GetIndexResponse>) - Method in class org.opensearch.client.IndicesClient

Retrieve information about one or more indexes

getAsync(GetTaskRequest, RequestOptions, ActionListener<Optional<GetTaskResponse>>) - Method in class org.opensearch.client.TasksClient

Get a task using the Task Management API.

getAttributes() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getBackingIndices() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

getBackingIndices() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

getBuildDate() - Method in class org.opensearch.client.core.MainResponse.Version

getBuildHash() - Method in class org.opensearch.client.core.MainResponse.Version

getBuildType() - Method in class org.opensearch.client.core.MainResponse.Version

getCause() - Method in class org.opensearch.client.tasks.OpenSearchException

getChildTasks() - Method in class org.opensearch.client.tasks.TaskGroup

getClusterAlias() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

getClusterManagerNodeTimeout() - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

getClusterManagerNodeTimeout() - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

getClusterManagerNodeTimeout() - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

getClusterName() - Method in class org.opensearch.client.core.MainResponse

getClusterName() - Method in class org.opensearch.client.NodesResponse

Get the cluster name associated with all of the nodes.

getClusterUuid() - Method in class org.opensearch.client.core.MainResponse

getComponentTemplate(GetComponentTemplatesRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Gets component templates using the Components Templates API

getComponentTemplateAsync(GetComponentTemplatesRequest, RequestOptions, ActionListener<GetComponentTemplatesResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously gets component templates using the Components Templates API

getComponentTemplates() - Method in class org.opensearch.client.indices.GetComponentTemplatesResponse

GetComponentTemplatesRequest - Class in org.opensearch.client.indices

A request to read the content of component templates

GetComponentTemplatesRequest(String) - Constructor for class org.opensearch.client.indices.GetComponentTemplatesRequest

Create a request to read the content of component template.

GetComponentTemplatesResponse - Class in org.opensearch.client.indices

GetComposableIndexTemplateRequest - Class in org.opensearch.client.indices

A request to read the content of index templates

GetComposableIndexTemplateRequest(String) - Constructor for class org.opensearch.client.indices.GetComposableIndexTemplateRequest

Create a request to read the content of index template.

GetComposableIndexTemplatesResponse - Class in org.opensearch.client.indices

getConditions() - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Returns all set conditions

getConditionStatus() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

Returns the statuses of all the request conditions

getConfig() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getCount() - Method in class org.opensearch.client.core.CountResponse

Number of documents matching request.

getCreateIndexRequest() - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Returns the inner CreateIndexRequest.

getDataStream() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

getDataStream(GetDataStreamRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Gets one or more data streams using the Get Data Stream API.

getDataStreamAsync(GetDataStreamRequest, RequestOptions, ActionListener<GetDataStreamResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously gets one or more data streams using the Get Data Stream API.

getDataStreamCount() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

GetDataStreamRequest - Class in org.opensearch.client.indices

GetDataStreamRequest(String) - Constructor for class org.opensearch.client.indices.GetDataStreamRequest

GetDataStreamResponse - Class in org.opensearch.client.indices

getDataStreams() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

getDataStreams() - Method in class org.opensearch.client.indices.GetDataStreamResponse

getDataStreams() - Method in class org.opensearch.client.indices.GetIndexResponse

getDataStreamStatus() - Method in class org.opensearch.client.indices.DataStream

getDefaultSettings() - Method in class org.opensearch.client.indices.GetIndexResponse

If the originating GetIndexRequest object was configured to include defaults, this will contain a mapping of index name to Settings objects.

getDescription() - Method in class org.opensearch.client.tasks.TaskInfo

getDetails() - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

getDocCount() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

getDocFreq() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns document frequency - the number of documents in the index that contain this term

getDocVersion() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns the document version

getEndOffset() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

Returns the end offset of the token in the document's field

getEndOffset() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getError() - Method in class org.opensearch.client.GetAliasesResponse

Return the possibly returned error, null otherwise

getException() - Method in class org.opensearch.client.GetAliasesResponse

Return the exception that may have been returned

getException() - Method in class org.opensearch.client.indices.CloseIndexResponse.IndexResult

getExpireAfter() - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

getFailed() - Method in class org.opensearch.client.NodesResponseHeader

the number of nodes that the operation has failed on

getFailedShards() - Method in class org.opensearch.client.core.CountResponse

The failed number of shards the search was executed on.

getFailures() - Method in class org.opensearch.client.indices.CloseIndexResponse.ShardResult

getFailures() - Method in class org.opensearch.client.NodesResponseHeader

Get the failed node exceptions.

getFieldMapping(GetFieldMappingsRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Retrieves the field mappings on an index or indices using the Get Field Mapping API.

getFieldMappingAsync(GetFieldMappingsRequest, RequestOptions, ActionListener<GetFieldMappingsResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously retrieves the field mappings on an index or indices using the Get Field Mapping API.

GetFieldMappingsRequest - Class in org.opensearch.client.indices

Request the mappings of specific fields

GetFieldMappingsRequest() - Constructor for class org.opensearch.client.indices.GetFieldMappingsRequest

GetFieldMappingsResponse - Class in org.opensearch.client.indices

Response object for GetFieldMappingsRequest API

GetFieldMappingsResponse.FieldMappingMetadata - Class in org.opensearch.client.indices

getFieldName() - Method in class org.opensearch.client.core.AcknowledgedResponse

getFieldName() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector

Returns the field name of the current term vector

getFields() - Method in class org.opensearch.client.core.TermVectorsRequest

getFieldStatistics() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector

Returns the field statistics for the current field

getFound() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns if the document is found always true for artificial documents

getFrom() - Method in class org.opensearch.client.core.PageParams

getGeneration() - Method in class org.opensearch.client.indices.DataStream

getHeader() - Method in class org.opensearch.client.NodesResponse

Gets information about the number of total, successful and failed nodes the request was run on.

getHeaders() - Method in class org.opensearch.client.tasks.OpenSearchException

getHeaders() - Method in class org.opensearch.client.tasks.TaskInfo

getId() - Method in class org.opensearch.client.core.TermVectorsRequest

Returns the id of the request can be NULL if there is no document ID

getId() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns the id of the request can be NULL if there is no document ID

getId() - Method in class org.opensearch.client.indices.CloseIndexResponse.ShardResult

getId() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getId() - Method in class org.opensearch.client.tasks.TaskId

getIndex() - Method in class org.opensearch.client.core.TermVectorsRequest

Returns the index of the request

getIndex() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns the index for the response

getIndex() - Method in class org.opensearch.client.indices.CloseIndexResponse.IndexResult

getIndex() - Method in class org.opensearch.client.indices.DeleteAliasRequest

getIndexFailures() - Method in class org.opensearch.client.core.IndexerJobStats

Number of index failures that have occurred

GetIndexRequest - Class in org.opensearch.client.indices

A request to retrieve information about an index.

GetIndexRequest(String...) - Constructor for class org.opensearch.client.indices.GetIndexRequest

GetIndexRequest.Feature - Enum Class in org.opensearch.client.indices

GetIndexResponse - Class in org.opensearch.client.indices

A client side response for a get index action.

getIndexTemplate() - Method in class org.opensearch.client.indices.DataStream

getIndexTemplate(GetComposableIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Gets index templates using the Index Templates API

getIndexTemplate(GetIndexTemplatesRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Gets index templates using the Index Templates API

getIndexTemplateAsync(GetComposableIndexTemplateRequest, RequestOptions, ActionListener<GetComposableIndexTemplatesResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously gets index templates using the Index Templates API

getIndexTemplateAsync(GetIndexTemplatesRequest, RequestOptions, ActionListener<GetIndexTemplatesResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously gets index templates using the Index Templates API

getIndexTemplates() - Method in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

getIndexTemplates() - Method in class org.opensearch.client.indices.GetIndexTemplatesResponse

GetIndexTemplatesRequest - Class in org.opensearch.client.indices

A request to read the content of index templates

GetIndexTemplatesRequest(String...) - Constructor for class org.opensearch.client.indices.GetIndexTemplatesRequest

Create a request to read the content of one or more index templates.

GetIndexTemplatesRequest(List<String>) - Constructor for class org.opensearch.client.indices.GetIndexTemplatesRequest

Create a request to read the content of one or more index templates.

GetIndexTemplatesResponse - Class in org.opensearch.client.indices

getIndexTime() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the time spent indexing (cumulative) in milliseconds

getIndexTotal() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the total number of indexing requests that have been processed (Note: this is not the number of _documents_ that have been indexed)

getIndices() - Method in class org.opensearch.client.indices.CloseIndexResponse

getIndices() - Method in class org.opensearch.client.indices.DataStream

getIndices() - Method in class org.opensearch.client.indices.GetIndexResponse

getInfos() - Method in class org.opensearch.client.cluster.RemoteInfoResponse

getInitialConnectionTimeoutString() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

getLastFailure() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getLastSuccess() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getLowLevelClient() - Method in class org.opensearch.client.RestHighLevelClient

Returns the low-level client that the current high-level client instance is using to perform requests

getLuceneVersion() - Method in class org.opensearch.client.core.MainResponse.Version

getMapping(GetMappingsRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Retrieves the mappings on an index or indices using the Get Mapping API.

getMappingAsync(GetMappingsRequest, RequestOptions, ActionListener<GetMappingsResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously retrieves the mappings on an index on indices using the Get Mapping API.

getMappings() - Method in class org.opensearch.client.indices.GetIndexResponse

GetMappingsRequest - Class in org.opensearch.client.indices

GetMappingsRequest() - Constructor for class org.opensearch.client.indices.GetMappingsRequest

GetMappingsResponse - Class in org.opensearch.client.indices

GetMappingsResponse(Map<String, MappingMetadata>) - Constructor for class org.opensearch.client.indices.GetMappingsResponse

getMasterNodeTimeout() - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComponentTemplatesRequest.getMasterNodeTimeout()

getMasterNodeTimeout() - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComposableIndexTemplateRequest.getMasterNodeTimeout()

getMasterNodeTimeout() - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetIndexTemplatesRequest.getMasterNodeTimeout()

getMaxConnectionsPerCluster() - Method in class org.opensearch.client.cluster.SniffModeInfo

getMaximumSnapshotCount() - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

getMaximumTimestamp() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

getMaxShardSize() - Method in class org.opensearch.client.indices.ResizeRequest

Returns the maximum size of a primary shard in the new shrunken index.

getMaxSocketConnections() - Method in class org.opensearch.client.cluster.ProxyModeInfo

getMessage() - Method in exception org.opensearch.client.ValidationException

getMetrics() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

getMinimumIndexCompatibilityVersion() - Method in class org.opensearch.client.core.MainResponse.Version

getMinimumSnapshotCount() - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

getMinimumWireCompatibilityVersion() - Method in class org.opensearch.client.core.MainResponse.Version

getModeInfo() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

getModifiedDate() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getMsg() - Method in class org.opensearch.client.tasks.OpenSearchException

getName() - Method in class org.opensearch.client.indices.CreateDataStreamRequest

getName() - Method in class org.opensearch.client.indices.DataStream

getName() - Method in class org.opensearch.client.indices.DeleteComponentTemplateRequest

getName() - Method in class org.opensearch.client.indices.DeleteComposableIndexTemplateRequest

getName() - Method in class org.opensearch.client.indices.DeleteDataStreamRequest

getName() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

getName() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.CharFilteredText

getName() - Method in class org.opensearch.client.indices.GetDataStreamRequest

getName() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getName() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getNewIndex() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

Returns the name of the index that the request alias currently points to

getNewIndexName() - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Returns the new index name for the rollover

getNextExecution() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getNodeFailures() - Method in class org.opensearch.client.tasks.ListTasksResponse

getNodeId() - Method in class org.opensearch.client.indices.CloseIndexResponse.ShardResult.Failure

getNodeId() - Method in class org.opensearch.client.tasks.GetTaskRequest

getNodeId() - Method in class org.opensearch.client.tasks.TaskId

getNodeId() - Method in class org.opensearch.client.tasks.TaskInfo

getNodeId() - Method in class org.opensearch.client.tasks.TaskOperationFailure

getNodeName() - Method in class org.opensearch.client.core.MainResponse

getNodes() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getNumber() - Method in class org.opensearch.client.core.MainResponse.Version

getNumDocuments() - Method in class org.opensearch.client.core.IndexerJobStats

The number of documents read from the input indices

getNumInvocations() - Method in class org.opensearch.client.core.IndexerJobStats

Number of times that the job woke up to write documents

getNumNodesConnected() - Method in class org.opensearch.client.cluster.SniffModeInfo

getNumPages() - Method in class org.opensearch.client.core.IndexerJobStats

The number of pages read from the input indices

getNumSocketsConnected() - Method in class org.opensearch.client.cluster.ProxyModeInfo

getOldIndex() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

Returns the name of the index that the request alias was pointing to

getOutputDocuments() - Method in class org.opensearch.client.core.IndexerJobStats

Number of documents written

getParentTaskId() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getParentTaskId() - Method in class org.opensearch.client.tasks.TaskInfo

getPayload() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

Returns the payload of the token or null if the payload doesn't exist

getPerNodeTasks() - Method in class org.opensearch.client.tasks.ListTasksResponse

getPipeline(GetPipelineRequest, RequestOptions) - Method in class org.opensearch.client.IngestClient

Get an existing pipeline.

getPipelineAsync(GetPipelineRequest, RequestOptions, ActionListener<GetPipelineResponse>) - Method in class org.opensearch.client.IngestClient

Asynchronously get an existing pipeline.

getPolicies() - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

getPolicy() - Method in class org.opensearch.client.slm.PutSnapshotLifecyclePolicyRequest

getPolicy() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getPolicyId() - Method in class org.opensearch.client.slm.DeleteSnapshotLifecyclePolicyRequest

getPolicyId() - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyRequest

getPolicyId() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

getPolicyIds() - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyRequest

getPolicyStats() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getPosition() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

Returns the position of the token in the document's field

getPosition() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getPositionLength() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getPreference() - Method in class org.opensearch.client.core.TermVectorsRequest

getProcessingTime() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the time spent processing (cumulative) in milliseconds

getProcessingTotal() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the total number of processing runs that have been made

getRealtime() - Method in class org.opensearch.client.core.TermVectorsRequest

Returns if the request is realtime(true) or near-realtime(false)

getReason() - Method in class org.opensearch.client.tasks.TaskOperationFailure

getRepository() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getRepository(GetRepositoriesRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Gets a list of snapshot repositories.

getRepositoryAsync(GetRepositoriesRequest, RequestOptions, ActionListener<GetRepositoriesResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously gets a list of snapshot repositories.

getRequestsPerSecond() - Method in class org.opensearch.client.RethrottleRequest

getResourceStats() - Method in class org.opensearch.client.tasks.TaskInfo

getRetentionFailedCount() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

getRetentionPolicy() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getRetentionRunCount() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

getRetentionTimedOut() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

getRetentionTimeMillis() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

getRouting() - Method in class org.opensearch.client.core.TermVectorsRequest

getRunningTimeNanos() - Method in class org.opensearch.client.tasks.TaskInfo

getSchedule() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

getScore() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns tf-idf score, if the request used some form of terms filtering

getScript(GetStoredScriptRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Get stored script by id.

getScriptAsync(GetStoredScriptRequest, RequestOptions, ActionListener<GetStoredScriptResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously get stored script by id.

getSearchFailures() - Method in class org.opensearch.client.core.IndexerJobStats

Number of failures that have occurred

getSearchTime() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the time spent searching (cumulative) in milliseconds

getSearchTotal() - Method in class org.opensearch.client.core.IndexerJobStats

Returns the total number of search requests that have been made

getSeedNodes() - Method in class org.opensearch.client.cluster.SniffModeInfo

getServerName() - Method in class org.opensearch.client.cluster.ProxyModeInfo

getSetting(String, String) - Method in class org.opensearch.client.indices.GetIndexResponse

Returns the string value for the specified index and setting.

getSettings() - Method in class org.opensearch.client.indices.GetIndexResponse

getSettings() - Method in class org.opensearch.client.indices.ResizeRequest

Returns the Settings to be used on the target index

getSettings(ClusterGetSettingsRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Get the cluster wide settings using the Cluster Get Settings API.

getSettings(GetSettingsRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Retrieve the settings of one or more indices.

getSettingsAsync(ClusterGetSettingsRequest, RequestOptions, ActionListener<ClusterGetSettingsResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously get the cluster wide settings using the Cluster Get Settings API.

getSettingsAsync(GetSettingsRequest, RequestOptions, ActionListener<GetSettingsResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously retrieve the settings of one or more indices.

getShardFailures() - Method in class org.opensearch.client.core.CountResponse

The failures that occurred during the search.

getShardFailures() - Method in class org.opensearch.client.core.CountResponse.ShardStats

getShards() - Method in class org.opensearch.client.indices.CloseIndexResponse.IndexResult

getShardStats() - Method in class org.opensearch.client.core.CountResponse

getSize() - Method in class org.opensearch.client.core.PageParams

getSkippedShards() - Method in class org.opensearch.client.core.CountResponse

The number of shards skipped due to pre-filtering

getSkippedShards() - Method in class org.opensearch.client.core.CountResponse.ShardStats

getSnapshotDeleteFailures() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

getSnapshotInProgress() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

GetSnapshotLifecyclePolicyRequest - Class in org.opensearch.client.slm

GetSnapshotLifecyclePolicyRequest(String...) - Constructor for class org.opensearch.client.slm.GetSnapshotLifecyclePolicyRequest

GetSnapshotLifecyclePolicyResponse - Class in org.opensearch.client.slm

GetSnapshotLifecyclePolicyResponse(Map<String, SnapshotLifecyclePolicyMetadata>) - Constructor for class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

GetSnapshotLifecycleStatsRequest - Class in org.opensearch.client.slm

GetSnapshotLifecycleStatsRequest() - Constructor for class org.opensearch.client.slm.GetSnapshotLifecycleStatsRequest

GetSnapshotLifecycleStatsResponse - Class in org.opensearch.client.slm

GetSnapshotLifecycleStatsResponse(SnapshotLifecycleStats) - Constructor for class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

getSnapshotName() - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

getSnapshotName() - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

getSnapshotsDeleted() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

getSnapshotsFailed() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

getSnapshotsTaken() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

getSource() - Method in class org.opensearch.client.core.GetSourceResponse

getSource(GetSourceRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Retrieves the source field only of a document using GetSource API.

getSourceAsync(GetSourceRequest, RequestOptions, ActionListener<GetSourceResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously retrieves the source field only of a document using GetSource API.

getSourceIndex() - Method in class org.opensearch.client.indices.ResizeRequest

Returns the source index name

GetSourceRequest - Class in org.opensearch.client.core

GetSourceRequest(String, String) - Constructor for class org.opensearch.client.core.GetSourceRequest

GetSourceResponse - Class in org.opensearch.client.core

GetSourceResponse(Map<String, Object>) - Constructor for class org.opensearch.client.core.GetSourceResponse

getStartOffset() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

Returns the start offset of the token in the document's field

getStartOffset() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getStartTime() - Method in class org.opensearch.client.tasks.TaskInfo

getStats() - Method in class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

getStatus() - Method in class org.opensearch.client.tasks.TaskInfo

getStatus() - Method in class org.opensearch.client.tasks.TaskOperationFailure

getStoreSize() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

getSuccessful() - Method in class org.opensearch.client.NodesResponseHeader

the number of nodes that the operation was successful on

getSuccessfulShards() - Method in class org.opensearch.client.core.CountResponse

The successful number of shards the search was executed on.

getSuccessfulShards() - Method in class org.opensearch.client.core.CountResponse.ShardStats

getSumDocFreq() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

Returns the sum of document frequencies for all terms in this field

getSumTotalTermFreq() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

Returns the sum of total term frequencies of all terms in this field

getSuppressed() - Method in class org.opensearch.client.tasks.OpenSearchException

getTargetIndex() - Method in class org.opensearch.client.indices.ResizeRequest

Returns the target index name

getTask() - Method in class org.opensearch.client.tasks.TaskSubmissionResponse

Get the task id

getTaskFailures() - Method in class org.opensearch.client.tasks.ListTasksResponse

getTaskGroups() - Method in class org.opensearch.client.tasks.ListTasksResponse

getTaskId() - Method in class org.opensearch.client.RethrottleRequest

getTaskId() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getTaskId() - Method in class org.opensearch.client.tasks.GetTaskRequest

getTaskId() - Method in class org.opensearch.client.tasks.TaskInfo

getTaskId() - Method in class org.opensearch.client.tasks.TaskOperationFailure

getTaskInfo() - Method in class org.opensearch.client.tasks.GetTaskResponse

getTaskInfo() - Method in class org.opensearch.client.tasks.TaskGroup.Builder

getTaskInfo() - Method in class org.opensearch.client.tasks.TaskGroup

GetTaskRequest - Class in org.opensearch.client.tasks

GetTaskRequest(String, long) - Constructor for class org.opensearch.client.tasks.GetTaskRequest

GetTaskResponse - Class in org.opensearch.client.tasks

GetTaskResponse(boolean, TaskInfo) - Constructor for class org.opensearch.client.tasks.GetTaskResponse

getTasks() - Method in class org.opensearch.client.tasks.ListTasksResponse

getTerm() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns the string representation of the term

getTerm() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getTermFreq() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns term frequency - the number of times this term occurs in the current document

getTerms() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector

Returns the list of terms for the current term vector

getTermVectorsList() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns the list of term vectors

getTermVectorsResponses() - Method in class org.opensearch.client.core.MultiTermVectorsResponse

Returns the list of TermVectorsResponse for this MultiTermVectorsResponse

getTexts() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.CharFilteredText

getTimeout() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getTimeout() - Method in class org.opensearch.client.tasks.GetTaskRequest

Timeout to wait for any async actions this request must take.

getTimestamp() - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

getTimeStampField() - Method in class org.opensearch.client.indices.DataStream

getTokens() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns a list of tokens for the term

getTokens() - Method in class org.opensearch.client.indices.AnalyzeResponse

getTokens() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

getTookInMillis() - Method in class org.opensearch.client.core.TermVectorsResponse

Returns the time that a request took in milliseconds

getTotal() - Method in class org.opensearch.client.NodesResponseHeader

the total number of nodes that the operation was carried on

getTotalShards() - Method in class org.opensearch.client.core.CountResponse

The total number of shards the search was executed on.

getTotalShards() - Method in class org.opensearch.client.core.CountResponse.ShardStats

getTotalStoreSize() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

getTotalTermFreq() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

Returns total term frequency - the number of times this term occurs across all documents

getType() - Method in class org.opensearch.client.core.TermVectorsRequest

Deprecated.

Types are in the process of being removed.

getType() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

getType() - Method in class org.opensearch.client.tasks.TaskInfo

getVersion() - Method in class org.opensearch.client.core.MainResponse

getVersion() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

getWaitForActiveShards() - Method in class org.opensearch.client.indices.ResizeRequest

getWaitForCompletion() - Method in class org.opensearch.client.tasks.CancelTasksRequest

getWaitForCompletion() - Method in class org.opensearch.client.tasks.GetTaskRequest

Should this request wait for all found tasks to complete?

H

hasFailures() - Method in class org.opensearch.client.indices.CloseIndexResponse.IndexResult

hasFailures() - Method in class org.opensearch.client.indices.CloseIndexResponse.ShardResult

hasFailures() - Method in class org.opensearch.client.NodesResponseHeader

Determine if there are any node failures in NodesResponseHeader.failures.

hashCode() - Method in class org.opensearch.client.cluster.ProxyModeInfo

hashCode() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

hashCode() - Method in class org.opensearch.client.cluster.SniffModeInfo

hashCode() - Method in class org.opensearch.client.core.AcknowledgedResponse

hashCode() - Method in class org.opensearch.client.core.CountRequest

hashCode() - Method in class org.opensearch.client.core.IndexerJobStats

hashCode() - Method in class org.opensearch.client.core.MainResponse

hashCode() - Method in class org.opensearch.client.core.MainResponse.Version

hashCode() - Method in class org.opensearch.client.core.MultiTermVectorsResponse

hashCode() - Method in class org.opensearch.client.core.PageParams

hashCode() - Method in class org.opensearch.client.core.TermVectorsResponse

hashCode() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.FieldStatistics

hashCode() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector

hashCode() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

hashCode() - Method in class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

hashCode() - Method in class org.opensearch.client.indices.AnalyzeResponse.AnalyzeToken

hashCode() - Method in class org.opensearch.client.indices.AnalyzeResponse

hashCode() - Method in class org.opensearch.client.indices.CreateIndexResponse

hashCode() - Method in class org.opensearch.client.indices.DataStream

hashCode() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

hashCode() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

hashCode() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.AnalyzeTokenList

hashCode() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse.CharFilteredText

hashCode() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

hashCode() - Method in class org.opensearch.client.indices.GetComponentTemplatesResponse

hashCode() - Method in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

hashCode() - Method in class org.opensearch.client.indices.GetDataStreamResponse

hashCode() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

hashCode() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse

hashCode() - Method in class org.opensearch.client.indices.GetIndexTemplatesResponse

hashCode() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

hashCode() - Method in class org.opensearch.client.indices.ResizeResponse

hashCode() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

hashCode() - Method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

hashCode() - Method in class org.opensearch.client.NodesResponseHeader

hashCode() - Method in class org.opensearch.client.slm.DeleteSnapshotLifecyclePolicyRequest

hashCode() - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyRequest

hashCode() - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

hashCode() - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyRequest

hashCode() - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

hashCode() - Method in class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

hashCode() - Method in class org.opensearch.client.slm.PutSnapshotLifecyclePolicyRequest

hashCode() - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

hashCode() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

hashCode() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

hashCode() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata.SnapshotInProgress

hashCode() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

hashCode() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

hashCode() - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

hashCode() - Method in class org.opensearch.client.tasks.CancelTasksRequest

hashCode() - Method in class org.opensearch.client.tasks.CancelTasksResponse

hashCode() - Method in class org.opensearch.client.tasks.GetTaskRequest

hashCode() - Method in class org.opensearch.client.tasks.ListTasksResponse

hashCode() - Method in class org.opensearch.client.tasks.OpenSearchException

hashCode() - Method in class org.opensearch.client.tasks.TaskGroup

hashCode() - Method in class org.opensearch.client.tasks.TaskId

hashCode() - Method in class org.opensearch.client.tasks.TaskInfo

hashCode() - Method in class org.opensearch.client.tasks.TaskOperationFailure

hashCode() - Method in class org.opensearch.client.tasks.TaskSubmissionResponse

health(ClusterHealthRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Get cluster health using the Cluster Health API.

healthAsync(ClusterHealthRequest, RequestOptions, ActionListener<ClusterHealthResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously get cluster health using the Cluster Health API.

humanReadable() - Method in class org.opensearch.client.indices.GetIndexRequest

humanReadable(boolean) - Method in class org.opensearch.client.indices.GetIndexRequest

I

id - Variable in class org.opensearch.client.tasks.TaskId

id() - Method in class org.opensearch.client.core.GetSourceRequest

includeDefaults() - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

includeDefaults() - Method in class org.opensearch.client.indices.GetIndexRequest

Whether to return all default settings for each of the indices.

includeDefaults() - Method in class org.opensearch.client.indices.GetMappingsRequest

includeDefaults(boolean) - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

Indicates whether default mapping settings should be returned

includeDefaults(boolean) - Method in class org.opensearch.client.indices.GetIndexRequest

Sets the value of "include_defaults".

includeDefaults(boolean) - Method in class org.opensearch.client.indices.GetMappingsRequest

Indicates whether default mapping settings should be returned

index() - Method in class org.opensearch.client.core.GetSourceRequest

index() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the index that the request should be executed against, or null if no index is specified

index() - Method in class org.opensearch.client.indices.CreateIndexRequest

The name of the index to create.

index() - Method in class org.opensearch.client.indices.CreateIndexResponse

index() - Method in class org.opensearch.client.indices.ResizeResponse

index(IndexRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Index a document using the Index API.

INDEX_FAILURES - Static variable in class org.opensearch.client.core.IndexerJobStats

INDEX_TEMPLATE - Static variable in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

INDEX_TEMPLATE_FIELD - Static variable in class org.opensearch.client.indices.DataStream

INDEX_TEMPLATES - Static variable in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

INDEX_TIME_IN_MS - Static variable in class org.opensearch.client.core.IndexerJobStats

INDEX_TOTAL - Static variable in class org.opensearch.client.core.IndexerJobStats

indexAsync(IndexRequest, RequestOptions, ActionListener<IndexResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously index a document using the Index API.

IndexerJobStats - Class in org.opensearch.client.core

IndexerJobStats(long, long, long, long, long, long, long, long, long, long, long, long) - Constructor for class org.opensearch.client.core.IndexerJobStats

IndexerState - Enum Class in org.opensearch.client.core

IndexerState represents the internal state of the indexer.

indexFailures - Variable in class org.opensearch.client.core.IndexerJobStats

INDEXING - Enum constant in enum class org.opensearch.client.core.IndexerState

Indexer is actively indexing data.

indexName() - Method in class org.opensearch.client.indices.SimulateIndexTemplateRequest

Return the index name for which we simulate the index template matching.

indexName(String) - Method in class org.opensearch.client.indices.SimulateIndexTemplateRequest

Set the index name to simulate template matching against the index templates in the system.

indexTemplate(ComposableIndexTemplate) - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

The index template to create.

IndexTemplateMetadata - Class in org.opensearch.client.indices

IndexTemplateMetadata(String, int, Integer, List<String>, Settings, MappingMetadata, ImmutableOpenMap<String, AliasMetadata>) - Constructor for class org.opensearch.client.indices.IndexTemplateMetadata

IndexTemplateMetadata.Builder - Class in org.opensearch.client.indices

IndexTemplatesExistRequest - Class in org.opensearch.client.indices

A request to check for the existence of index templates

IndexTemplatesExistRequest(String...) - Constructor for class org.opensearch.client.indices.IndexTemplatesExistRequest

Create a request to check for the existence of index templates.

IndexTemplatesExistRequest(List<String>) - Constructor for class org.opensearch.client.indices.IndexTemplatesExistRequest

Create a request to check for the existence of index templates.

indexTemplateV2Request() - Method in class org.opensearch.client.indices.SimulateIndexTemplateRequest

An optional new template request will be part of the index template simulation.

indexTemplateV2Request(PutComposableIndexTemplateRequest) - Method in class org.opensearch.client.indices.SimulateIndexTemplateRequest

Optionally, define a new template request which will included in the index simulation as if it was an index template stored in the system.

indexTime - Variable in class org.opensearch.client.core.IndexerJobStats

indexTotal - Variable in class org.opensearch.client.core.IndexerJobStats

indices() - Method in class org.opensearch.client.core.CountRequest

indices() - Method in class org.opensearch.client.indices.CloseIndexRequest

Returns the indices to close

indices() - Method in class org.opensearch.client.indices.DataStreamsStatsRequest

indices() - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

indices() - Method in class org.opensearch.client.indices.GetIndexRequest

The indices into which the mappings will be put.

indices() - Method in class org.opensearch.client.indices.GetMappingsRequest

indices() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

indices() - Method in class org.opensearch.client.indices.PutMappingRequest

The indices into which the mappings will be put.

indices() - Method in class org.opensearch.client.RestHighLevelClient

Provides an IndicesClient which can be used to access the Indices API.

indices(String...) - Method in class org.opensearch.client.core.CountRequest

Sets the indices the count will be executed on.

indices(String...) - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

indices(String...) - Method in class org.opensearch.client.indices.GetMappingsRequest

INDICES_FIELD - Static variable in class org.opensearch.client.indices.DataStream

IndicesClient - Class in org.opensearch.client

A wrapper for the RestHighLevelClient that provides methods for accessing the Indices API.

indicesOptions() - Method in class org.opensearch.client.core.CountRequest

indicesOptions() - Method in class org.opensearch.client.indices.CloseIndexRequest

Specifies what type of requested indices to ignore and how to deal with wildcard expressions.

indicesOptions() - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

indicesOptions() - Method in class org.opensearch.client.indices.GetIndexRequest

indicesOptions() - Method in class org.opensearch.client.indices.GetMappingsRequest

indicesOptions() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

indicesOptions() - Method in class org.opensearch.client.indices.PutMappingRequest

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.core.CountRequest

Returns the indices options used to resolve indices.

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.indices.CloseIndexRequest

Specifies what type of requested indices to ignore and how to deal with wildcard expressions.

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.indices.GetIndexRequest

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.indices.GetMappingsRequest

indicesOptions(IndicesOptions) - Method in class org.opensearch.client.indices.PutMappingRequest

info(RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Get the cluster info otherwise provided when sending an HTTP request to '/'

ingest() - Method in class org.opensearch.client.RestHighLevelClient

Provides a IngestClient which can be used to access the Ingest API.

IngestClient - Class in org.opensearch.client

A wrapper for the RestHighLevelClient that provides methods for accessing the Ingest API.

innerToXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.CreateIndexRequest

isAcknowledged() - Method in class org.opensearch.client.core.AcknowledgedResponse

isCancellable() - Method in class org.opensearch.client.tasks.TaskInfo

isCancelled() - Method in class org.opensearch.client.tasks.TaskInfo

isCompleted() - Method in class org.opensearch.client.tasks.GetTaskResponse

isConnected() - Method in class org.opensearch.client.cluster.ProxyModeInfo

isConnected() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

isConnected() - Method in interface org.opensearch.client.cluster.RemoteConnectionInfo.ModeInfo

isConnected() - Method in class org.opensearch.client.cluster.SniffModeInfo

isDryRun() - Method in class org.opensearch.client.indices.rollover.RolloverRequest

Returns if the rollover should not be executed when conditions are met

isDryRun() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

Returns if the rollover execution was skipped even when conditions were met

isLocal() - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

isLocal() - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

isLocal() - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

isRolledOver() - Method in class org.opensearch.client.indices.rollover.RolloverResponse

Returns true if the rollover was not simulated and the conditions were met

isSet() - Method in class org.opensearch.client.tasks.TaskId

isShardsAcknowledged() - Method in class org.opensearch.client.core.ShardsAcknowledgedResponse

isSkipUnavailable() - Method in class org.opensearch.client.cluster.RemoteConnectionInfo

isSnapshot() - Method in class org.opensearch.client.core.MainResponse.Version

isTerminatedEarly() - Method in class org.opensearch.client.core.CountResponse

L

list(ListTasksRequest, RequestOptions) - Method in class org.opensearch.client.TasksClient

Get current tasks using the Task Management API.

listAsync(ListTasksRequest, RequestOptions, ActionListener<ListTasksResponse>) - Method in class org.opensearch.client.TasksClient

Asynchronously get current tasks using the Task Management API.

ListTasksResponse - Class in org.opensearch.client.tasks

local() - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

Deprecated.

local() - Method in class org.opensearch.client.indices.GetIndexRequest

Return local information, do not retrieve the state from cluster-manager node (default: false).

local() - Method in class org.opensearch.client.indices.GetMappingsRequest

local(boolean) - Method in class org.opensearch.client.indices.GetFieldMappingsRequest

Deprecated.

local(boolean) - Method in class org.opensearch.client.indices.GetIndexRequest

local(boolean) - Method in class org.opensearch.client.indices.GetMappingsRequest

Indicates whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes.

M

MainRequest - Class in org.opensearch.client.core

MainRequest() - Constructor for class org.opensearch.client.core.MainRequest

MainResponse - Class in org.opensearch.client.core

MainResponse(String, MainResponse.Version, String, String) - Constructor for class org.opensearch.client.core.MainResponse

MainResponse.Version - Class in org.opensearch.client.core

mapping(String, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds mapping that will be added when the index gets created.

mapping(String, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Adds mapping that will be added when the index gets created.

mapping(Map<String, ?>) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds mapping that will be added when the index gets created.

mapping(Map<String, Object>) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Adds mapping that will be added when the index gets created.

mapping(MappingMetadata) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

mapping(BytesReference, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds mapping that will be added when the index gets created.

mapping(BytesReference, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Adds mapping that will be added when the index gets created.

mapping(XContentBuilder) - Method in class org.opensearch.client.indices.CreateIndexRequest

Adds mapping that will be added when the index gets created.

mapping(XContentBuilder) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Adds mapping that will be added when the index gets created.

mappings() - Method in class org.opensearch.client.indices.CreateIndexRequest

mappings() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse

Returns the fields mapping.

mappings() - Method in class org.opensearch.client.indices.GetMappingsResponse

mappings() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

mappings() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

MAPPINGS - Enum constant in enum class org.opensearch.client.indices.GetIndexRequest.Feature

mappingsXContentType() - Method in class org.opensearch.client.indices.CreateIndexRequest

masterNodeTimeout() - Method in class org.opensearch.client.TimedRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by TimedRequest.clusterManagerNodeTimeout()

mget(MultiGetRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Retrieves multiple documents by id using the Multi Get API.

mgetAsync(MultiGetRequest, RequestOptions, ActionListener<MultiGetResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously retrieves multiple documents by id using the Multi Get API.

minScore() - Method in class org.opensearch.client.core.CountRequest

minScore(Float) - Method in class org.opensearch.client.core.CountRequest

modeName() - Method in class org.opensearch.client.cluster.ProxyModeInfo

modeName() - Method in interface org.opensearch.client.cluster.RemoteConnectionInfo.ModeInfo

modeName() - Method in class org.opensearch.client.cluster.SniffModeInfo

msearch(MultiSearchRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a multi search using the msearch API.

msearchAsync(MultiSearchRequest, RequestOptions, ActionListener<MultiSearchResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a multi search using the msearch API.

msearchTemplate(MultiSearchTemplateRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a request using the Multi Search Template API.

msearchTemplateAsync(MultiSearchTemplateRequest, RequestOptions, ActionListener<MultiSearchTemplateResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a request using the Multi Search Template API

mtermvectors(MultiTermVectorsRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Calls the Multi Term Vectors API

mtermvectorsAsync(MultiTermVectorsRequest, RequestOptions, ActionListener<MultiTermVectorsResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously calls the Multi Term Vectors API

multiGet(MultiGetRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.mget(MultiGetRequest, RequestOptions) instead

multiGetAsync(MultiGetRequest, RequestOptions, ActionListener<MultiGetResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.mgetAsync(MultiGetRequest, RequestOptions, ActionListener) instead

multiSearch(MultiSearchRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.msearch(MultiSearchRequest, RequestOptions) instead

multiSearchAsync(MultiSearchRequest, RequestOptions, ActionListener<MultiSearchResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.msearchAsync(MultiSearchRequest, RequestOptions, ActionListener) instead

MultiTermVectorsRequest - Class in org.opensearch.client.core

MultiTermVectorsRequest() - Constructor for class org.opensearch.client.core.MultiTermVectorsRequest

Constructs an empty MultiTermVectorsRequest After that use add method to add individual TermVectorsRequest to it.

MultiTermVectorsRequest(String[], TermVectorsRequest) - Constructor for class org.opensearch.client.core.MultiTermVectorsRequest

Constructs a MultiTermVectorsRequest from the given document ids and a template TermVectorsRequest.

MultiTermVectorsResponse - Class in org.opensearch.client.core

MultiTermVectorsResponse(List<TermVectorsResponse>) - Constructor for class org.opensearch.client.core.MultiTermVectorsResponse

N

name() - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

name() - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

name() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

name() - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

The name of the component template.

name() - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

The name of the index template.

name() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The name of the index template.

name(String) - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

Sets the name of the component template.

name(String) - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

Sets the name of the index template.

name(String) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Sets the name of the index template.

NAME - Static variable in class org.opensearch.client.cluster.SniffModeInfo

NAME - Static variable in class org.opensearch.client.indices.GetComponentTemplatesResponse

NAME - Static variable in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

NAME_FIELD - Static variable in class org.opensearch.client.indices.DataStream

names() - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

nodeFailures - Variable in class org.opensearch.client.tasks.ListTasksResponse

nodeId - Variable in class org.opensearch.client.tasks.TaskId

nodesInfoData - Variable in class org.opensearch.client.tasks.ListTasksResponse

NodesResponse - Class in org.opensearch.client

Base class for responses that are node responses.

NodesResponse(NodesResponseHeader, String) - Constructor for class org.opensearch.client.NodesResponse

NodesResponseHeader - Class in org.opensearch.client

A utility class to parse the Nodes Header returned by RestActions.buildNodesHeader(XContentBuilder, ToXContent.Params, BaseNodesResponse).

NodesResponseHeader(int, int, int, List<OpenSearchException>) - Constructor for class org.opensearch.client.NodesResponseHeader

normalizer() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the named tokenizer used for analysis, if defined

NUM_INPUT_DOCUMENTS - Static variable in class org.opensearch.client.core.IndexerJobStats

NUM_INVOCATIONS - Static variable in class org.opensearch.client.core.IndexerJobStats

NUM_OUTPUT_DOCUMENTS - Static variable in class org.opensearch.client.core.IndexerJobStats

NUM_PAGES - Static variable in class org.opensearch.client.core.IndexerJobStats

numInputDocuments - Variable in class org.opensearch.client.core.IndexerJobStats

numInvocations - Variable in class org.opensearch.client.core.IndexerJobStats

numOuputDocuments - Variable in class org.opensearch.client.core.IndexerJobStats

numPages - Variable in class org.opensearch.client.core.IndexerJobStats

O

open(OpenIndexRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Opens an index using the Open Index API.

openAsync(OpenIndexRequest, RequestOptions, ActionListener<OpenIndexResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously opens an index using the Open Index API.

OpenSearchException - Class in org.opensearch.client.tasks

client side counterpart of server side OpenSearchException It wraps the same content but it is not throwable.

order() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

order() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

order(int) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

order(int) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

org.opensearch.client - package org.opensearch.client

org.opensearch.client.cluster - package org.opensearch.client.cluster

org.opensearch.client.core - package org.opensearch.client.core

org.opensearch.client.indices - package org.opensearch.client.indices

org.opensearch.client.indices.rollover - package org.opensearch.client.indices.rollover

org.opensearch.client.slm - package org.opensearch.client.slm

org.opensearch.client.tasks - package org.opensearch.client.tasks

overlappingTemplates() - Method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

P

PAGE - Static variable in class org.opensearch.client.core.PageParams

PageParams - Class in org.opensearch.client.core

Paging parameters for GET requests

PageParams(Integer, Integer) - Constructor for class org.opensearch.client.core.PageParams

Constructs paging parameters

parse(XContentParser) - Static method in class org.opensearch.client.slm.SnapshotLifecycleStats

parse(XContentParser, String) - Static method in class org.opensearch.client.slm.SnapshotInvocationRecord

parse(XContentParser, String) - Static method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

parse(XContentParser, String) - Static method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

parse(XContentParser, String) - Static method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

parse(XContentParser, String) - Static method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

PARSE_FIELD_NAME - Static variable in class org.opensearch.client.core.AcknowledgedResponse

parseEntity(HttpEntity, CheckedFunction<XContentParser, Resp, IOException>) - Method in class org.opensearch.client.RestHighLevelClient

PARSER - Static variable in class org.opensearch.client.core.PageParams

PARSER - Static variable in class org.opensearch.client.NodesResponseHeader

PARSER - Static variable in class org.opensearch.client.slm.SnapshotInvocationRecord

PARSER - Static variable in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

PARSER - Static variable in class org.opensearch.client.tasks.TaskInfo

PARSER - Static variable in class org.opensearch.client.tasks.TaskSubmissionResponse

parseResponseException(ResponseException) - Method in class org.opensearch.client.RestHighLevelClient

Converts a ResponseException obtained from the low level REST client into an OpenSearchException.

patterns() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

patterns() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

patterns(List<String>) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

patterns(List<String>) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

performRequest(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<Response, Resp, IOException>, Set<Integer>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAndParseEntity(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<XContentParser, Resp, IOException>, Set<Integer>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAndParseOptionalEntity(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<XContentParser, Resp, IOException>) - Method in class org.opensearch.client.RestHighLevelClient

Defines a helper method for requests that can 404 and in which case will return an empty Optional otherwise tries to parse the response body

performRequestAsync(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<Response, Resp, IOException>, ActionListener<Resp>, Set<Integer>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAsyncAndParseEntity(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<XContentParser, Resp, IOException>, ActionListener<Resp>, Set<Integer>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAsyncAndParseOptionalEntity(Req, CheckedFunction<Req, Request, IOException>, RequestOptions, CheckedFunction<XContentParser, Resp, IOException>, ActionListener<Optional<Resp>>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronous request which returns empty Optionals in the case of 404s or parses entity into an Optional

ping(RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Pings the remote OpenSearch cluster and returns true if the ping succeeded, false otherwise

POLICY_ID - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

POLICY_STATS - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

preference() - Method in class org.opensearch.client.core.CountRequest

preference() - Method in class org.opensearch.client.core.GetSourceRequest

preference(String) - Method in class org.opensearch.client.core.CountRequest

Sets the preference to execute the count.

preference(String) - Method in class org.opensearch.client.core.GetSourceRequest

Sets the preference to execute the search.

PROCESSING_TIME_IN_MS - Static variable in class org.opensearch.client.core.IndexerJobStats

PROCESSING_TOTAL - Static variable in class org.opensearch.client.core.IndexerJobStats

processingTime - Variable in class org.opensearch.client.core.IndexerJobStats

processingTotal - Variable in class org.opensearch.client.core.IndexerJobStats

ProxyModeInfo - Class in org.opensearch.client.cluster

putAlias(AliasMetadata) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

putAlias(AliasMetadata.Builder) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

putComponentTemplate(PutComponentTemplateRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Puts a component template using the Component Templates API.

putComponentTemplateAsync(PutComponentTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously puts a component template using the Component Templates API.

PutComponentTemplateRequest - Class in org.opensearch.client.indices

A request to create an component template.

PutComponentTemplateRequest() - Constructor for class org.opensearch.client.indices.PutComponentTemplateRequest

PutComposableIndexTemplateRequest - Class in org.opensearch.client.indices

A request to create an index template.

PutComposableIndexTemplateRequest() - Constructor for class org.opensearch.client.indices.PutComposableIndexTemplateRequest

putIndexTemplate(PutComposableIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Puts an index template using the Index Templates API.

putIndexTemplateAsync(PutComposableIndexTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously puts an index template using the Index Templates API.

PutIndexTemplateRequest - Class in org.opensearch.client.indices

A request to create an index template.

PutIndexTemplateRequest(String) - Constructor for class org.opensearch.client.indices.PutIndexTemplateRequest

Constructs a new put index template request with the provided name.

putMapping(PutMappingRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Updates the mappings on an index using the Put Mapping API.

putMappingAsync(PutMappingRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously updates the mappings on an index using the Put Mapping API.

PutMappingRequest - Class in org.opensearch.client.indices

Put a mapping definition into one or more indices.

PutMappingRequest(String...) - Constructor for class org.opensearch.client.indices.PutMappingRequest

Constructs a new put mapping request against one or more indices.

putPipeline(PutPipelineRequest, RequestOptions) - Method in class org.opensearch.client.IngestClient

Add a pipeline or update an existing pipeline.

putPipelineAsync(PutPipelineRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IngestClient

Asynchronously add a pipeline or update an existing pipeline.

putScript(PutStoredScriptRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Puts an stored script using the Scripting API.

putScriptAsync(PutStoredScriptRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously puts an stored script using the Scripting API.

putSettings(ClusterUpdateSettingsRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Updates cluster wide specific settings using the Cluster Update Settings API.

putSettings(UpdateSettingsRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Updates specific index level settings using the Update Indices Settings API.

putSettingsAsync(ClusterUpdateSettingsRequest, RequestOptions, ActionListener<ClusterUpdateSettingsResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously updates cluster wide specific settings using the Cluster Update Settings API.

putSettingsAsync(UpdateSettingsRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously updates specific index level settings using the Update Indices Settings API.

PutSnapshotLifecyclePolicyRequest - Class in org.opensearch.client.slm

PutSnapshotLifecyclePolicyRequest(SnapshotLifecyclePolicy) - Constructor for class org.opensearch.client.slm.PutSnapshotLifecyclePolicyRequest

putTemplate(PutIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Puts an index template using the Index Templates API.

putTemplateAsync(PutIndexTemplateRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously puts an index template using the Index Templates API.

Q

query() - Method in class org.opensearch.client.core.CountRequest

query(QueryBuilder) - Method in class org.opensearch.client.core.CountRequest

Sets the query to execute for this count request.

R

rankEval(RankEvalRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a request using the Ranking Evaluation API.

rankEvalAsync(RankEvalRequest, RequestOptions, ActionListener<RankEvalResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a request using the Ranking Evaluation API.

realtime() - Method in class org.opensearch.client.core.GetSourceRequest

realtime(boolean) - Method in class org.opensearch.client.core.GetSourceRequest

refresh() - Method in class org.opensearch.client.core.GetSourceRequest

refresh(boolean) - Method in class org.opensearch.client.core.GetSourceRequest

Should a refresh be executed before this get operation causing the operation to return the latest value.

refresh(RefreshRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Refresh one or more indices using the Refresh API.

refreshAsync(RefreshRequest, RequestOptions, ActionListener<RefreshResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously refresh one or more indices using the Refresh API.

reindex(ReindexRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a reindex request.

reindexAsync(ReindexRequest, RequestOptions, ActionListener<BulkByScrollResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a reindex request.

reindexRethrottle(RethrottleRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a reindex rethrottling request.

reindexRethrottleAsync(RethrottleRequest, RequestOptions, ActionListener<ListTasksResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Executes a reindex rethrottling request.

RemoteConnectionInfo - Class in org.opensearch.client.cluster

This class encapsulates all remote cluster information to be rendered on _remote/info requests.

RemoteConnectionInfo.ModeInfo - Interface in org.opensearch.client.cluster

remoteInfo(RemoteInfoRequest, RequestOptions) - Method in class org.opensearch.client.ClusterClient

Get the remote cluster information using the Remote cluster info API.

remoteInfoAsync(RemoteInfoRequest, RequestOptions, ActionListener<RemoteInfoResponse>) - Method in class org.opensearch.client.ClusterClient

Asynchronously get remote cluster information using the Remote cluster info API.

RemoteInfoRequest - Class in org.opensearch.client.cluster

The request object used by the Remote cluster info API.

RemoteInfoRequest() - Constructor for class org.opensearch.client.cluster.RemoteInfoRequest

RemoteInfoResponse - Class in org.opensearch.client.cluster

A response to _remote/info API request.

ResizeRequest - Class in org.opensearch.client.indices

Request class to resize an index

ResizeRequest(String, String) - Constructor for class org.opensearch.client.indices.ResizeRequest

Creates a new resize request

ResizeResponse - Class in org.opensearch.client.indices

The response from a ResizeRequest call

ResizeResponse(boolean, boolean, String) - Constructor for class org.opensearch.client.indices.ResizeResponse

resolvedTemplate() - Method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

RestHighLevelClient - Class in org.opensearch.client

High level REST client that wraps an instance of the low level RestClient and allows to build requests and read responses.

RestHighLevelClient(RestClientBuilder) - Constructor for class org.opensearch.client.RestHighLevelClient

Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests.

RestHighLevelClient(RestClientBuilder, List<NamedXContentRegistry.Entry>) - Constructor for class org.opensearch.client.RestHighLevelClient

Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests and parsers for custom response sections added to OpenSearch through plugins.

RestHighLevelClient(RestClient, CheckedConsumer<RestClient, IOException>, List<NamedXContentRegistry.Entry>) - Constructor for class org.opensearch.client.RestHighLevelClient

Creates a RestHighLevelClient given the low level RestClient that it should use to perform requests and a list of entries that allow to parse custom response sections added to OpenSearch through plugins.

restore(RestoreSnapshotRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Restores a snapshot.

restoreAsync(RestoreSnapshotRequest, RequestOptions, ActionListener<RestoreSnapshotResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously restores a snapshot.

RETENTION_FAILED - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

RETENTION_RUNS - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

RETENTION_TIME - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

RETENTION_TIME_MILLIS - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

RETENTION_TIMED_OUT - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

RethrottleRequest - Class in org.opensearch.client

A request changing throttling of a task.

RethrottleRequest(TaskId) - Constructor for class org.opensearch.client.RethrottleRequest

Create a new RethrottleRequest which disables any throttling for the given taskId.

RethrottleRequest(TaskId, float) - Constructor for class org.opensearch.client.RethrottleRequest

Create a new RethrottleRequest which changes the throttling for the given taskId.

rollover(RolloverRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Rolls over an index using the Rollover Index API.

rolloverAsync(RolloverRequest, RequestOptions, ActionListener<RolloverResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously rolls over an index using the Rollover Index API.

RolloverRequest - Class in org.opensearch.client.indices.rollover

Request class to swap index under an alias upon satisfying conditions

RolloverRequest(String, String) - Constructor for class org.opensearch.client.indices.rollover.RolloverRequest

RolloverResponse - Class in org.opensearch.client.indices.rollover

Response object for RolloverRequest API

RolloverResponse(String, String, Map<String, Boolean>, boolean, boolean, boolean, boolean) - Constructor for class org.opensearch.client.indices.rollover.RolloverResponse

routing() - Method in class org.opensearch.client.core.CountRequest

routing() - Method in class org.opensearch.client.core.GetSourceRequest

routing(String) - Method in class org.opensearch.client.core.CountRequest

The routing values to control the shards that the search will be executed on.

routing(String) - Method in class org.opensearch.client.core.GetSourceRequest

Controls the shard routing of the request.

routing(String...) - Method in class org.opensearch.client.core.CountRequest

A comma separated list of routing values to control the shards the count will be executed on.

S

scroll(SearchScrollRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a search using the Search Scroll API.

scrollAsync(SearchScrollRequest, RequestOptions, ActionListener<SearchResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a search using the Search Scroll API.

search(SearchRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a search request using the Search API.

SEARCH_FAILURES - Static variable in class org.opensearch.client.core.IndexerJobStats

SEARCH_TIME_IN_MS - Static variable in class org.opensearch.client.core.IndexerJobStats

SEARCH_TOTAL - Static variable in class org.opensearch.client.core.IndexerJobStats

searchAsync(SearchRequest, RequestOptions, ActionListener<SearchResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a search using the Search API.

searchFailures - Variable in class org.opensearch.client.core.IndexerJobStats

searchScroll(SearchScrollRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.scroll(SearchScrollRequest, RequestOptions) instead

searchScrollAsync(SearchScrollRequest, RequestOptions, ActionListener<SearchResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Deprecated.

use RestHighLevelClient.scrollAsync(SearchScrollRequest, RequestOptions, ActionListener) instead

searchTemplate(SearchTemplateRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a request using the Search Template API.

searchTemplateAsync(SearchTemplateRequest, RequestOptions, ActionListener<SearchTemplateResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes a request using the Search Template API.

searchTime - Variable in class org.opensearch.client.core.IndexerJobStats

searchTotal - Variable in class org.opensearch.client.core.IndexerJobStats

setAliases(List<Alias>) - Method in class org.opensearch.client.indices.ResizeRequest

Sets the Aliases to be used on the target index

setClusterManagerNodeTimeout(String) - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

setClusterManagerNodeTimeout(String) - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

setClusterManagerNodeTimeout(String) - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

setClusterManagerNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

setClusterManagerNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

setClusterManagerNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

setClusterManagerTimeout(TimeValue) - Method in class org.opensearch.client.TimedRequest

Sets the timeout to connect to the cluster-manager node

setFields(String...) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets the fields for which term vectors information should be retrieved

setFieldStatistics(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets whether to request field statistics

setFilterSettings(Map<String, Integer>) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets conditions for terms filtering

setLocal(boolean) - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

setLocal(boolean) - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

setLocal(boolean) - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

setMasterNodeTimeout(String) - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComponentTemplatesRequest.setClusterManagerNodeTimeout(String)

setMasterNodeTimeout(String) - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComposableIndexTemplateRequest.setClusterManagerNodeTimeout(String)

setMasterNodeTimeout(String) - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetIndexTemplatesRequest.setClusterManagerNodeTimeout(String)

setMasterNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetComponentTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComponentTemplatesRequest.setClusterManagerNodeTimeout(TimeValue)

setMasterNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetComposableIndexTemplateRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetComposableIndexTemplateRequest.setClusterManagerNodeTimeout(TimeValue)

setMasterNodeTimeout(TimeValue) - Method in class org.opensearch.client.indices.GetIndexTemplatesRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by GetIndexTemplatesRequest.setClusterManagerNodeTimeout(TimeValue)

setMasterTimeout(TimeValue) - Method in class org.opensearch.client.TimedRequest

Deprecated.

As of 2.2, because supporting inclusive language, replaced by TimedRequest.setClusterManagerTimeout(TimeValue)

setMaxShardSize(ByteSizeValue) - Method in class org.opensearch.client.indices.ResizeRequest

Sets the maximum size of a primary shard in the new shrunken index.

setOffsets(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets whether to request term offsets

setPayloads(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets whether to request term payloads

setPerFieldAnalyzer(Map<String, String>) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets different analyzers than the one at the fields

setPositions(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets whether to request term positions

setPreference(String) - Method in class org.opensearch.client.core.TermVectorsRequest

Set a preference of which shard copies to execute the request

setRealtime(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets if the request should be realtime or near-realtime

setRouting(String) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets a routing to route a request to a particular shard

setSettings(Settings) - Method in class org.opensearch.client.indices.ResizeRequest

Sets the Settings to be used on the target index

setTermStatistics(boolean) - Method in class org.opensearch.client.core.TermVectorsRequest

Sets whether to request term statistics

setTimeout(TimeValue) - Method in class org.opensearch.client.tasks.GetTaskRequest

Timeout to wait for any async actions this request must take.

setTimeout(TimeValue) - Method in class org.opensearch.client.TimedRequest

Sets the timeout to wait for the all the nodes to acknowledge

settings() - Method in class org.opensearch.client.indices.CreateIndexRequest

The settings to create the index with.

settings() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

settings() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

settings(String, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

The settings to create the index with (either json or yaml format)

settings(String, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The settings to create the index template with (either json/yaml format).

settings(Map<String, ?>) - Method in class org.opensearch.client.indices.CreateIndexRequest

The settings to create the index with (either json/yaml/properties format)

settings(Map<String, Object>) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The settings to create the index template with (either json or yaml format).

settings(Settings) - Method in class org.opensearch.client.indices.CreateIndexRequest

The settings to create the index with.

settings(Settings) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

settings(Settings) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The settings to create the index template with.

settings(Settings.Builder) - Method in class org.opensearch.client.indices.CreateIndexRequest

The settings to create the index with.

settings(Settings.Builder) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

settings(Settings.Builder) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The settings to create the index template with.

settings(XContentBuilder) - Method in class org.opensearch.client.indices.CreateIndexRequest

Allows to set the settings using a json builder.

SETTINGS - Enum constant in enum class org.opensearch.client.indices.GetIndexRequest.Feature

setWaitForActiveShards(int) - Method in class org.opensearch.client.indices.ResizeRequest

A shortcut for ResizeRequest.setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.

setWaitForActiveShards(ActiveShardCount) - Method in class org.opensearch.client.indices.ResizeRequest

Sets the number of shard copies that should be active for creation of the new shrunken index to return.

setWaitForCompletion(boolean) - Method in class org.opensearch.client.tasks.CancelTasksRequest

setWaitForCompletion(boolean) - Method in class org.opensearch.client.tasks.GetTaskRequest

Should this request wait for all found tasks to complete?

shards() - Method in class org.opensearch.client.core.BroadcastResponse

Represents the shard-level summary of the response execution.

SHARDS_PARSE_FIELD_NAME - Static variable in class org.opensearch.client.core.ShardsAcknowledgedResponse

ShardsAcknowledgedResponse - Class in org.opensearch.client.core

ShardsAcknowledgedResponse(boolean, boolean) - Constructor for class org.opensearch.client.core.ShardsAcknowledgedResponse

ShardStats(int, int, int, ShardSearchFailure[]) - Constructor for class org.opensearch.client.core.CountResponse.ShardStats

shrink(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.shrink(ResizeRequest, RequestOptions)

shrink(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Shrinks an index using the Shrink Index API.

shrinkAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.shrinkAsync(ResizeRequest, RequestOptions, ActionListener)

shrinkAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously shrinks an index using the Shrink index API.

simulate(SimulatePipelineRequest, RequestOptions) - Method in class org.opensearch.client.IngestClient

Simulate a pipeline on a set of documents provided in the request

simulateAsync(SimulatePipelineRequest, RequestOptions, ActionListener<SimulatePipelineResponse>) - Method in class org.opensearch.client.IngestClient

Asynchronously simulate a pipeline on a set of documents provided in the request

simulateIndexTemplate(SimulateIndexTemplateRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Simulates matching index name against the existing index templates in the system.

simulateIndexTemplateAsync(SimulateIndexTemplateRequest, RequestOptions, ActionListener<SimulateIndexTemplateResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously simulates matching index name against the existing index templates in the system.

SimulateIndexTemplateRequest - Class in org.opensearch.client.indices

A request to simulate matching a provided index name and an optional new index template against the existing index templates.

SimulateIndexTemplateRequest(String) - Constructor for class org.opensearch.client.indices.SimulateIndexTemplateRequest

SimulateIndexTemplateResponse - Class in org.opensearch.client.indices

SIZE - Static variable in class org.opensearch.client.core.PageParams

skipped() - Method in class org.opensearch.client.core.BroadcastResponse.Shards

The number of shards skipped by the request.

snapshot() - Method in class org.opensearch.client.RestHighLevelClient

Provides a SnapshotClient which can be used to access the Snapshot API.

SnapshotClient - Class in org.opensearch.client

A wrapper for the RestHighLevelClient that provides methods for accessing the Snapshot API.

SnapshotInProgress(SnapshotId, String, long, String) - Constructor for class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata.SnapshotInProgress

SnapshotInvocationRecord - Class in org.opensearch.client.slm

SnapshotInvocationRecord(String, long, String) - Constructor for class org.opensearch.client.slm.SnapshotInvocationRecord

SnapshotLifecycleManagementStatusRequest - Class in org.opensearch.client.slm

SnapshotLifecycleManagementStatusRequest() - Constructor for class org.opensearch.client.slm.SnapshotLifecycleManagementStatusRequest

SnapshotLifecyclePolicy - Class in org.opensearch.client.slm

SnapshotLifecyclePolicy(String, String, String, String, Map<String, Object>, SnapshotRetentionConfiguration) - Constructor for class org.opensearch.client.slm.SnapshotLifecyclePolicy

SnapshotLifecyclePolicyMetadata - Class in org.opensearch.client.slm

SnapshotLifecyclePolicyMetadata(SnapshotLifecyclePolicy, long, long, SnapshotInvocationRecord, SnapshotInvocationRecord, long, SnapshotLifecyclePolicyMetadata.SnapshotInProgress, SnapshotLifecycleStats.SnapshotPolicyStats) - Constructor for class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

SnapshotLifecyclePolicyMetadata.SnapshotInProgress - Class in org.opensearch.client.slm

SnapshotLifecycleStats - Class in org.opensearch.client.slm

SnapshotLifecycleStats.SnapshotPolicyStats - Class in org.opensearch.client.slm

SnapshotPolicyStats(String, long, long, long, long) - Constructor for class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

SnapshotRetentionConfiguration - Class in org.opensearch.client.slm

SnapshotRetentionConfiguration(TimeValue, Integer, Integer) - Constructor for class org.opensearch.client.slm.SnapshotRetentionConfiguration

SniffModeInfo - Class in org.opensearch.client.cluster

source() - Method in class org.opensearch.client.core.CountRequest

Deprecated.

The count api only supports a query. Use CountRequest.query() instead.

source() - Method in class org.opensearch.client.indices.PutMappingRequest

The mapping source definition.

source(byte[], int, int, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(byte[], XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(String, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the settings and mappings as a single source.

source(String, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(String, XContentType) - Method in class org.opensearch.client.indices.PutMappingRequest

The mapping source definition.

source(Map<String, ?>) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the settings and mappings as a single source.

source(Map<String, ?>) - Method in class org.opensearch.client.indices.PutMappingRequest

The mapping source definition.

source(Map<String, Object>) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(BytesReference, XContentType) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the settings and mappings as a single source.

source(BytesReference, XContentType) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(BytesReference, XContentType) - Method in class org.opensearch.client.indices.PutMappingRequest

The mapping source definition.

source(XContentBuilder) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the settings and mappings as a single source.

source(XContentBuilder) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

The template source definition.

source(XContentBuilder) - Method in class org.opensearch.client.indices.PutMappingRequest

The mapping source definition.

source(SearchSourceBuilder) - Method in class org.opensearch.client.core.CountRequest

Deprecated.

The count api only supports a query. Use CountRequest.query(QueryBuilder) instead.

sourceAsMap() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

Returns the mappings as a map.

split(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.split(ResizeRequest, RequestOptions)

split(ResizeRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Splits an index using the Split Index API.

splitAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Deprecated.

use IndicesClient.splitAsync(ResizeRequest, RequestOptions, ActionListener)

splitAsync(ResizeRequest, RequestOptions, ActionListener<ResizeResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously splits an index using the Split Index API.

STARTED - Enum constant in enum class org.opensearch.client.core.IndexerState

Indexer is running, but not actively indexing data (e.g.

StartSLMRequest - Class in org.opensearch.client.slm

StartSLMRequest() - Constructor for class org.opensearch.client.slm.StartSLMRequest

status() - Method in class org.opensearch.client.core.CountResponse

status() - Method in class org.opensearch.client.GetAliasesResponse

status(SnapshotsStatusRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Gets the status of requested snapshots.

STATUS_FIELD - Static variable in class org.opensearch.client.indices.DataStream

statusAsync(SnapshotsStatusRequest, RequestOptions, ActionListener<SnapshotsStatusResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously gets the status of requested snapshots.

STOPPED - Enum constant in enum class org.opensearch.client.core.IndexerState

Indexer is "paused" and ignoring scheduled triggers.

STOPPING - Enum constant in enum class org.opensearch.client.core.IndexerState

Transition state to where an indexer has acknowledged the stop but is still in process of halting.

StopSLMRequest - Class in org.opensearch.client.slm

StopSLMRequest() - Constructor for class org.opensearch.client.slm.StopSLMRequest

submitDeleteByQueryTask(DeleteByQueryRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Submits a delete by query task

submitReindexTask(ReindexRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Submits a reindex task.

submitUpdateByQueryTask(UpdateByQueryRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Submits a update by query task.

successful() - Method in class org.opensearch.client.core.BroadcastResponse.Shards

The number of successful shards on which a request was executed against.

SUCCESSFUL - Static variable in class org.opensearch.client.NodesResponseHeader

T

TASK - Static variable in class org.opensearch.client.tasks.GetTaskResponse

taskFailures - Variable in class org.opensearch.client.tasks.ListTasksResponse

TaskGroup - Class in org.opensearch.client.tasks

Client side counterpart of server side version.

TaskGroup(TaskInfo, List<TaskGroup>) - Constructor for class org.opensearch.client.tasks.TaskGroup

TaskGroup.Builder - Class in org.opensearch.client.tasks

taskGroups - Variable in class org.opensearch.client.tasks.ListTasksResponse

TaskId - Class in org.opensearch.client.tasks

client side version of a TaskId

TaskId(String) - Constructor for class org.opensearch.client.tasks.TaskId

accepts a raw format task id

TaskId(String, long) - Constructor for class org.opensearch.client.tasks.TaskId

TaskInfo - Class in org.opensearch.client.tasks

client side counterpart of server side

TaskInfo(TaskId) - Constructor for class org.opensearch.client.tasks.TaskInfo

TaskOperationFailure - Class in org.opensearch.client.tasks

client side counterpart of server side TaskOperationFailure

TaskOperationFailure(String, long, String, OpenSearchException) - Constructor for class org.opensearch.client.tasks.TaskOperationFailure

tasks - Variable in class org.opensearch.client.tasks.ListTasksResponse

tasks() - Method in class org.opensearch.client.RestHighLevelClient

Provides a TasksClient which can be used to access the Tasks API.

TasksClient - Class in org.opensearch.client

A wrapper for the RestHighLevelClient that provides methods for accessing the Tasks API.

TaskSubmissionResponse - Class in org.opensearch.client.tasks

Term(String, int, Integer, Long, Float, List<TermVectorsResponse.TermVector.Token>) - Constructor for class org.opensearch.client.core.TermVectorsResponse.TermVector.Term

terminateAfter() - Method in class org.opensearch.client.core.CountRequest

terminateAfter(int) - Method in class org.opensearch.client.core.CountRequest

TermVector(String, TermVectorsResponse.TermVector.FieldStatistics, List<TermVectorsResponse.TermVector.Term>) - Constructor for class org.opensearch.client.core.TermVectorsResponse.TermVector

termvectors(TermVectorsRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Calls the Term Vectors API

termvectorsAsync(TermVectorsRequest, RequestOptions, ActionListener<TermVectorsResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously calls the Term Vectors API

TermVectorsRequest - Class in org.opensearch.client.core

TermVectorsRequest(String, String) - Constructor for class org.opensearch.client.core.TermVectorsRequest

Constructs TermVectorRequest for the given document

TermVectorsRequest(String, String, String) - Constructor for class org.opensearch.client.core.TermVectorsRequest

Deprecated.

Types are in the process of being removed, use TermVectorsRequest(String, String) instead.

TermVectorsRequest(String, String, XContentBuilder) - Constructor for class org.opensearch.client.core.TermVectorsRequest

Deprecated.

Types are in the process of being removed, use TermVectorsRequest(java.lang.String,org.opensearch.common.xcontent.XContentBuilder) instead.

TermVectorsRequest(String, XContentBuilder) - Constructor for class org.opensearch.client.core.TermVectorsRequest

Constructs TermVectorRequest for an artificial document

TermVectorsResponse - Class in org.opensearch.client.core

TermVectorsResponse(String, String, long, boolean, long, List<TermVectorsResponse.TermVector>) - Constructor for class org.opensearch.client.core.TermVectorsResponse

TermVectorsResponse.TermVector - Class in org.opensearch.client.core

TermVectorsResponse.TermVector.FieldStatistics - Class in org.opensearch.client.core

TermVectorsResponse.TermVector.Term - Class in org.opensearch.client.core

TermVectorsResponse.TermVector.Token - Class in org.opensearch.client.core

text() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the text to be analyzed

TimedRequest - Class in org.opensearch.client

A base request for any requests that supply timeouts.

TimedRequest() - Constructor for class org.opensearch.client.TimedRequest

timeout() - Method in class org.opensearch.client.TimedRequest

Returns the request timeout

TIMESTAMP_FIELD_FIELD - Static variable in class org.opensearch.client.indices.DataStream

Token(Integer, Integer, Integer, String) - Constructor for class org.opensearch.client.core.TermVectorsResponse.TermVector.Token

tokenfilters() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

tokenFilters() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns the custom token filters used for analysis, if defined

tokenizer() - Method in class org.opensearch.client.indices.AnalyzeRequest

Returns a custom Tokenizer used for analysis, if defined

tokenizer() - Method in class org.opensearch.client.indices.DetailAnalyzeResponse

toString() - Method in class org.opensearch.client.core.CountResponse.ShardStats

toString() - Method in class org.opensearch.client.core.CountResponse

toString() - Method in class org.opensearch.client.core.GetSourceResponse

toString() - Method in class org.opensearch.client.core.IndexerJobStats

toString() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse.DataStreamStats

toString() - Method in class org.opensearch.client.indices.DataStreamsStatsResponse

toString() - Method in class org.opensearch.client.indices.GetComponentTemplatesResponse

toString() - Method in class org.opensearch.client.indices.GetComposableIndexTemplatesResponse

toString() - Method in class org.opensearch.client.indices.GetDataStreamResponse

toString() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse.FieldMappingMetadata

toString() - Method in class org.opensearch.client.indices.GetFieldMappingsResponse

toString() - Method in class org.opensearch.client.indices.GetIndexTemplatesResponse

toString() - Method in class org.opensearch.client.indices.SimulateIndexTemplateResponse

toString() - Method in class org.opensearch.client.RethrottleRequest

toString() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

toString() - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata.SnapshotInProgress

toString() - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

toString() - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

toString() - Method in class org.opensearch.client.tasks.CancelTasksRequest

toString() - Method in class org.opensearch.client.tasks.CancelTasksResponse

toString() - Method in class org.opensearch.client.tasks.ListTasksResponse

toString() - Method in class org.opensearch.client.tasks.OpenSearchException

toString() - Method in class org.opensearch.client.tasks.TaskGroup

toString() - Method in class org.opensearch.client.tasks.TaskId

toString() - Method in class org.opensearch.client.tasks.TaskInfo

toString() - Method in class org.opensearch.client.tasks.TaskOperationFailure

total() - Method in class org.opensearch.client.core.BroadcastResponse.Shards

The total number of shards on which a request was executed against.

TOTAL - Static variable in class org.opensearch.client.NodesResponseHeader

TOTAL_DELETION_FAILURES - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

TOTAL_DELETIONS - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

TOTAL_FAILED - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

TOTAL_TAKEN - Static variable in class org.opensearch.client.slm.SnapshotLifecycleStats

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.core.CountRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.core.MultiTermVectorsRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.core.PageParams

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.core.TermVectorsRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.GetAliasesResponse

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.AnalyzeRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.CreateIndexRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.PutComponentTemplateRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.PutComposableIndexTemplateRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.PutMappingRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.ResizeRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.indices.rollover.RolloverRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.ExecuteSnapshotLifecyclePolicyResponse

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.GetSnapshotLifecyclePolicyResponse

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.GetSnapshotLifecycleStatsResponse

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.PutSnapshotLifecyclePolicyRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotInvocationRecord

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicy

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata.SnapshotInProgress

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotLifecyclePolicyMetadata

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotLifecycleStats.SnapshotPolicyStats

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotLifecycleStats

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.opensearch.client.slm.SnapshotRetentionConfiguration

type() - Method in class org.opensearch.client.core.GetSourceRequest

type(String) - Method in class org.opensearch.client.core.GetSourceRequest

types() - Method in class org.opensearch.client.core.CountRequest

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.

types(String...) - Method in class org.opensearch.client.core.CountRequest

Deprecated.

Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.

U

update(UpdateRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Updates a document using the Update API.

updateAliases(IndicesAliasesRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Updates aliases using the Index Aliases API.

updateAliasesAsync(IndicesAliasesRequest, RequestOptions, ActionListener<AcknowledgedResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously updates aliases using the Index Aliases API.

updateAsync(UpdateRequest, RequestOptions, ActionListener<UpdateResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously updates a document using the Update API.

updateByQuery(UpdateByQueryRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a update by query request.

updateByQueryAsync(UpdateByQueryRequest, RequestOptions, ActionListener<BulkByScrollResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously executes an update by query request.

updateByQueryRethrottle(RethrottleRequest, RequestOptions) - Method in class org.opensearch.client.RestHighLevelClient

Executes a update by query rethrottle request.

updateByQueryRethrottleAsync(RethrottleRequest, RequestOptions, ActionListener<ListTasksResponse>) - Method in class org.opensearch.client.RestHighLevelClient

Asynchronously execute an update by query rethrottle request.

V

Validatable - Interface in org.opensearch.client

Defines a validation layer for Requests.

validate() - Method in class org.opensearch.client.core.CountRequest

validate() - Method in class org.opensearch.client.indices.CloseIndexRequest

validate() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

validate() - Method in class org.opensearch.client.indices.ResizeRequest

validate() - Method in class org.opensearch.client.tasks.GetTaskRequest

validate() - Method in interface org.opensearch.client.Validatable

Perform validation.

validateQuery(ValidateQueryRequest, RequestOptions) - Method in class org.opensearch.client.IndicesClient

Validate a potentially expensive query without executing it.

validateQueryAsync(ValidateQueryRequest, RequestOptions, ActionListener<ValidateQueryResponse>) - Method in class org.opensearch.client.IndicesClient

Asynchronously validate a potentially expensive query without executing it.

validationErrors() - Method in exception org.opensearch.client.ValidationException

Returns the validation errors accumulated

ValidationException - Exception in org.opensearch.client

Encapsulates an accumulation of validation errors

ValidationException() - Constructor for exception org.opensearch.client.ValidationException

value() - Method in enum class org.opensearch.client.core.IndexerState

valueOf(String) - Static method in enum class org.opensearch.client.core.IndexerState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.opensearch.client.indices.GetIndexRequest.Feature

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.opensearch.client.core.IndexerState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.opensearch.client.indices.GetIndexRequest.Feature

Returns an array containing the constants of this enum class, in the order they are declared.

verifyRepository(VerifyRepositoryRequest, RequestOptions) - Method in class org.opensearch.client.SnapshotClient

Verifies a snapshot repository.

verifyRepositoryAsync(VerifyRepositoryRequest, RequestOptions, ActionListener<VerifyRepositoryResponse>) - Method in class org.opensearch.client.SnapshotClient

Asynchronously verifies a snapshot repository.

version() - Method in class org.opensearch.client.indices.IndexTemplateMetadata

version() - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

version(Integer) - Method in class org.opensearch.client.indices.IndexTemplateMetadata.Builder

version(Integer) - Method in class org.opensearch.client.indices.PutIndexTemplateRequest

Version(String, String, String, String, boolean, String, String, String) - Constructor for class org.opensearch.client.core.MainResponse.Version

W

waitForActiveShards() - Method in class org.opensearch.client.indices.CloseIndexRequest

Returns the wait for active shard count or null if the default should be used

waitForActiveShards() - Method in class org.opensearch.client.indices.CreateIndexRequest

waitForActiveShards(ActiveShardCount) - Method in class org.opensearch.client.indices.CloseIndexRequest

Sets the number of shard copies that should be active for indices opening to return.

waitForActiveShards(ActiveShardCount) - Method in class org.opensearch.client.indices.CreateIndexRequest

Sets the number of shard copies that should be active for index creation to return.

withActionsFiltered(List<String>) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

withError(String...) - Static method in exception org.opensearch.client.ValidationException

Creates ValidationException instance initialized with given error messages.

withErrors(List<String>) - Static method in exception org.opensearch.client.ValidationException

Creates ValidationException instance initialized with given error messages.

withField(String, String, String...) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using the analyzer defined on a specific field within an index

withGlobalAnalyzer(String, String...) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a global analyzer

withIndexAnalyzer(String, String, String...) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a named analyzer on an index

withNodesFiltered(List<String>) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

withNormalizer(String, String, String...) - Static method in class org.opensearch.client.indices.AnalyzeRequest

Analyzes text using a named normalizer on an index

withParentTaskId(TaskId) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

withTaskId(TaskId) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

withTimeout(TimeValue) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

withWaitForCompletion(boolean) - Method in class org.opensearch.client.tasks.CancelTasksRequest.Builder

X

xContentType() - Method in class org.opensearch.client.indices.PutMappingRequest

The XContentType of the mapping source.

A B C D E F G H I L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form