Namespace OpenSearch.Client

Classes

A request to the indices add block API

AdjacencyMatrixAggregationDescriptor<T>

AggregateDictionary

Contains aggregates that are returned by OpenSearch. In OSC, Aggregation always refers to an aggregation request to OpenSearch and an Aggregate describes an aggregation response.

AggregationContainerDescriptor<T>

AggregationDictionary

Describes aggregations that we would like to execute on OpenSearch.

In OSC Aggregation always refers to an aggregation sent to OpenSearch and an Aggregate describes an aggregation returned from OpenSearch.

AliasExistsDescriptor

Descriptor for AliasExists

https://opensearch.org/docs/latest

AliasExistsRequest

Request for AliasExists

https://opensearch.org/docs/latest

AliasPointingToIndexExtensions

AllocateClusterRerouteCommandBase

AllocateClusterRerouteCommandDescriptorBase<TDescriptor, TInterface>

AllocateEmptyPrimaryRerouteCommand

AllocateEmptyPrimaryRerouteCommandDescriptor

AllocateReplicaClusterRerouteCommand

AllocateReplicaClusterRerouteCommandDescriptor

AllocateStalePrimaryRerouteCommand

AllocateStalePrimaryRerouteCommandDescriptor

AllocationAttributesDescriptor

AllocationAwarenessSettingsDescriptor

AllocationFilteringSettingsDescriptor

AlternativeEnumMemberAttribute

Similar to EnumMemberAttribute, but allows an alternative string value to be specified for an enum field value.

AnalyzeDescriptor

Descriptor for Analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

AnalyzeRequest

Request for Analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

AnalyzeTokenFilters

A list of string references to stored token filters and/or inline token filter definitions

AnalyzerDescriptorBase<TAnalyzer, TAnalyzerInterface>

ArbitraryBodyHttpRequestBase<TParams>

ArbitraryBodyHttpRequestDescriptorBase<TSelf, TParams, TInterface>

ArbitraryHttpRequestBase<TParams>

ArbitraryHttpRequestDescriptorBase<TSelf, TParams, TInterface>

AsciiFoldingTokenFilterDescriptor

Attachment

An attachment indexed with an ingest pipeline using the ingest-attachment plugin. Convenience class for working with attachment fields.

The ingest attachment plugin lets OpenSearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. You can use the ingest attachment plugin as a replacement for the mapper attachment plugin.

AttachmentProcessorDescriptor<T>

AutoDateHistogramAggregate

AutoDateHistogramAggregation

AutoDateHistogramAggregationDescriptor<T>

AutoExpandReplicas

AverageAggregation

AverageAggregationDescriptor<T>

AverageBucketAggregation

AverageBucketAggregationDescriptor

AzureRepository

AzureRepositoryDescriptor

A snapshot repository that stores snapshots in an Azure storage account

Requires the repository-azure plugin to be installed on the cluster

AzureRepositorySettings

AzureRepositorySettingsDescriptor

BM25Similarity

BM25SimilarityDescriptor

BinaryAttribute

BinaryProperty

BinaryPropertyDescriptor<T>

BlockedIndex

BlockingSubscribeExtensions

BoolQuery

BoolQueryDescriptor<T>

BooleanAttribute

BooleanProperty

BooleanPropertyDescriptor<T>

BoostingQuery

BoostingQueryDescriptor<T>

BoundingBox

BoundingBoxDescriptor

BreakerStats

BucketAggregate

Intermediate Aggregation response, transformed to a more specific aggregation response when requested.

BucketAggregateBase

BucketAggregationBase

BucketAggregationDescriptorBase<TBucketAggregation, TBucketAggregationInterface, T>

BucketBase

BucketScriptAggregation

BucketScriptAggregationDescriptor

BucketSelectorAggregation

BucketSelectorAggregationDescriptor

BucketSortAggregation

A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. Zero or more sort fields may be specified together with the corresponding sort order. Each bucket may be sorted based on its _key, _count or its sub-aggregations. In addition, parameters from and size may be set in order to truncate the result buckets.

BucketSortAggregationDescriptor<T>

BulkAliasDescriptor

Descriptor for BulkAlias

https://opensearch.org/docs/latest/api-reference/index-apis/alias/

BulkAliasRequest

Request for BulkAlias

https://opensearch.org/docs/latest/api-reference/index-apis/alias/

BulkAliasResponse

BulkAllDescriptor<T>

BulkAllObservable<T>

BulkAllObserver

BulkAllRequest<T>

BulkAllResponse

BulkCreateDescriptor<T>

BulkCreateOperation<T>

BulkCreateResponseItem

BulkDeleteDescriptor<T>

BulkDeleteOperation<T>

BulkDeleteResponseItem

BulkDescriptor

Descriptor for Bulk

https://opensearch.org/docs/latest/api-reference/document-apis/bulk/

BulkIndexByScrollFailure

BulkIndexDescriptor<T>

BulkIndexOperation<T>

BulkIndexResponseItem

BulkOperationBase

BulkOperationDescriptorBase<TDescriptor, TInterface>

BulkOperationsCollection<TOperation>

This class is used by Operations which needs thread safe adding Add(T) as well as expose an equivalent of AddRange(IEnumerable<T>). Because operations from OpenSearch are executed in order none of the types in System.Collection.Concurrent can't be used for this. We need to preserve insert order and exposed indexed index because Items is ordered and lines up with Operations allowing one to zip the two together.

BulkRequest

Request for Bulk

https://opensearch.org/docs/latest/api-reference/document-apis/bulk/

BulkResponse

BulkResponseItemBase

An item within a bulk response

BulkUpdateDescriptor<TDocument, TPartialDocument>

BulkUpdateOperation<TDocument, TPartialDocument>

BulkUpdateResponseItem

BytesProcessor

Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

BytesProcessorDescriptor<T>

CancelClusterRerouteCommand

CancelClusterRerouteCommandDescriptor

CancelTasksDescriptor

Descriptor for Cancel

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling

CancelTasksRequest

Request for Cancel

https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling

CancelTasksResponse

CardinalityAggregation

CardinalityAggregationDescriptor<T>

CartesianPoint

Represents a point in the cartesian plane.

CatAliasesDescriptor

Descriptor for Aliases

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

CatAliasesRecord

CatAliasesRequest

Request for Aliases

https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/

CatAllPitSegmentsDescriptor

Descriptor for AllPitSegments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

CatAllPitSegmentsRecord

CatAllPitSegmentsRequest

Request for AllPitSegments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

CatAllocationDescriptor

Descriptor for Allocation

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

CatAllocationRecord

CatAllocationRequest

Request for Allocation

https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/

CatClusterManagerDescriptor

Descriptor for ClusterManager

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

CatClusterManagerRecord

See docs here

CatClusterManagerRequest

Request for ClusterManager

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

CatCountDescriptor

Descriptor for Count

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

CatCountRecord

CatCountRequest

Request for Count

https://opensearch.org/docs/latest/api-reference/cat/cat-count/

CatFielddataDescriptor

Descriptor for Fielddata

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

CatFielddataRecord

CatFielddataRequest

Request for Fielddata

https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/

CatHealthDescriptor

Descriptor for Health

https://opensearch.org/docs/latest/api-reference/cat/cat-health/

CatHealthRecord

CatHealthRequest

Request for Health

https://opensearch.org/docs/latest/api-reference/cat/cat-health/

CatHelpDescriptor

Descriptor for Help

https://opensearch.org/docs/latest/api-reference/cat/index/

CatHelpRecord

CatHelpRequest

Request for Help

https://opensearch.org/docs/latest/api-reference/cat/index/

CatIndicesDescriptor

Descriptor for Indices

https://opensearch.org/docs/latest/api-reference/cat/cat-indices/

CatIndicesRecord

CatIndicesRequest

Request for Indices

https://opensearch.org/docs/latest/api-reference/cat/cat-indices/

CatMasterDescriptor

Descriptor for Master

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

CatMasterRecord

See docs here

CatMasterRequest

Request for Master

https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/

CatNodeAttributesDescriptor

Descriptor for NodeAttributes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

CatNodeAttributesRecord

CatNodeAttributesRequest

Request for NodeAttributes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

CatNodesDescriptor

Descriptor for Nodes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/

CatNodesRecord

CatNodesRequest

Request for Nodes

https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/

CatPendingTasksDescriptor

Descriptor for PendingTasks

https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/

CatPendingTasksRecord

CatPendingTasksRequest

Request for PendingTasks

https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/

CatPitSegmentsDescriptor

Descriptor for PitSegments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

CatPitSegmentsRecord

CatPitSegmentsRequest

Request for PitSegments

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

CatPluginsDescriptor

Descriptor for Plugins

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

CatPluginsRecord

CatPluginsRequest

Request for Plugins

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

CatRecoveryDescriptor

Descriptor for Recovery

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

CatRecoveryRecord

CatRecoveryRequest

Request for Recovery

https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/

CatRepositoriesDescriptor

Descriptor for Repositories

https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/

CatRepositoriesRecord

CatRepositoriesRequest

Request for Repositories

https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/

CatResponse<TCatRecord>

CatSegmentReplicationDescriptor

Descriptor for SegmentReplication

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

CatSegmentReplicationRecord

CatSegmentReplicationRequest

Request for SegmentReplication

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

CatSegmentsDescriptor

Descriptor for Segments

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

CatSegmentsRecord

CatSegmentsRequest

Request for Segments

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

CatShardsDescriptor

Descriptor for Shards

https://opensearch.org/docs/latest/api-reference/cat/cat-shards/

CatShardsRecord

CatShardsRequest

Request for Shards

https://opensearch.org/docs/latest/api-reference/cat/cat-shards/

CatSnapshotsDescriptor

Descriptor for Snapshots

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

CatSnapshotsRecord

CatSnapshotsRequest

Request for Snapshots

https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/

CatTasksDescriptor

Descriptor for Tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/

CatTasksRecord

CatTasksRequest

Request for Tasks

https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/

CatTemplatesDescriptor

Descriptor for Templates

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

CatTemplatesRecord

CatTemplatesRequest

Request for Templates

https://opensearch.org/docs/latest/api-reference/cat/cat-templates/

CatThreadPoolDescriptor

Descriptor for ThreadPool

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

CatThreadPoolRecord

CatThreadPoolRequest

Request for ThreadPool

https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/

CategorySuggestContext

CategorySuggestContextDescriptor<T>

CharFilterBase

CharFilterDescriptorBase<TCharFilter, TCharFilterInterface>

CharFilterDetail

CharFilters

CharFiltersDescriptor

CharGroupTokenizer

A tokenizer that breaks text into terms whenever it encounters a character which is in a defined set. It is mostly useful for cases where a simple custom tokenization is desired, and the overhead of use of PatternTokenizer is not acceptable.

CharGroupTokenizerDescriptor

ChiSquareHeuristic

ChiSquareHeuristicDescriptor

Children

ChildrenAggregation

ChildrenAggregationDescriptor<T>

CircleGeoShape

CircuitBreakerSettings

CircuitBreakerSettingsDescriptor

CleanupRepositoryDescriptor

Descriptor for CleanupRepository

https://opensearch.org/docs/latest

CleanupRepositoryRequest

Request for CleanupRepository

https://opensearch.org/docs/latest

CleanupRepositoryResponse

CleanupRepositoryResults

ClearCacheDescriptor

Descriptor for ClearCache

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

ClearCacheRequest

Request for ClearCache

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

ClearCacheResponse

ClearScrollDescriptor

Descriptor for ClearScroll

https://opensearch.org/docs/latest/api-reference/scroll/

ClearScrollRequest

Request for ClearScroll

https://opensearch.org/docs/latest/api-reference/scroll/

ClearScrollResponse

CloneIndexDescriptor

A request to the clone index API

CloneIndexRequest

A request to the clone index API

CloneIndexResponse

CloneSnapshotDescriptor

Descriptor for Clone

https://opensearch.org/docs/latest

CloneSnapshotRequest

Request for Clone

https://opensearch.org/docs/latest

CloneSnapshotResponse

CloseIndexDescriptor

Descriptor for Close

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/

CloseIndexRequest

Request for Close

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/

CloseIndexResponse

CloseIndexResult

CloseShardResult

ClrPropertyMappingBase<TDocument>

ClrTypeMapping

ClrTypeMappingDescriptor

ClrTypeMappingDescriptor<TDocument>

ClrTypeMapping<TDocument>

ClusterAllocationExplainDescriptor

Descriptor for AllocationExplain

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/

ClusterAllocationExplainRequest

Request for AllocationExplain

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/

ClusterAllocationExplainResponse

ClusterFileSystem

ClusterGetSettingsDescriptor

Descriptor for GetSettings

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

ClusterGetSettingsRequest

Request for GetSettings

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

ClusterGetSettingsResponse

ClusterHealthDescriptor

Descriptor for Health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

ClusterHealthRequest

Request for Health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

ClusterHealthResponse

ClusterIndicesShardsIndexStats

ClusterIndicesShardsStats

ClusterIndicesStats

ClusterIngestStats

ClusterJvm

ClusterJvmMemory

ClusterJvmVersion

ClusterModuleSettings

ClusterModuleSettingsDescriptor

ClusterNetworkTypes

ClusterNodeCount

ClusterNodesStats

ClusterOperatingSystemName

ClusterOperatingSystemPrettyName

ClusterOperatingSystemStats

ClusterPendingTasksDescriptor

Descriptor for PendingTasks

https://opensearch.org/docs/latest

ClusterPendingTasksRequest

Request for PendingTasks

https://opensearch.org/docs/latest

ClusterPendingTasksResponse

ClusterProcess

ClusterProcessCpu

ClusterProcessOpenFileDescriptors

ClusterProcessorStats

ClusterPutSettingsDescriptor

Descriptor for PutSettings

https://opensearch.org/docs/latest/api-reference/cluster-settings/

ClusterPutSettingsRequest

Request for PutSettings

https://opensearch.org/docs/latest/api-reference/cluster-settings/

ClusterPutSettingsResponse

ClusterRerouteDecision

ClusterRerouteDescriptor

Descriptor for Reroute

https://opensearch.org/docs/latest

ClusterRerouteExplanation

ClusterRerouteParameters

ClusterRerouteRequest

Request for Reroute

https://opensearch.org/docs/latest

ClusterRerouteResponse

ClusterShardMetrics

ClusterStateDescriptor

Descriptor for State

https://opensearch.org/docs/latest

ClusterStateRequest

Request for State

https://opensearch.org/docs/latest

ClusterStateResponse

ClusterStatistics

ClusterStatsDescriptor

Descriptor for Stats

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

ClusterStatsRequest

Request for Stats

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

ClusterStatsResponse

Collector

CommonGramsTokenFilter

CommonGramsTokenFilterDescriptor

CompactNodeInfo

CompletionAttribute

CompletionField

A field mapped as an ICompletionProperty. Convenience class to use when indexing completion fields.

CompletionProperty

CompletionPropertyDescriptor<T>

CompletionStats

CompletionSuggester

The completion suggester provides auto-complete/search-as-you-type functionality. This is a navigational feature to guide users to relevant results as they are typing, improving search precision. It is not meant for spell correction or did-you-mean functionality like the term or phrase suggesters.

CompletionSuggesterDescriptor<T>

ComponentTemplate

ComponentTemplateExistsDescriptor

Descriptor for ComponentTemplateExists

https://opensearch.org/docs/latest

ComponentTemplateExistsRequest

Request for ComponentTemplateExists

https://opensearch.org/docs/latest

ComposableIndexTemplate

ComposableIndexTemplateExistsDescriptor

Descriptor for ComposableTemplateExists

https://opensearch.org/docs/latest/im-plugin/index-templates/

ComposableIndexTemplateExistsRequest

Request for ComposableTemplateExists

https://opensearch.org/docs/latest/im-plugin/index-templates/

CompositeAggregation

A multi-bucket aggregation that creates composite buckets from different sources.

CompositeAggregationDescriptor<T>

A multi-bucket aggregation that creates composite buckets from different sources.

CompositeAggregationSourceBase

CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T>

A values source for ICompositeAggregation

CompositeAggregationSourcesDescriptor<T>

A values source for ICompositeAggregation

CompositeBucket

A bucket with a composite key

CompositeBucketAggregate

Aggregation response of CompositeAggregation

CompositeKey

A key for a CompositeBucket

CompoundWordTokenFilterBase

CompoundWordTokenFilterDescriptorBase<TCompound, TCompoundInterface>

ConditionTokenFilter

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

ConditionTokenFilterDescriptor

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

ConditionlessQueryDescriptor<T>

ConnectionSettings

Provides the connection settings for OpenSearchClient

ConstantScoreQuery

ConstantScoreQueryDescriptor<T>

Context

ContextScriptStats

ConvertProcessor

ConvertProcessorDescriptor<T>

CoordinatedRequestObserverBase<T>

CorePropertyBase

Core properties of a mapping for a property type to a document field in OpenSearch

CorePropertyDescriptorBase<TDescriptor, TInterface, T>

Core properties of a mapping for a property type to a document field in OpenSearch

CountDescriptor<TDocument>

Descriptor for Count

https://opensearch.org/docs/latest/api-reference/count/

CountRequest

Request for Count

https://opensearch.org/docs/latest/api-reference/count/

CountRequest<TDocument>

CountResponse

CreateDescriptor<TDocument>

Descriptor for Create

https://opensearch.org/docs/latest/api-reference/document-apis/index-document/

CreateIndexDescriptor

Descriptor for Create

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/

CreateIndexRequest

Request for Create

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/

CreateIndexResponse

CreatePitDescriptor

Descriptor for CreatePit

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

CreatePitRequest

Request for CreatePit

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

CreatePitResponse

CreateRepositoryDescriptor

Creates a snapshot repository

CreateRepositoryRequest

Creates a snapshot repository

CreateRepositoryResponse

CreateRequest<TDocument>

Request for Create

https://opensearch.org/docs/latest/api-reference/document-apis/index-document/

CreateResponse

CsvProcessor

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

CsvProcessorDescriptor<T>

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

CumulativeSumAggregation

CumulativeSumAggregationDescriptor

CurrentNode

CustomAnalyzer

CustomAnalyzerDescriptor

CustomNormalizer

CustomNormalizerDescriptor

CustomSimilarity

CustomSimilarityDescriptor

DFISimilarity

DFISimilarityDescriptor

DFRSimilarity

DFRSimilarityDescriptor

DataStreamTemplate

DataStreamTemplateDescriptor

DateAttribute

DateFormat

DateHistogramAggregation

DateHistogramAggregationDescriptor<T>

DateHistogramBucket

DateHistogramCompositeAggregationSource

A values source that can be applied on date values to build fixed size interval over the values. The interval parameter defines a date/time expression that determines how values should be transformed. For instance an interval set to month will translate any values to its closest month interval..

DateHistogramCompositeAggregationSourceDescriptor<T>

DateIndexNameProcessor

DateIndexNameProcessorDescriptor<T>

DateMath

DateMathExpression

DateMathOperationExtensions

DateMathTime

A time representation for use within DateMath expressions.

DateMathTimeUnitExtensions

DateNanosAttribute

DateNanosProperty

DateNanosPropertyDescriptor<T>

DateProcessor

DateProcessorDescriptor<T>

DateProperty

DatePropertyDescriptor<T>

DateRange

DateRangeAggregation

DateRangeAggregationDescriptor<T>

DateRangeAttribute

DateRangeExpression

DateRangeExpressionDescriptor

DateRangeProperty

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

DateRangePropertyDescriptor<T>

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

DateRangeQuery

DateRangeQueryDescriptor<T>

DecayFunctionBase<TOrigin, TScale>

DecayFunctionDescriptorBase<TDescriptor, TOrigin, TScale, T>

DeleteAliasDescriptor

Descriptor for DeleteAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases

DeleteAliasRequest

Request for DeleteAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases

DeleteAliasResponse

DeleteAllPitsDescriptor

Descriptor for DeleteAllPits

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

DeleteAllPitsRequest

Request for DeleteAllPits

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

DeleteAllPitsResponse

DeleteByQueryDescriptor<TDocument>

Delete documents that match a given query

DeleteByQueryRequest

Delete documents that match a given query

DeleteByQueryRequest<TDocument>

Delete documents that match a given query

DeleteByQueryResponse

DeleteByQueryRethrottleDescriptor

Rethrottles a running delete by query

DeleteByQueryRethrottleRequest

Rethrottles a running delete by query

DeleteComponentTemplateDescriptor

Descriptor for DeleteComponentTemplate

https://opensearch.org/docs/latest

DeleteComponentTemplateRequest

Request for DeleteComponentTemplate

https://opensearch.org/docs/latest

DeleteComponentTemplateResponse

DeleteComposableIndexTemplateDescriptor

Descriptor for DeleteComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template

DeleteComposableIndexTemplateRequest

Request for DeleteComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template

DeleteComposableIndexTemplateResponse

DeleteDanglingIndexDescriptor

Descriptor for DeleteDanglingIndex

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

DeleteDanglingIndexRequest

Request for DeleteDanglingIndex

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

DeleteDanglingIndexResponse

DeleteDescriptor<TDocument>

Descriptor for Delete

https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/

DeleteIndexDescriptor

Descriptor for Delete

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/

DeleteIndexRequest

Request for Delete

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/

DeleteIndexResponse

DeleteIndexTemplateDescriptor

Descriptor for DeleteTemplate

https://opensearch.org/docs/latest

DeleteIndexTemplateRequest

Request for DeleteTemplate

https://opensearch.org/docs/latest

DeleteIndexTemplateResponse

DeleteManyExtensions

Provides DeleteMany extensions that make it easier to get many documents given a list of ids

DeletePipelineDescriptor

Descriptor for DeletePipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/

DeletePipelineRequest

Request for DeletePipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/

DeletePipelineResponse

DeletePitDescriptor

Descriptor for DeletePit

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

DeletePitRequest

Request for DeletePit

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

DeletePitResponse

DeleteRepositoryDescriptor

Descriptor for DeleteRepository

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/

DeleteRepositoryRequest

Request for DeleteRepository

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/

DeleteRepositoryResponse

DeleteRequest

Request for Delete

https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/

DeleteRequest<TDocument>

DeleteResponse

DeleteScriptDescriptor

Descriptor for DeleteScript

https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/

DeleteScriptRequest

Request for DeleteScript

https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/

DeleteScriptResponse

DeleteSnapshotDescriptor

Descriptor for Delete

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/

DeleteSnapshotRequest

Request for Delete

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/

DeleteSnapshotResponse

DeleteVotingConfigExclusionsDescriptor

Descriptor for DeleteVotingConfigExclusions

https://opensearch.org/docs/latest

DeleteVotingConfigExclusionsRequest

Request for DeleteVotingConfigExclusions

https://opensearch.org/docs/latest

DeleteVotingConfigExclusionsResponse

DeletedPit

DelimitedPayloadTokenFilter

DelimitedPayloadTokenFilterDescriptor

DerivativeAggregation

DerivativeAggregationDescriptor

DescriptorBase<TDescriptor, TInterface>

DescriptorPromiseBase<TDescriptor, TValue>

DictionaryDecompounderTokenFilter

DictionaryDecompounderTokenFilterDescriptor

DictionaryResponseBase<TKey, TValue>

DirectGenerator

DirectGeneratorDescriptor<T>

DisMaxQuery

DisMaxQueryDescriptor<T>

DiskBasedShardAllocationSettings

DiskBasedShardAllocationSettingsDescriptor

DissectProcessor

Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document. However unlike the Grok Processor, dissect does not use Regular Expressions. This allows dissect’s syntax to be simple and, for some cases faster, than the Grok Processor.

DissectProcessorDescriptor<T>

Distance

DistanceFeatureQuery

Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location. You can use the distance_feature query to find the nearest neighbors to a location. You can also use the query in a bool search’s should filter to add boosted relevance scores to the bool query’s scores.

DistanceFeatureQueryDescriptor<T>

DiversifiedSamplerAggregation

DiversifiedSamplerAggregationDescriptor<T>

DocStats

DocValuesPropertyBase

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

DocValuesPropertyDescriptorBase<TDescriptor, TInterface, T>

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

DocumentExistsDescriptor<TDocument>

Descriptor for DocumentExists

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

DocumentExistsRequest

Request for DocumentExists

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

DocumentExistsRequest<TDocument>

DocumentPath<T>

DocumentSimulation

DotExpanderProcessor

Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor.

DotExpanderProcessorDescriptor<T>

DoubleRange

DoubleRangeAttribute

DoubleRangeProperty

A range of double-precision 64-bit IEEE 754 floating point values.

DoubleRangePropertyDescriptor<T>

A range of double-precision 64-bit IEEE 754 floating point values.

DropProcessor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

DropProcessorDescriptor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

DslPrettyPrintVisitor

DynamicIndexSettings

DynamicIndexSettingsDescriptor

Dynamic index settings

DynamicIndexSettingsDescriptorBase<TDescriptor, TIndexSettings>

Base descriptor implementation for dynamic index settings

DynamicResponseBase

DynamicTemplate

DynamicTemplateContainer

DynamicTemplateContainerDescriptor<T>

DynamicTemplateDescriptor<T>

A Dynamic template that defines custom mappings to be applied to dynamically added fields based on:

- the datatype detected by OpenSearch, with MatchMappingType.

- the name of the field, with Match and Unmatch or MatchPattern.

- the full dotted path to the field, with PathMatch and PathUnmatch.

EdgeNGramTokenFilter

EdgeNGramTokenFilterDescriptor

EdgeNGramTokenizer

EdgeNGramTokenizerDescriptor

ElisionTokenFilter

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

ElisionTokenFilterDescriptor

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

EnvelopeGeoShape

EpochDateTimeAttribute

Signals that this date time property returns the date as epoch.

EwmaModel

EwmaModelDescriptor

ExecutePainlessScriptDescriptor

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

ExecutePainlessScriptRequest

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

ExecutePainlessScriptResponse<TResult>

ExistsQuery

ExistsQueryDescriptor<T>

ExistsResponse

ExplainAnalyzeToken

ExplainDescriptor<TDocument>

Descriptor for Explain

https://opensearch.org/docs/latest/api-reference/explain/

ExplainRequest

Request for Explain

https://opensearch.org/docs/latest/api-reference/explain/

ExplainRequest<TDocument>

ExplainResponse<TDocument>

Explanation

ExplanationDetail

ExponentialDateDecayFunction

ExponentialDecayFunction

ExponentialDecayFunctionBase<TOrigin, TScale>

ExponentialDecayFunctionDescriptor<TOrigin, TScale, T>

ExponentialGeoDecayFunction

ExpressionExtensions

ExtendedBounds<T>

ExtendedStatsAggregate

ExtendedStatsAggregation

ExtendedStatsAggregationDescriptor<T>

ExtendedStatsBucketAggregation

ExtendedStatsBucketAggregationDescriptor

FailProcessor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

FailProcessorDescriptor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

Field

FieldAliasProperty

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

FieldAliasPropertyDescriptor<T>

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

FieldCapabilities

FieldCapabilitiesDescriptor

Descriptor for FieldCapabilities

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

FieldCapabilitiesFields

FieldCapabilitiesRequest

Request for FieldCapabilities

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

FieldCapabilitiesResponse

FieldCollapse

Allows to collapse search results based on field values. The collapsing is done by selecting only the top sorted document per collapse key. For instance the query below retrieves the best tweet for each user and sorts them by number of likes.

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

FieldCollapseDescriptor<T>

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

FieldLookup

FieldLookupDescriptor<T>

FieldMapping

FieldNameQueryBase

FieldNameQueryDescriptorBase<TDescriptor, TInterface, T>

FieldNamesField

FieldNamesFieldDescriptor<T>

FieldResolver

FieldSort

FieldSortDescriptor<T>

FieldStatistics

FieldTypes

FieldValueFactorFunction

FieldValueFactorFunctionDescriptor<T>

FieldValues

FielddataBase

FielddataDescriptorBase<TDescriptor, TInterface>

FielddataFilter

FielddataFilterDescriptor

FielddataFrequencyFilter

FielddataFrequencyFilterDescriptor

FielddataRegexFilter

FielddataRegexFilterDescriptor

FielddataSettings

FielddataStats

Fields

FieldsDescriptor<T>

FileCountSnapshotStats

FileSystemRepository

FileSystemRepositoryDescriptor

A snapshot repository that uses a shared file system to store snapshot data. The path specified in the location parameter should point to the same location in the shared filesystem and be accessible on all data and cluster_manager nodes.

FileSystemRepositorySettings

Repository settings for IFileSystemRepository

FileSystemRepositorySettingsDescriptor

Repository settings for IFileSystemRepository

FileSystemStats

FileSystemStats.DataPathStats

FileSystemStats.TotalFileSystemStats

FilterAggregation

FilterAggregationDescriptor<T>

FiltersAggregate

FiltersAggregation

FiltersAggregationDescriptor<T>

FiltersBucketItem

FingerprintAnalyzer

FingerprintAnalyzerDescriptor

FingerprintProcessor

FingerprintProcessorDescriptor<T>

FingerprintTokenFilter

FingerprintTokenFilterDescriptor

FixedIndexSettings

const string collection of known OpenSearch index settings that can only be provided at index creation time

FloatRange

FloatRangeAttribute

FloatRangeProperty

A range of single-precision 32-bit IEEE 754 floating point values.

FloatRangePropertyDescriptor<T>

A range of single-precision 32-bit IEEE 754 floating point values.

FluentDictionary<TKey, TValue>

FlushDescriptor

Descriptor for Flush

https://opensearch.org/docs/latest

FlushRequest

Request for Flush

https://opensearch.org/docs/latest

FlushResponse

FlushStats

ForceMergeDescriptor

Descriptor for ForceMerge

https://opensearch.org/docs/latest

ForceMergeRequest

Request for ForceMerge

https://opensearch.org/docs/latest

ForceMergeResponse

ForeachProcessor

Processes elements in an array of unknown length. All processors can operate on elements inside an array, but if all elements of an array need to be processed in the same way, defining a processor for each element becomes cumbersome and tricky because it is likely that the number of elements in an array is unknown. For this reason the foreach processor exists. By specifying the field holding array elements and a processor that defines what should happen to each element, array fields can easily be preprocessed.

ForeachProcessorDescriptor<T>

FormattableMetricAggregationBase

FormattableMetricAggregationDescriptorBase<TFormattableMetricAggregation, TFormattableMetricAggregationInterface, T>

FunctionScoreFunction

FunctionScoreFunctionBase

FunctionScoreFunctionDescriptorBase<TDescriptor, TInterface, T>

FunctionScoreFunctionDescriptor<T>

FunctionScoreQuery

FunctionScoreQueryDescriptor<T>

Fuzziness

FuzzyDateQuery

FuzzyDateQueryDescriptor<T>

FuzzyNumericQuery

FuzzyNumericQueryDescriptor<T>

FuzzyQuery

FuzzyQueryBase<TValue, TFuzziness>

FuzzyQueryDescriptorBase<TDescriptor, T, TValue, TFuzziness>

FuzzyQueryDescriptor<T>

GatewaySettings

GaussDateDecayFunction

GaussDecayFunction

GaussDecayFunctionBase<TOrigin, TScale>

GaussDecayFunctionDescriptor<TOrigin, TScale, T>

GaussGeoDecayFunction

GenericProperty

A generic property to map properties that may be of different types. Not all methods are valid for all types.

GenericPropertyDescriptor<T>

A generic property to map properties that may be of different types. Not all methods are valid for all types.

GeoBoundingBoxQuery

GeoBoundingBoxQueryDescriptor<T>

GeoBounds

GeoBoundsAggregate

GeoBoundsAggregation

GeoBoundsAggregationDescriptor<T>

GeoCentroidAggregate

GeoCentroidAggregation

GeoCentroidAggregationDescriptor<T>

GeoCoordinate

Represents a Latitude/Longitude and optional Z value as a 2 or 3 dimensional point that gets serialized as new [] { lon, lat, [z] }

GeoDistanceAggregation

GeoDistanceAggregationDescriptor<T>

GeoDistanceQuery

GeoDistanceQueryDescriptor<T>

GeoDistanceSort

Allows you to sort based on a proximity to one or more GeoLocation

GeoDistanceSortDescriptor<T>

Allows you to sort based on a proximity to one or more GeoLocation

GeoHashGridAggregation

A multi-bucket aggregation that works on geo_point fields and groups points into buckets that represent cells in a grid. The resulting grid can be sparse and only contains cells that have matching data. Each cell is labeled using a geohash which is of user-definable precision.

GeoHashGridAggregationDescriptor<T>

GeoIpProcessor

The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the geoip field. The geoip processor can resolve both IPv4 and IPv6 addresses.

GeoIpProcessorDescriptor<T>

GeoLineAggregate

GeoLineAggregation

GeoLineAggregationDescriptor<T>

GeoLinePoint

GeoLineProperties

GeoLineSort

GeoLocation

Represents a Latitude/Longitude as a 2 dimensional point that gets serialized as { lat, lon }

GeoPointAttribute

GeoPointFielddata

GeoPointFielddataDescriptor

GeoPointProperty

Data type mapping to map a property as a geopoint

GeoPointPropertyDescriptor<T>

Data type mapping to map a property as a geopoint

GeoPolygonQuery

GeoPolygonQueryDescriptor<T>

GeoShapeAttribute

Maps a property as a geo_shape field

GeoShapeBase

Base type for geo shapes

GeoShapeDescriptor

Descriptor for building a IGeoShape

GeoShapeProperty

Maps a property as a geo_shape field

GeoShapePropertyDescriptor<T>

Maps a property as a geo_shape field

GeoShapeQuery

GeoShapeQueryDescriptor<T>

GeoSuggestContext

GeoSuggestContextDescriptor<T>

GeoTileGridAggregation

GeoTileGridAggregationDescriptor<T>

GeoTileGridCompositeAggregationSource

A values source that is equivalent to a simple Geo aggregation.

GeoTileGridCompositeAggregationSourceDescriptor<T>

A values source that is equivalent to a simple Geo aggregation.

GeoWKTException

An exception when handling shapes in Well-Known Text (WKT) format

GeoWKTReader

Reads Well-Known Text (WKT) into IGeoShape types

GeoWKTWriter

Writes IGeoShape types to Well-Known Text (WKT)

GeometryCollection

A geo shape representing a collection of IGeoShape geometries

GetAliasDescriptor

Descriptor for GetAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/

GetAliasRequest

Request for GetAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/

GetAliasResponse

GetAllPitsDescriptor

Descriptor for GetAllPits

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

GetAllPitsRequest

Request for GetAllPits

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

GetAllPitsResponse

GetComponentTemplateDescriptor

Descriptor for GetComponentTemplate

https://opensearch.org/docs/latest

GetComponentTemplateRequest

Request for GetComponentTemplate

https://opensearch.org/docs/latest

GetComponentTemplateResponse

GetComposableIndexTemplateDescriptor

Descriptor for GetComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

GetComposableIndexTemplateRequest

Request for GetComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

GetComposableIndexTemplateResponse

GetDescriptor<TDocument>

Descriptor for Get

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

GetFieldMappingDescriptor<TDocument>

Descriptor for GetFieldMapping

https://opensearch.org/docs/latest/field-types/index/

GetFieldMappingRequest

Request for GetFieldMapping

https://opensearch.org/docs/latest/field-types/index/

GetFieldMappingResponse

GetIndexDescriptor

Descriptor for Get

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/

GetIndexRequest

Request for Get

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/

GetIndexResponse

GetIndexSettingsDescriptor

Descriptor for GetSettings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

GetIndexSettingsRequest

Request for GetSettings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

GetIndexSettingsResponse

GetIndexTemplateDescriptor

Descriptor for GetTemplate

https://opensearch.org/docs/latest

GetIndexTemplateRequest

Request for GetTemplate

https://opensearch.org/docs/latest

GetIndexTemplateResponse

GetManyExtensions

Provides GetMany extensions that make it easier to get many documents given a list of ids

GetMappingDescriptor<TDocument>

Descriptor for GetMapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

GetMappingRequest

Request for GetMapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

GetMappingResponse

GetMappingResponseExtensions

GetPipelineDescriptor

Descriptor for GetPipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/

GetPipelineRequest

Request for GetPipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/

GetPipelineResponse

GetRepositoryDescriptor

Descriptor for GetRepository

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

GetRepositoryRequest

Request for GetRepository

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

GetRepositoryResponse

GetRequest

Request for Get

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

GetRequest<TDocument>

GetResponse<TDocument>

GetScriptDescriptor

Descriptor for GetScript

https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/

GetScriptRequest

Request for GetScript

https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/

GetScriptResponse

GetSnapshotDescriptor

Descriptor for Get

https://opensearch.org/docs/latest

GetSnapshotRequest

Request for Get

https://opensearch.org/docs/latest

GetSnapshotResponse

GetStats

GetTaskDescriptor

Descriptor for GetTask

https://opensearch.org/docs/latest/api-reference/tasks/

GetTaskRequest

Request for GetTask

https://opensearch.org/docs/latest/api-reference/tasks/

GetTaskResponse

GlobalAggregation

GlobalAggregationDescriptor<T>

GoogleNormalizedDistanceHeuristic

GoogleNormalizedDistanceHeuristicDescriptor

GrokProcessor

GrokProcessorDescriptor<T>

GrokProcessorPatternsDescriptor

Descriptor for GrokProcessorPatterns

https://opensearch.org/docs/latest

GrokProcessorPatternsRequest

Request for GrokProcessorPatterns

https://opensearch.org/docs/latest

GrokProcessorPatternsResponse

GsubProcessor

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

GsubProcessorDescriptor<T>

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

HDRHistogramMethod

HDRHistogramMethodDescriptor

HardBounds<T>

HasChildQuery

HasChildQueryDescriptor<T>

HasParentQuery

HasParentQueryDescriptor<T>

HdfsRepository

HdfsRepositoryDescriptor

A snapshot repository that stores snapshot data within a Hadoop HDFS filesystem

Requires the repository-hdfs plugin to be installed on the cluster

HdfsRepositorySettings

HdfsRepositorySettingsDescriptor

Snapshot repository settings for IHdfsRepository

Highlight

HighlightDescriptor<T>

HighlightField

HighlightFieldDescriptor<T>

HistogramAggregation

HistogramAggregationDescriptor<T>

HistogramCompositeAggregationSource

A value source that can be applied on numeric values to build fixed size interval over the values. The interval parameter defines how the numeric values should be transformed. For instance an interval set to 5 will translate any numeric values to its closest interval, a value of 101 would be translated to 100 which is the key for the interval between 100 and 105.

HistogramCompositeAggregationSourceDescriptor<T>

HistogramOrder

Hit<TDocument>

HitsMetadata<T>

HoltLinearModel

HoltLinearModelDescriptor

HoltWintersModel

HoltWintersModelDescriptor

HotThreadInformation

HtmlStripCharFilter

HtmlStripCharFilterDescriptor

HttpDeleteDescriptor

HttpDeleteRequest

HttpGetDescriptor

HttpGetRequest

HttpHeadDescriptor

HttpHeadRequest

HttpPatchDescriptor

HttpPatchRequest

HttpPostDescriptor

HttpPostRequest

HttpPutDescriptor

HttpPutRequest

HttpStats

HunspellTokenFilter

HunspellTokenFilterDescriptor

HyphenationDecompounderTokenFilter

HyphenationDecompounderTokenFilterDescriptor

IBSimilarity

IBSimilarityDescriptor

Information based model similarity. The algorithm is based on the concept that the information content in any symbolic distribution sequence is primarily determined by the repetitive usage of its basic elements. For written texts this challenge would correspond to comparing the writing styles of different authors.

IcuAnalyzer

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IcuAnalyzerDescriptor

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IcuCollationTokenFilter

Collations are used for sorting documents in a language-specific word order. The icu_collation token filter is available to all indices and defaults to using the DUCET collation, which is a best-effort attempt at language-neutral sorting. Part of the analysis-icu plugin:

IcuCollationTokenFilterDescriptor

IcuFoldingTokenFilter

IcuFoldingTokenFilterDescriptor

IcuNormalizationCharFilter

IcuNormalizationCharFilterDescriptor

IcuNormalizationTokenFilter

IcuNormalizationTokenFilterDescriptor

IcuTokenizer

IcuTokenizerDescriptor

IcuTransformTokenFilter

IcuTransformTokenFilterDescriptor

Id

IdResolver

Ids

IdsQuery

IdsQueryDescriptor

IgnoreAttribute

IgnoreClrPropertyMapping<TDocument>

ImportDanglingIndexDescriptor

Descriptor for ImportDanglingIndex

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

ImportDanglingIndexRequest

Request for ImportDanglingIndex

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

ImportDanglingIndexResponse

IncludeExclude

IndexAliases

IndexBlock

Block type for an index.

IndexDescriptor<TDocument>

Descriptor for Index

https://opensearch.org/docs/latest/api-reference/document-apis/index-document/

IndexExistsDescriptor

Descriptor for Exists

https://opensearch.org/docs/latest/api-reference/index-apis/exists/

IndexExistsRequest

Request for Exists

https://opensearch.org/docs/latest/api-reference/index-apis/exists/

IndexHealthStats

IndexManyExtensions

Provides GetMany extensions that make it easier to get many documents given a list of ids

IndexMappings

IndexMetrics

IndexName

IndexNameExtensions

IndexNameResolver

IndexRequest<TDocument>

Request for Index

https://opensearch.org/docs/latest/api-reference/document-apis/index-document/

IndexResponse

IndexSettings

The settings for an index

IndexSettingsDescriptor

The settings for an index

IndexShardStats

IndexSortSettings

IndexState

IndexStats

IndexStatsBase

IndexTemplateExistsDescriptor

Descriptor for TemplateExists

https://opensearch.org/docs/latest

IndexTemplateExistsRequest

Request for TemplateExists

https://opensearch.org/docs/latest

IndexUuid

IndexedScript

IndexedScriptDescriptor

IndexingBufferSettings

The indexing buffer is used to store newly indexed documents. When it fills up, the documents in the buffer are written to a segment on disk. It is divided between all shards on the node.

The following settings are static and must be configured on every data node in the cluster

IndexingLoad

IndexingPressureMemoryStats

IndexingPressureStats

IndexingStats

Indices

Indices.AllIndicesMarker

Indices.ManyIndices

IndicesExtensions

IndicesModuleSettings

IndicesModuleSettingsDescriptor

IndicesPointingToAliasExtensions

Implements several handy alias extensions.

IndicesRecoverySettings

IndicesRecoverySettingsDescriptor

IndicesResponseBase

IndicesStats

IndicesStatsDescriptor

Descriptor for Stats

https://opensearch.org/docs/latest

IndicesStatsDictionary

IndicesStatsRequest

Request for Stats

https://opensearch.org/docs/latest

IndicesStatsResponse

Infer

InferenceFieldMap

InferenceFieldMapDescriptor<TDocument>

InferenceProcessorBase

InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>

Inferrer

Ingest

IngestStats

InlineGet<TDocument>

InlineScript

InlineScriptDescriptor

InnerHits

InnerHitsDescriptor<T>

InnerHitsMetadata

InnerHitsResult

IntegerRange

IntegerRangeAttribute

IntegerRangeProperty

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IntegerRangePropertyDescriptor<T>

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IntervalsAllOf

A rule that returns matches that span a combination of other rules.

IntervalsAllOfDescriptor

A rule that returns matches that span a combination of other rules.

IntervalsAnyOf

A rule that emits intervals produced by any of its sub-rules.

IntervalsAnyOfDescriptor

A rule that emits intervals produced by any of its sub-rules.

IntervalsBase

Base type for an IIntervals implementation

IntervalsContainer

Container for an IIntervalsQuery rule

IntervalsDescriptor

Descriptor to construct an IIntervalsQuery rule

IntervalsDescriptorBase<TDescriptor, TInterface>

Base type for descriptors that define IIntervals

IntervalsFilter

IntervalsFilterDescriptor

Filters intervals produced by any rules by their relation to the intervals produced by another rule

IntervalsFuzzy

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IntervalsFuzzyDescriptor

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IntervalsListDescriptor

Constructs a collection of IntervalsContainer

IntervalsMatch

Matches the analyzed text

IntervalsMatchDescriptor

Matches the analyzed text

IntervalsNoFilterBase

Base type for an IIntervalsNoFilter implementation

IntervalsPrefix

Matches terms that start with a specified set of characters. This prefix can expand to match at most 128 terms. If the prefix matches more than 128 terms, OpenSearch returns an error. You can use the index-prefixes option in the field mapping to avoid this limit.

IntervalsPrefixDescriptor

IntervalsQuery

A query that allows fine-grained control over the order and proximity of matching terms. Matching rules are constructed from a small set of definitions, and the rules are then applied to terms from a particular field. The definitions produce sequences of minimal intervals that span terms in a body of text. These intervals can be further combined and filtered by parent sources.

IntervalsQueryDescriptor<T>

IntervalsWildcard

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IntervalsWildcardDescriptor

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IpAddressRange

IpAttribute

IpProperty

An ip field can index/store either IPv4 or IPv6 addresses.

IpPropertyDescriptor<T>

An ip field can index/store either IPv4 or IPv6 addresses.

IpRangeAggregation

IpRangeAggregationDescriptor<T>

IpRangeAggregationRange

IpRangeAggregationRangeDescriptor

IpRangeAttribute

IpRangeBucket

A bucket for an IpRangeAggregation

IpRangeProperty

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IpRangePropertyDescriptor<T>

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IsADictionaryBase<TKey, TValue>

IsADictionaryDescriptorBase<TDescriptor, TInterface, TKey, TValue>

IsAReadOnlyDictionaryBase<TKey, TValue>

JoinAttribute

JoinField

The field on which a parent-child relationship is joined

JoinField.Child

JoinField.Parent

JoinProcessor

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

JoinProcessorDescriptor<T>

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

JoinProperty

The join datatype is a special field that creates parent/child relation within documents of the same index.

JoinPropertyDescriptor<T>

The join datatype is a special field that creates parent/child relation within documents of the same index.

JsonProcessor

Converts a JSON string into a structured JSON object.

JsonProcessorDescriptor<T>

Converts a JSON string into a structured JSON object.

KStemTokenFilter

KStemTokenFilterDescriptor

KeepTypesTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

KeepTypesTokenFilterDescriptor

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

KeepWordsTokenFilter

KeepWordsTokenFilterDescriptor

KeyValueProcessor

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

KeyValueProcessorDescriptor<T>

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

KeyedBucket<TKey>

KeyedProcessorStats

KeyedValueAggregate

KeywordAnalyzer

KeywordAnalyzerDescriptor

KeywordAttribute

KeywordMarkerTokenFilter

Protects words from being modified by stemmers. Must be placed before any stemming filters.

KeywordMarkerTokenFilterDescriptor

Protects words from being modified by stemmers. Must be placed before any stemming filters.

KeywordProperty

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

KeywordPropertyDescriptor<T>

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

KeywordTokenizer

KeywordTokenizerDescriptor

KnnMethod

KnnMethodDescriptor

KnnMethodParameters

KnnMethodParametersDescriptor

KnnQuery

KnnQueryDescriptor<T>

KnnVectorProperty

KnnVectorPropertyDescriptor<T>

KuromojiAnalyzer

KuromojiAnalyzerDescriptor

KuromojiIterationMarkCharFilter

KuromojiIterationMarkCharFilterDescriptor

KuromojiPartOfSpeechTokenFilter

KuromojiPartOfSpeechTokenFilterDescriptor

KuromojiReadingFormTokenFilter

KuromojiReadingFormTokenFilterDescriptor

KuromojiStemmerTokenFilter

KuromojiStemmerTokenFilterDescriptor

KuromojiTokenizer

KuromojiTokenizerDescriptor

LMDirichletSimilarity

LMDirichletSimilarityDescriptor

LMJelinekMercerSimilarity

LMJelinekMercerSimilarityDescriptor

LanguageAnalyzer

LanguageAnalyzerDescriptor

LaplaceSmoothingModel

LaplaceSmoothingModelDescriptor

LatLon

LazyDocument

LengthTokenFilter

LengthTokenFilterDescriptor

LetterTokenizer

LetterTokenizerDescriptor

Like

LikeDescriptor<T>

LikeDocumentBase

LikeDocumentDescriptor<TDocument>

An indexed or artificial document with which to find likeness

LikeDocument<TDocument>

An indexed or artificial document with which to find likeness

LimitTokenCountTokenFilter

LimitTokenCountTokenFilterDescriptor

LineStringGeoShape

LinearDateDecayFunction

LinearDecayFunction

LinearDecayFunctionBase<TOrigin, TScale>

LinearDecayFunctionDescriptor<TOrigin, TScale, T>

LinearGeoDecayFunction

LinearInterpolationSmoothingModel

LinearInterpolationSmoothingModelDescriptor

LinearModel

LinearModelDescriptor

ListDanglingIndicesDescriptor

Descriptor for List

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

ListDanglingIndicesRequest

Request for List

https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/

ListDanglingIndicesResponse

ListTasksDescriptor

Descriptor for List

https://opensearch.org/docs/latest/api-reference/tasks/

ListTasksRequest

Request for List

https://opensearch.org/docs/latest/api-reference/tasks/

ListTasksResponse

LongId

LongRange

LongRangeAttribute

LongRangeProperty

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

LongRangePropertyDescriptor<T>

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

LongRangeQuery

LongRangeQueryDescriptor<T>

LowercaseProcessor

Converts a string to its lowercase equivalent.

LowercaseProcessorDescriptor<T>

Converts a string to its lowercase equivalent.

LowercaseTokenFilter

LowercaseTokenFilterDescriptor

LowercaseTokenizer

LowercaseTokenizerDescriptor

LuceneExpressionScript

MappingCharFilter

MappingCharFilterDescriptor

MappingWalker

MappingsDescriptor

MatchAllQuery

MatchAllQueryDescriptor

MatchBoolPrefixQuery

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

MatchBoolPrefixQueryDescriptor<T>

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

MatchNoneQuery

MatchNoneQueryDescriptor

MatchPhrasePrefixQuery

MatchPhrasePrefixQueryDescriptor<T>

MatchPhraseQuery

MatchPhraseQueryDescriptor<T>

MatchQuery

A match query for a single field

MatchQueryDescriptor<T>

A match query for a single field

MatrixAggregateBase

MatrixAggregationBase

MatrixAggregationDescriptorBase<TMatrixAggregation, TMatrixAggregationInterface, T>

MatrixStatsAggregate

MatrixStatsAggregation

MatrixStatsAggregationDescriptor<T>

MatrixStatsField

MaxAggregation

MaxAggregationDescriptor<T>

MaxBucketAggregation

MaxBucketAggregationDescriptor

MedianAbsoluteDeviationAggregation

This single-value aggregation approximates the median absolute deviation of its search results.

Median absolute deviation is a measure of variability. It is a robust statistic, meaning that it is useful for describing data that may have outliers, or may not be normally distributed. For such data it can be more descriptive than standard deviation.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

MedianAbsoluteDeviationAggregationDescriptor<T>

This single-value aggregation approximates the median absolute deviation of its search results.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

MemberInfoResolver

Resolves member infos in an expression, instance may NOT be shared.

MergePolicySettings

MergePolicySettingsDescriptor

MergeSchedulerSettings

MergeSchedulerSettingsDescriptor

MergeSettings

MergeSettingsDescriptor

MergesStats

MetricAggregateBase

MetricAggregationBase

MetricAggregationDescriptorBase<TMetricAggregation, TMetricAggregationInterface, T>

Metrics

MinAggregation

MinAggregationDescriptor<T>

MinBucketAggregation

MinBucketAggregationDescriptor

MinimumShouldMatch

MissingAggregation

MissingAggregationDescriptor<T>

MoreLikeThisQuery

MoreLikeThisQueryDescriptor<T>

MoveClusterRerouteCommand

MoveClusterRerouteCommandDescriptor

MovingAverageAggregation

MovingAverageAggregationDescriptor

MovingAverageModelDescriptor

MovingFunctionAggregation

MovingFunctionAggregationDescriptor

MultiBucketAggregate<TBucket>

Aggregation response for a bucket aggregation

MultiBucketsPath

MultiBucketsPathDescriptor

MultiGetDescriptor

Descriptor for MultiGet

https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/

MultiGetHit<TDocument>

MultiGetOperationDescriptor<T>

MultiGetOperation<T>

MultiGetRequest

Request for MultiGet

https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/

MultiGetResponse

MultiLineStringGeoShape

MultiMatchQuery

A match query across multiple fields.

MultiMatchQueryDescriptor<T>

A match query across multiple fields.

MultiPointGeoShape

MultiPolygonGeoShape

MultiSearchDescriptor

Descriptor for MultiSearch

https://opensearch.org/docs/latest/api-reference/multi-search/

MultiSearchRequest

Request for MultiSearch

https://opensearch.org/docs/latest/api-reference/multi-search/

MultiSearchResponse

MultiSearchTemplateDescriptor

Descriptor for MultiSearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

MultiSearchTemplateRequest

Request for MultiSearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

MultiTermQueryRewrite

Controls how a multi term query such as a wildcard or prefix query, is rewritten.

MultiTermVectorOperationDescriptor<T>

An operation to define the calculation of term vectors when using Multi termvectors API

MultiTermVectorOperation<T>

MultiTermVectorsDescriptor

A Multi termvectors API request

MultiTermVectorsRequest

A Multi termvectors API request

MultiTermVectorsResponse

MultiTermsAggregate<TKey>

MultiTermsAggregation

MultiTermsAggregationDescriptor<T>

MultiTermsBucket<TKey>

MultiplexerTokenFilter

MultiplexerTokenFilterDescriptor

A token filter of type multiplexer will emit multiple tokens at the same position, each version of the token having been run through a different filter. Identical output tokens at the same position will be removed.

Murmur3HashAttribute

Murmur3HashProperty

Murmur3HashPropertyDescriptor<T>

MustacheScript

MutualInformationHeuristic

MutualInformationHeuristicDescriptor

NGramTokenFilter

NGramTokenFilterDescriptor

NGramTokenizer

NGramTokenizerDescriptor

Name

NamedComponentTemplate

NamedComposableIndexTemplate

NamedFiltersContainer

NamedFiltersContainerDescriptor<T>

Names

NamespacedClientProxy

NestedAggregation

NestedAggregationDescriptor<T>

NestedAttribute

NestedIdentity

NestedProperty

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

NestedPropertyDescriptor<TParent, TChild>

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

NestedQuery

NestedQueryDescriptor<T>

NestedSort

NestedSortDescriptor<T>

Sort on a field inside one or more nested objects.

NetworkCommunityIdProcessor

NetworkCommunityIdProcessorDescriptor<T>

NetworkDirectionProcessor

NetworkDirectionProcessorDescriptor<T>

NeuralQuery

NeuralQueryDescriptor<T>

NodeAllocationExplanation

NodeIds

NodeInfo

NodeInfoHttp

NodeInfoJvmMemory

NodeInfoMemory

NodeInfoNetwork

NodeInfoNetworkInterface

NodeInfoOSCPU

NodeInfoTransport

NodeIngestStats

NodeJvmInfo

NodeJvmStats

NodeJvmStats.GarbageCollectionGenerationStats

NodeJvmStats.GarbageCollectionStats

NodeJvmStats.JvmClassesStats

NodeJvmStats.MemoryStats

NodeJvmStats.MemoryStats.JvmPool

NodeJvmStats.NodeBufferPool

NodeJvmStats.ThreadStats

NodeOperatingSystemInfo

NodePackagingType

NodeProcessInfo

NodeStatistics

NodeStats

NodeThreadPoolInfo

NodeUsageInformation

NodesHotThreadsDescriptor

Descriptor for HotThreads

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

NodesHotThreadsRequest

Request for HotThreads

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

NodesHotThreadsResponse

NodesInfoDescriptor

Descriptor for Info

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

NodesInfoRequest

Request for Info

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

NodesInfoResponse

NodesResponseBase

NodesStatsDescriptor

Descriptor for Stats

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

NodesStatsRequest

Request for Stats

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

NodesStatsResponse

NodesUsageDescriptor

Descriptor for Usage

https://opensearch.org/docs/latest

NodesUsageRequest

Request for Usage

https://opensearch.org/docs/latest

NodesUsageResponse

NoopMappingVisitor

NoopPropertyVisitor

NoriAnalyzer

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

NoriAnalyzerDescriptor

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

NoriPartOfSpeechTokenFilter

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

NoriPartOfSpeechTokenFilterDescriptor

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

NoriTokenizer

Tokenizer that ships with the analysis-nori plugin

NoriTokenizerDescriptor

Tokenizer that ships with the analysis-nori plugin

NormalizerBase

NormalizerDescriptorBase<TNormalizer, TNormalizerInterface>

Normalizers

NormalizersDescriptor

NumberAttribute

Maps a property as a number type. If no type is specified, the default type is float (single precision floating point).

NumberProperty

NumberPropertyDescriptorBase<TDescriptor, TInterface, T>

NumberPropertyDescriptor<T>

NumericFielddata

NumericFielddataDescriptor

NumericRangeQuery

NumericRangeQueryDescriptor<T>

ObjectAttribute

ObjectProperty

A object datatype mapping for an inner object

ObjectPropertyDescriptorBase<TDescriptor, TInterface, TParent, TChild>

ObjectTypeDescriptor<TParent, TChild>

ObsoleteMappingsBase

ObsoleteMappingsBase.Mappings

Types are gone from OpenSearch, this class solely exist to help you move your complex mappings over to the new way of writing the mappings. Use TypeMapping directly instead.

This class won't receive updates, please be advised to move over if you need to utilize
new features in the future.

OpenIndexDescriptor

Descriptor for Open

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/

OpenIndexRequest

Request for Open

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/

OpenIndexResponse

OpenSearchClient

OpenSearchClient is a strongly typed client which exposes fully mapped OpenSearch endpoints

OpenSearchCorePropertyAttributeBase

OpenSearchDocValuesPropertyAttributeBase

OpenSearchPropertyAttributeBase

OpenSearchTypeAttribute

Applied to a CLR type to override the name of a CLR type and the property from which an _id is inferred when serializing an instance of the type.

OpenSearchVersionInfo

OperatingSystemMemoryInfo

OperatingSystemStats

OperatingSystemStats.CPUStats

OperatingSystemStats.CPUStats.LoadAverageStats

OperatingSystemStats.ExtendedMemoryStats

OperatingSystemStats.MemoryStats

PainlessContextSetup

Sets up contextual scope for the painless script the execute under.

PainlessContextSetupDescriptor

Sets up contextual scope for the painless script the execute under.

PainlessScript

ParentAggregation

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

ParentAggregationDescriptor<T, TParent>

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

ParentIdQuery

ParentIdQueryDescriptor<T>

PathHierarchyTokenizer

PathHierarchyTokenizerDescriptor

PatternAnalyzer

PatternAnalyzerDescriptor

PatternCaptureTokenFilter

PatternCaptureTokenFilterDescriptor

PatternReplaceCharFilter

PatternReplaceCharFilterDescriptor

PatternReplaceTokenFilter

PatternReplaceTokenFilterDescriptor

PatternTokenizer

PatternTokenizerDescriptor

PendingTask

PerFieldAnalyzer

PerFieldAnalyzerDescriptor<T>

PerFieldAnalyzer<T>

PercentageScoreHeuristic

PercentageScoreHeuristicDescriptor

PercentileItem

PercentileRanksAggregation

PercentileRanksAggregationDescriptor<T>

PercentilesAggregate

PercentilesAggregation

PercentilesAggregationDescriptor<T>

PercentilesBucketAggregation

PercentilesBucketAggregationDescriptor

PercentilesMethodDescriptor

PercolateQuery

The percolate query can be used to match queries stored in an index

PercolateQueryDescriptor<T>

The percolate query can be used to match queries stored in an index

PercolatorAttribute

PercolatorProperty

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

PercolatorPropertyDescriptor<T>

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

PhoneticTokenFilter

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

PhoneticTokenFilterDescriptor

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

PhraseSuggestCollate

PhraseSuggestCollateDescriptor<T>

Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.

PhraseSuggestCollateQuery

PhraseSuggestCollateQueryDescriptor

A query to run for a phrase suggester collate

PhraseSuggestHighlight

PhraseSuggestHighlightDescriptor

Highlighting for IPhraseSuggester

PhraseSuggester

The phrase suggester adds additional logic on top of the term suggester to select entire corrected phrases instead of individual tokens weighted based on ngram-language models. In practice this suggester will be able to make better decisions about which tokens to pick based on co-occurrence and frequencies.

PhraseSuggesterDescriptor<T>

PingDescriptor

Descriptor for Ping

https://opensearch.org/docs/latest

PingRequest

Request for Ping

https://opensearch.org/docs/latest

PingResponse

Pipeline

PipelineAggregationBase

PipelineAggregationDescriptorBase<TPipelineAggregation, TPipelineAggregationInterface, TBucketsPath>

PipelineDescriptor

PipelineProcessor

Executes another pipeline.

PipelineProcessorDescriptor

Executes another pipeline.

PipelineSimulation

PitDetail

PlainRequestBase<TParameters>

PluginStats

PointGeoShape

PointInTime

PointInTimeDescriptor

PolygonGeoShape

PorterStemTokenFilter

PorterStemTokenFilterDescriptor

PostVotingConfigExclusionsDescriptor

Descriptor for PostVotingConfigExclusions

https://opensearch.org/docs/latest

PostVotingConfigExclusionsRequest

Request for PostVotingConfigExclusions

https://opensearch.org/docs/latest

PostVotingConfigExclusionsResponse

PredicateTokenFilter

PredicateTokenFilterDescriptor

The predicate_token_filter token filter takes a predicate script, and removes tokens that do not match the predicate.

PrefixQuery

PrefixQueryDescriptor<T>

PreventMappingMultipleTypesDescriptor

The common pattern in OpenSearch.Client is that you can call fluent methods multiple types overriding what was previously set. This type prevents a user to call Map() multiple times with different types making it crystal clear not only can you no longer have multiple types in an index MappingsDescriptor makes the overloads that take type obsolete as well. Both PreventMappingMultipleTypesDescriptor and MappingsDescriptor are obsolete. Please move to

ProcessStats

ProcessStats.CPUStats

ProcessStats.MemoryStats

ProcessorBase

Ingest pipelines are composed of one or more processors

ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>

Ingest pipelines are composed of one or more processors

ProcessorStats

ProcessorsDescriptor

ProducerConsumerBackPressure

Simple back pressure implementation that makes sure the minimum max concurrency between producer and consumer is not amplified by the greedier of the two by more then the backPressureFactor which defaults to 4

Profile

Properties

PropertiesDescriptor<T>

Properties<T>

PropertyBase

A mapping for a property type to a document field in OpenSearch

PropertyDescriptorBase<TDescriptor, TInterface, T>

A mapping for a property type to a document field in OpenSearch

PropertyMapping

PropertyMappingDescriptor<TDocument>

PropertyMappingProvider

PropertyName

PropertyNameAttribute

PropertyWalker

PutAliasDescriptor

Descriptor for PutAlias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

PutAliasRequest

A request to put an alias to one or more indices

PutAliasResponse

PutComponentTemplateDescriptor

Descriptor for PutComponentTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

PutComponentTemplateRequest

Request for PutComponentTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

PutComponentTemplateResponse

PutComposableIndexTemplateDescriptor

Descriptor for PutComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

PutComposableIndexTemplateRequest

Request for PutComposableTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

PutComposableIndexTemplateResponse

PutIndexTemplateDescriptor

Descriptor for PutTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

PutIndexTemplateRequest

Request for PutTemplate

https://opensearch.org/docs/latest/im-plugin/index-templates/

PutIndexTemplateResponse

PutMappingDescriptor<TDocument>

Descriptor for PutMapping

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/

PutMappingRequest

Request for PutMapping

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/

PutMappingRequest<TDocument>

PutMappingResponse

PutPipelineDescriptor

Descriptor for PutPipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/

PutPipelineRequest

Request for PutPipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/

PutPipelineResponse

PutScriptDescriptor

Descriptor for PutScript

https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/

PutScriptRequest

Request for PutScript

https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/

PutScriptResponse

QueriesCacheSettings

QueriesCacheSettingsDescriptor

QueriesSettings

QueriesSettingsDescriptor

QueryBase

QueryBreakdown

QueryCacheStats

QueryContainer

QueryContainerDescriptor<T>

QueryDescriptorBase<TDescriptor, TInterface>

QueryProfile

QueryStringQuery

A query that uses a query parser in order to parse its content

QueryStringQueryDescriptor<T>

A query that uses a query parser in order to parse its content

QueryVisitor

QueryWalker

Query<T>

RandomScoreFunction

RandomScoreFunctionDescriptor<T>

RangeAggregation

RangeAggregationDescriptor<T>

RangeBucket

RangePropertyAttributeBase

RangePropertyBase

RangePropertyDescriptorBase<TDescriptor, TInterface, T>

RankFeatureAttribute

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeatureLinearFunction

Gives a score equal to the indexed value of S, where S is the value of the rank feature field.

If a rank feature field is indexed with "positive_score_impact": true, its indexed value is equal to S and rounded to preserve only 9 significant bits for the precision.

If a rank feature field is indexed with "positive_score_impact": false, its indexed value is equal to 1/S and rounded to preserve only 9 significant bits for the precision.

RankFeatureLogarithmFunction

RankFeatureLogarithmFunctionDescriptor

Gives a score that is equal to log(scaling_factor + S) where S is the value of the rank feature and scaling_factor is a configurable scaling factor. Scores are unbounded. This function only supports rank features that have a positive score impact.

RankFeatureProperty

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeaturePropertyDescriptor<T>

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

RankFeatureQuery

RankFeatureQueryDescriptor<T>

RankFeatureSaturationFunction

RankFeatureSaturationFunctionDescriptor

Gives a score that is equal to S / (S + pivot) where S is the value of the rank feature and pivot is a configurable pivot value so that the result will be less than 0.5 if S is less than pivot and greater than 0.5 otherwise. Scores are always is (0, 1). If the rank feature has a negative score impact then the function will be computed as pivot / (S + pivot), which decreases when S increases.

RankFeatureSigmoidFunction

is an extension of saturation which adds a configurable exponent. Scores are computed as S^exp^ / (S^exp^ + pivot^exp^). Like for the saturation function, pivot is the value of S that gives a score of 0.5 and scores are in (0, 1).

exponent must be positive, but is typically in [0.5, 1]. A good value should be computed via training. If you don’t have the opportunity to do so, we recommend that you stick to the saturation function instead.

RankFeatureSigmoidFunctionDescriptor

RankFeaturesAttribute

A field that can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query. It is analogous to the IRankFeatureProperty datatype, but is better suited when the list of features is sparse so that it wouldn't be reasonable to add one field to the mappings for each of them.

RankFeaturesProperty

RankFeaturesPropertyDescriptor<T>

RareTermsAggregation

A multi-bucket value source based aggregation which finds "rare" terms — terms that are at the long-tail of the distribution and are not frequent. Conceptually, this is like a terms aggregation that is sorted by _count ascending.

RareTermsAggregationDescriptor<T>

RareTermsBucket<TKey>

RawQuery

RawQueryDescriptor

ReadOnlyUrlRepository

ReadOnlyUrlRepositoryDescriptor

A snapshot repository that can be used as an alternative read-only way to access data created by the IFileSystemRepository. The URL specified in the url parameter should point to the root of the shared filesystem repository.

ReadOnlyUrlRepositorySettings

ReadOnlyUrlRepositorySettingsDescriptor

Snapshot repository settings for IReadOnlyUrlRepository

RecoveryStats

RefreshDescriptor

Descriptor for Refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

RefreshRequest

Request for Refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

RefreshResponse

RefreshStats

RegexpQuery

Queries documents that contain terms matching a regular expression.

RegexpQueryDescriptor<T>

Queries documents that contain terms matching a regular expression.

ReindexDescriptor<TSource, TTarget>

ReindexDestination

ReindexDestinationDescriptor

Configures the destination for a reindex API request

ReindexNode

ReindexObservable<TSource>

ReindexObservable<TSource, TTarget>

ReindexObserver

ReindexOnServerDescriptor

Descriptor for ReindexOnServer

https://opensearch.org/docs/latest/im-plugin/reindex-data/

ReindexOnServerRequest

A request to Reindex API

ReindexOnServerResponse

ReindexRequest<TSource>

ReindexRequest<TSource, TTarget>

ReindexRethrottleDescriptor

Descriptor for ReindexRethrottle

https://opensearch.org/docs/latest

ReindexRethrottleRequest

Request for ReindexRethrottle

https://opensearch.org/docs/latest

ReindexRethrottleResponse

ReindexRouting

ReindexSource

ReindexSourceDescriptor

Configures the source for a reindex API request

ReindexStatus

ReindexTask

RelationName

RelationNameResolver

Relations

RelationsDescriptor

ReloadSecureSettingsDescriptor

Descriptor for ReloadSecureSettings

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

ReloadSecureSettingsRequest

Request for ReloadSecureSettings

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

ReloadSecureSettingsResponse

RemoteClusterConfiguration

Simplifies the creation of remote cluster configuration, can be combined with a dictionary using the overloaded + operator

RemoteInfo

RemoteInfoDescriptor

Descriptor for RemoteInfo

https://opensearch.org/docs/latest/api-reference/remote-info/

RemoteInfoRequest

Request for RemoteInfo

https://opensearch.org/docs/latest/api-reference/remote-info/

RemoteInfoResponse

RemoteSource

RemoteSourceDescriptor

RemoveDuplicatesTokenFilter

A token filter that drops identical tokens at the same position

RemoveDuplicatesTokenFilterDescriptor

A token filter that drops identical tokens at the same position

RemoveProcessor

Removes existing fields. If one field doesn't exist, an exception will be thrown.

RemoveProcessorDescriptor<T>

Removes existing fields. If one field doesn't exist, an exception will be thrown.

RenameClrPropertyMapping<TDocument>

RenameProcessor

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

RenameProcessorDescriptor<T>

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

RenderSearchTemplateDescriptor

Descriptor for RenderSearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

RenderSearchTemplateRequest

Request for RenderSearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

RenderSearchTemplateResponse

RequestBase<TParameters>

RequestCacheStats

RequestDescriptorBase<TDescriptor, TParameters, TInterface>

Base class for all Request descriptor types

Rescore

RescoreDescriptor<T>

RescoreQuery

RescoreQueryDescriptor<T>

RescoringDescriptor<T>

ResolvableDictionaryProxy<TKey, TValue>

ResolveIndexDescriptor

A request to the resolve index API

ResolveIndexRequest

A request to the resolve index API

ResolveIndexResponse

ResolvedAlias

ResolvedIndex

ResponseBase

RestoreDescriptor

Restores a snapshot

RestoreErrorEventArgs

RestoreRequest

Restores a snapshot

RestoreResponse

RestoreStatusHumbleObject

Retries

ReverseNestedAggregation

ReverseNestedAggregationDescriptor<T>

ReverseTokenFilter

ReverseTokenFilterDescriptor

RolloverConditions

RolloverConditionsDescriptor

Conditions that must be satisfied for a new index to be created with the rollover index API

RolloverIndexDescriptor

Descriptor for Rollover

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

RolloverIndexRequest

Request for Rollover

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

RolloverIndexResponse

RootNodeInfoDescriptor

Descriptor for RootNodeInfo

https://opensearch.org/docs/latest

RootNodeInfoRequest

Request for RootNodeInfo

https://opensearch.org/docs/latest

RootNodeInfoResponse

RouteValues

Routing

RoutingField

RoutingFieldDescriptor<T>

RoutingResolver

RuntimeField

RuntimeFieldDescriptor

RuntimeFields

RuntimeFieldsDescriptor<TDocument>

S3Repository

S3RepositoryDescriptor

A snapshot repository that stores snapshots in an Amazon S3 bucket

Requires the repository-s3 plugin to be installed on the cluster

S3RepositorySettings

S3RepositorySettingsDescriptor

Snapshot repository settings for IS3Repository

SamplerAggregation

SamplerAggregationDescriptor<T>

ScoreFunctionsDescriptor<T>

ScriptBase

A script to execute to provide custom computation

ScriptCacheStats

ScriptDescriptor

A script to execute to provide custom computation

ScriptDescriptorBase<TDescriptor, TInterface>

A script to execute to provide custom computation

ScriptField

ScriptFieldDescriptor

ScriptFields

ScriptFieldsDescriptor

ScriptProcessor

Allows inline, stored, and file scripts to be executed within ingest pipelines.

ScriptProcessorDescriptor

Allows inline, stored, and file scripts to be executed within ingest pipelines.

ScriptQuery

A query allowing to define a script to execute as a query

ScriptQueryDescriptor<T>

A query allowing to define a script to execute as a query

ScriptScoreFunction

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

ScriptScoreFunctionDescriptor<T>

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

ScriptScoreQuery

A query allowing you to modify the score of documents that are retrieved by a query. This can be useful if, for example, a score function is computationally expensive and it is sufficient to compute the score on a filtered set of documents.

ScriptScoreQueryDescriptor<T>

ScriptSort

ScriptSortDescriptor<T>

ScriptStats

ScriptedHeuristic

ScriptedHeuristicDescriptor

ScriptedMetricAggregate

ScriptedMetricAggregation

ScriptedMetricAggregationDescriptor<T>

ScriptedSimilarity

ScriptedSimilarityDescriptor

A similarity that allows a script to be used in order to specify how scores should be computed.

ScrollAllDescriptor<T>

ScrollAllObservable<T>

ScrollAllObserver<T>

ScrollAllRequest

ScrollAllResponse<T>

A response returned for each scroll in ScrollAll()

ScrollDescriptor<TInferDocument>

Descriptor for Scroll

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

ScrollRequest

Request for Scroll

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

SearchAsYouTypeAttribute

SearchAsYouTypeProperty

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

It creates a series of subfields that are analyzed to index terms that can be efficiently matched by a query that partially matches the entire indexed text value. Both prefix completion (i.e matching terms starting at the beginning of the input) and infix completion (i.e. matching terms at any position within the input) are supported.

SearchAsYouTypePropertyDescriptor<T>

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

SearchDescriptor<TInferDocument>

A descriptor which describes a search operation for _search and _msearch

SearchNode

SearchProfile

SearchRequest

Request for Search

https://opensearch.org/docs/latest/api-reference/search/

SearchRequest<TInferDocument>

SearchResponse<TDocument>

SearchShard

SearchShardsDescriptor<TDocument>

A descriptor which describes a search operation for _search_shards

SearchShardsRequest

Request for SearchShards

https://opensearch.org/docs/latest

SearchShardsRequest<TDocument>

SearchShardsResponse

SearchStats

SearchTemplateDescriptor<TDocument>

Descriptor for SearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

SearchTemplateRequest

Request for SearchTemplate

https://opensearch.org/docs/latest/search-plugins/search-template/

SearchTemplateRequest<T>

SegmentsStats

OpenSearch 2.0 has Lucene upgraded up to version 9.0 which doesn't provide memory info for segments. All fields except count might be zeroed.

SelectorBase

SerialDifferencingAggregation

SerialDifferencingAggregationDescriptor

SetProcessor

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

SetProcessorDescriptor<T>

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

ShapeQuery

ShapeQueryDescriptor<T>

ShardAllocationExplanation

ShardAllocationSettings

ShardAllocationSettingsDescriptor

ShardBalancingHeuristicsSettings

ShardBalancingHeuristicsSettingsDescriptor

ShardCommitStats

ShardHealthStats

ShardPath

ShardProfile

ShardRebalancingSettings

ShardRebalancingSettingsDescriptor

ShardRetentionLease

ShardRetentionLeasesStats

ShardRouting

ShardSequenceNumberStats

ShardStatistics

ShardsOperationResponseBase

ShingleTokenFilter

ShingleTokenFilterDescriptor

ShrinkIndexDescriptor

Descriptor for Shrink

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/

ShrinkIndexRequest

Request for Shrink

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/

ShrinkIndexResponse

SignificantTermsAggregate<TKey>

SignificantTermsAggregation

SignificantTermsAggregationDescriptor<T>

SignificantTermsBucket<TKey>

SignificantTextAggregation

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

SignificantTextAggregationDescriptor<T>

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

Similarities

SimilaritiesDescriptor

SimpleAnalyzer

SimpleAnalyzerDescriptor

SimpleModel

SimpleModelDescriptor

SimpleQueryStringQuery

A query that uses the SimpleQueryParser to parse its context. Unlike the regular IQueryStringQuery, the ISimpleQueryStringQuery query will never throw an exception, and discards invalid parts of the query.

SimpleQueryStringQueryDescriptor<T>

SimulatePipelineDescriptor

Descriptor for SimulatePipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/

SimulatePipelineDocument

SimulatePipelineDocumentDescriptor

SimulatePipelineDocumentsDescriptor

SimulatePipelineRequest

Request for SimulatePipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/

SimulatePipelineResponse

SingleBucketAggregate

SingleBucketsPath

SingleMappingSelector<T>

SizeField

SizeFieldDescriptor

SlicedScroll

SlicedScrollDescriptor<T>

Slices

SlowLog

SlowLogDescriptor

SlowLogIndexing

SlowLogIndexingDescriptor

SlowLogSearch

SlowLogSearchDescriptor

SlowLogSearchFetch

SlowLogSearchFetchDescriptor

SlowLogSearchQuery

SlowLogSearchQueryDescriptor

SmoothingModelBase

SmoothingModelContainer

SmoothingModelContainerDescriptor

Snapshot

SnapshotCompletedEventArgs

SnapshotDescriptor

Descriptor for Snapshot

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/

SnapshotErrorEventArgs

SnapshotIndexShardStats

SnapshotIndexStats

SnapshotNextEventArgs

SnapshotObservable

SnapshotObserver

SnapshotRequest

Request for Snapshot

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/

SnapshotResponse

SnapshotRestore

SnapshotShardFailure

SnapshotShardsStats

SnapshotStats

SnapshotStatus

SnapshotStatusDescriptor

Descriptor for Status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

SnapshotStatusHumbleObject

SnapshotStatusRequest

Request for Status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

SnapshotStatusResponse

SnowballAnalyzer

SnowballAnalyzerDescriptor

SnowballTokenFilter

SnowballTokenFilterDescriptor

SoftDeleteRetentionSettings

SoftDeleteRetentionSettingsDescriptor

SoftDeleteSettings

SoftDeleteSettingsDescriptor

SortBase

SortDescriptorBase<TDescriptor, TInterface, T>

SortDescriptor<T>

SortProcessor

Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings and numbers will be sorted lexicographically.

SortProcessorDescriptor<T>

SortingSettings

SortingSettingsDescriptor<T>

SourceDescriptor<TDocument>

Descriptor for Source

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

SourceExistsDescriptor<TDocument>

Descriptor for SourceExists

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

SourceExistsRequest

Request for SourceExists

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

SourceExistsRequest<TDocument>

SourceField

SourceFieldDescriptor

SourceFilter

SourceFilterDescriptor<T>

SourceManyExtensions

Provides convenience extension methods to get many _source's given a list of ids.

SourceOnlyRepository

SourceOnlyRepositoryDescriptor

A source repository enables you to create minimal, source-only snapshots that take up to 50% less space on disk. Source only snapshots contain stored fields and index metadata. They do not include index or doc values structures and are not searchable when restored. After restoring a source-only snapshot, you must reindex the data into a new index.

SourceRequest

Request for Source

https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

SourceRequestResponseBuilder<TDocument>

SourceRequest<TDocument>

SourceResponse<TDocument>

SpanContainingQuery

SpanContainingQueryDescriptor<T>

SpanFieldMaskingQuery

SpanFieldMaskingQueryDescriptor<T>

SpanFirstQuery

SpanFirstQueryDescriptor<T>

SpanGapQuery

SpanGapQueryDescriptor<T>

SpanMultiTermQuery

SpanMultiTermQueryDescriptor<T>

SpanNearQuery

SpanNearQueryDescriptor<T>

SpanNotQuery

SpanNotQueryDescriptor<T>

SpanOrQuery

SpanOrQueryDescriptor<T>

SpanQuery

SpanQueryDescriptor<T>

SpanTermQuery

SpanTermQueryDescriptor<T>

SpanWithinQuery

SpanWithinQueryDescriptor<T>

SplitIndexDescriptor

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

SplitIndexRequest

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

SplitIndexResponse

SplitProcessor

Splits a field into an array using a separator character. Only works on string fields

SplitProcessorDescriptor<T>

Splits a field into an array using a separator character. Only works on string fields

StandardAnalyzer

StandardAnalyzerDescriptor

StandardDeviationBounds

StandardTokenizer

StandardTokenizerDescriptor

StatsAggregate

StatsAggregation

StatsAggregationDescriptor<T>

StatsBucketAggregation

StatsBucketAggregationDescriptor

StemmerOverrideTokenFilter

StemmerOverrideTokenFilterDescriptor

StemmerTokenFilter

StemmerTokenFilterDescriptor

StopAnalyzer

StopAnalyzerDescriptor

StopTokenFilter

StopTokenFilterDescriptor

StopWords

StoreStats

StoredScript

StoredScriptDescriptor

StrictnessPropagatingVisitor

StringFielddata

StringFielddataDescriptor

StringTimeSpanAttribute

StupidBackoffSmoothingModel

StupidBackoffSmoothingModelDescriptor

SuffixExtensions

SuggestBucket

SuggestContainer

SuggestContainerDescriptor<T>

SuggestContextBase

SuggestContextDescriptorBase<TDescriptor, TInterface, T>

SuggestContextQueriesDescriptor<T>

SuggestContextQuery

SuggestContextQueryDescriptor<T>

SuggestContextsDescriptor<T>

SuggestDescriptorBase<TDescriptor, TInterface, T>

A suggester that suggests similar looking terms based on a provided text

SuggestDictionary<T>

SuggestFuzziness

SuggestFuzzinessDescriptor<T>

Fuzziness options for a suggester

SuggestOption<TDocument>

Suggest<T>

SuggesterBase

SumAggregation

SumAggregationDescriptor<T>

SumBucketAggregation

SumBucketAggregationDescriptor

SynonymGraphTokenFilter

SynonymGraphTokenFilterDescriptor

SynonymTokenFilter

SynonymTokenFilterDescriptor

TDigestMethod

TDigestMethodDescriptor

TaskExecutingNode

A node executing a task

TaskId

TaskInfo

TaskRetries

TaskState

The state of the task

TaskStatus

Template

TemplateDescriptor

TemplateMapping

Term

TermDescriptor<T>

TermQuery

TermQueryDescriptorBase<TDescriptor, TInterface, T>

TermQueryDescriptor<T>

TermRangeQuery

TermRangeQueryDescriptor<T>

TermSuggester

The term suggester suggests terms based on edit distance. The provided suggest text is analyzed before terms are suggested. The suggested terms are provided per analyzed suggest text token. The term suggester doesn’t take the query into account that is part of request.

TermSuggesterDescriptor<T>

TermVector

TermVectorFilter

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

TermVectorFilterDescriptor

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

TermVectorTerm

TermVectorsDescriptor<TDocument>

Descriptor for TermVectors

https://opensearch.org/docs/latest

TermVectorsRequest<TDocument>

Request for TermVectors

https://opensearch.org/docs/latest

TermVectorsResponse

TermVectorsResult

TermsAggregate<TKey>

TermsAggregation

TermsAggregationDescriptor<T>

TermsCompositeAggregationSource

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

TermsCompositeAggregationSourceDescriptor<T>

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

TermsExclude

Filters which terms to exclude from the response

TermsInclude

Filters which terms to include in the response

TermsOrder

TermsOrderDescriptor<T>

TermsQuery

TermsQueryDescriptor<T>

A query that match on any (configurable) of the provided terms. This is a simpler syntax query for using a bool query with several term queries in the should clauses.

TermsSetQuery

Returns any documents that match with at least one or more of the provided terms. The terms are not analyzed and thus must match exactly. The number of terms that must match varies per document and is either controlled by a minimum should match field or computed per document in a minimum should match script.

TermsSetQueryDescriptor<T>

TextAttribute

TextEmbeddingProcessor

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

TextEmbeddingProcessorDescriptor<TDocument>

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

TextIndexPrefixes

TextIndexPrefixesDescriptor

TextProperty

A field to index full-text values, such as the body of an email or the description of a product. These fields are analyzed in OpenSearch, by passing through an analyzer to convert the string into a list of individual terms before being indexed.

Text fields are not used for sorting and seldom used for aggregations

TextPropertyDescriptor<T>

Text fields are not used for sorting and seldom used for aggregations

ThreadCountStats

Time

Represents a time value

TimeUnitExtensions

Timestamp

TimestampField

TimestampFieldDescriptor

Token

TokenCountAttribute

TokenCountProperty

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

TokenCountPropertyDescriptor<T>

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

TokenDetail

TokenFilterBase

TokenFilterDescriptorBase<TTokenFilter, TTokenFilterInterface>

TokenFilters

TokenFiltersDescriptor

TokenizerBase

TokenizerDescriptorBase<TTokenizer, TTokenizerInterface>

Tokenizers

TokenizersDescriptor

TopHitsAggregate

TopHitsAggregation

TopHitsAggregationDescriptor<T>

TotalHits

Description of the total number of hits of a query. The total hit count can't generally be computed accurately without visiting all matches, which is costly for queries that match lots of documents. Given that it is often enough to have a lower bounds of the number of hits, such as "there are more than 1000 hits", OpenSearch has options to stop counting as soon as a threshold has been reached in order to improve query times.

TotalIndexingLoad

TrackTotalHits

TranslogFlushSettings

TranslogFlushSettingsDescriptor

TranslogSettings

TranslogSettingsDescriptor

TranslogStats

TransportStats

TrimProcessor

Trims whitespace from field. This only works on leading and trailing whitespace

TrimProcessorDescriptor<T>

Trims whitespace from field. This only works on leading and trailing whitespace

TrimTokenFilter

TrimTokenFilterDescriptor

TruncateTokenFilter

TruncateTokenFilterDescriptor

TypeExistsDescriptor

Descriptor for TypeExists

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/

TypeExistsRequest

Request for TypeExists

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/

TypeFieldMappings

TypeMapping

TypeMappingDescriptor<T>

UaxEmailUrlTokenizer

UaxEmailUrlTokenizerDescriptor

UnassignedInformation

Union<TFirst, TSecond>

Represents the union of two types, TFirst and TSecond. Used in scenarios where an OpenSearch API may accept more than one different input data structure.

UniqueTokenFilter

UniqueTokenFilterDescriptor

UpdatableIndexSettings

Collection of OpenSearch index settings that can be dynamically updated

UpdateByQueryDescriptor<TDocument>

Descriptor for UpdateByQuery

https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/

UpdateByQueryRequest

Request for UpdateByQuery

https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/

UpdateByQueryRequest<TDocument>

UpdateByQueryResponse

UpdateByQueryRethrottleDescriptor

Descriptor for UpdateByQueryRethrottle

https://opensearch.org/docs/latest

UpdateByQueryRethrottleRequest

Request for UpdateByQueryRethrottle

https://opensearch.org/docs/latest

UpdateDescriptor<TDocument, TPartialDocument>

Descriptor for Update

https://opensearch.org/docs/latest/api-reference/document-apis/update-document/

UpdateIndexSettingsDescriptor

Descriptor for UpdateSettings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

UpdateIndexSettingsRequest

Request for UpdateSettings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

UpdateIndexSettingsResponse

UpdateRequest<TDocument, TPartialDocument>

Request for Update

https://opensearch.org/docs/latest/api-reference/document-apis/update-document/

UpdateResponse<TDocument>

UppercaseProcessor

UppercaseProcessorDescriptor<T>

UppercaseTokenFilter

UppercaseTokenFilterDescriptor

UriPartsProcessor

UriPartsProcessorDescriptor<T>

UrlDecodeProcessor

URL-decodes a string

UrlDecodeProcessorDescriptor<T>

URL-decodes a string

UserAgentProcessor

Ingest pipelines are composed of one or more processors

UserAgentProcessorDescriptor<T>

Ingest pipelines are composed of one or more processors

ValidateQueryDescriptor<TDocument>

Descriptor for ValidateQuery

https://opensearch.org/docs/latest

ValidateQueryRequest

Request for ValidateQuery

https://opensearch.org/docs/latest

ValidateQueryRequest<TDocument>

ValidateQueryResponse

ValidationExplanation

ValueAggregate

ValueCountAggregation

ValueCountAggregationDescriptor<T>

VariableWidthHistogramAggregation

VariableWidthHistogramAggregationDescriptor<T>

VariableWidthHistogramBucket

VerbatimPropagatingVisitor

VerifyRepositoryDescriptor

Descriptor for VerifyRepository

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/

VerifyRepositoryRequest

Request for VerifyRepository

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/

VerifyRepositoryResponse

WarmerStats

WeightFunction

WeightFunctionDescriptor<T>

WeightedAverageAggregation

WeightedAverageAggregationDescriptor<T>

WeightedAverageValue

WeightedAverageValueDescriptor<T>

WhitespaceAnalyzer

WhitespaceAnalyzerDescriptor

WhitespaceTokenizer

A tokenizer of type whitespace that divides text at whitespace.

WhitespaceTokenizerDescriptor

A tokenizer of type whitespace that divides text at whitespace.

WildcardQuery

WildcardQueryDescriptor<T>

WildcardQuery<T, TValue>

WordDelimiterGraphTokenFilter

WordDelimiterGraphTokenFilterDescriptor

WordDelimiterTokenFilter

WordDelimiterTokenFilterDescriptor

WriteResponseBase

Interfaces

IAddIndexBlockRequest

A request to the indices add block API

IAdjacencyMatrixAggregation

IAggregate

Aggregation response for an aggregation request

IAggregation

An aggregation on the request

IAggregationContainer

IAggregationRange

Range that defines a bucket for either the RangeAggregation or GeoDistanceAggregation. If you are looking to store ranges as part of your document please use explicit range class e.g DateRange, FloatRange etc

IAggregationVisitor

IAlias

An alias to one or more indices

IAliasAction

Marker interface for alias operation

IAliasAddAction

IAliasExistsRequest

IAliasRemoveAction

IAliasRemoveIndexAction

IAliases

IAllocateClusterRerouteCommand

IAllocateEmptyPrimaryRerouteCommand

IAllocateReplicaClusterRerouteCommand

IAllocateStalePrimaryRerouteCommand

IAllocationAttributes

IAllocationAwarenessSettings

IAllocationFilteringSettings

IAnalysis

IAnalyzeRequest

IAnalyzer

IAnalyzers

IAppendProcessor

IArbitraryBodyHttpRequest<T>

IArbitraryHttpRequest<T>

IAsciiFoldingTokenFilter

A token filter of type asciifolding that converts alphabetic, numeric, and symbolic Unicode characters which are

not in the first 127 ASCII characters (the “Basic Latin” Unicode block) into their ASCII equivalents, if one exists.

IAttachmentProcessor

IAutoDateHistogramAggregation

IAverageAggregation

IAverageBucketAggregation

IAzureRepository

A snapshot repository that stores snapshots in an Azure storage account

Requires the repository-azure plugin to be installed on the cluster

IAzureRepositorySettings

Snapshot repository settings for IAzureRepository

IBM25Similarity

BM25 Similarity. Introduced in Stephen E. Robertson, Steve Walker, Susan Jones, Micheline Hancock-Beaulieu, and Mike Gatford. Okapi at TREC-3. In Proceedings of the Third Text Retrieval Conference (TREC 1994). Gaithersburg, USA, November 1994.

IBinaryProperty

The binary type accepts a binary value as a Base64 encoded string. The field is not stored by default and is not searchable

IBoolQuery

IBooleanProperty

The boolean fields accepts true and false values

IBoostingQuery

IBoundingBox

IBucket

IBucketAggregation

IBucketScriptAggregation

IBucketSelectorAggregation

IBucketSortAggregation

IBucketsPath

IBulkAliasRequest

IBulkAllRequest<T>

IBulkCreateOperation<T>

IBulkDeleteOperation<T>

IBulkIndexOperation<T>

IBulkOperation

IBulkRequest

IBulkUpdateOperation<TDocument, TPartialDocument>

IBytesProcessor

ICancelClusterRerouteCommand

ICancelTasksRequest

ICardinalityAggregation

ICatAliasesRequest

ICatAllPitSegmentsRequest

ICatAllocationRequest

ICatClusterManagerRequest

ICatCountRequest

ICatFielddataRequest

ICatHealthRequest

ICatHelpRequest

ICatIndicesRequest

ICatMasterRequest

ICatNodeAttributesRequest

ICatNodesRequest

ICatPendingTasksRequest

ICatPitSegmentsRequest

ICatPluginsRequest

ICatRecord

ICatRecoveryRequest

ICatRepositoriesRequest

ICatSegmentReplicationRequest

ICatSegmentsRequest

ICatShardsRequest

ICatSnapshotsRequest

ICatTasksRequest

ICatTemplatesRequest

ICatThreadPoolRequest

ICategorySuggestContext

ICharFilter

ICharFilters

ICharGroupTokenizer

IChiSquareHeuristic

IChildrenAggregation

ICircleGeoShape

ICircuitBreakerSettings

ICleanupRepositoryRequest

IClearCacheRequest

IClearScrollRequest

ICloneIndexRequest

A request to the clone index API

ICloneSnapshotRequest

ICloseIndexRequest

IClrPropertyMapping<TDocument>

IClrTypeMapping

IClrTypeMapping<TDocument>

IClusterAllocationExplainRequest

IClusterGetSettingsRequest

IClusterHealthRequest

IClusterModuleSettings

Settings to control where, when, and how shards are allocated to nodes.

IClusterPendingTasksRequest

IClusterPutSettingsRequest

IClusterRerouteCommand

IClusterRerouteRequest

IClusterStateRequest

IClusterStatsRequest

ICommonGramsTokenFilter

Token filter that generates bigrams for frequently occuring terms. Single terms are still indexed.

Note, common_words or common_words_path field is required.

ICompletionProperty

ICompletionSuggester

IComponentTemplate

IComponentTemplateExistsRequest

IComposableIndexTemplate

IComposableIndexTemplateExistsRequest

ICompositeAggregation

A multi-bucket aggregation that creates composite buckets from different sources.

ICompositeAggregationSource

A values source for ICompositeAggregation

ICompoundWordTokenFilter

Token filters that allow to decompose compound words.

IConditionTokenFilter

The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

IConditionlessQuery

IConnectionSettingsValues

Provides the connection settings for OpenSearchClient

IConstantScoreQuery

IConvertProcessor

Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.

ICoreProperty

Core properties of a mapping for a property type to a document field in OpenSearch

ICountRequest

ICountRequest<TDocument>

ICreateIndexRequest

ICreatePitRequest

ICreateRepositoryRequest

Creates a snapshot repository

ICreateRequest<TDocument>

ICsvProcessor

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

ICumulativeSumAggregation

ICustomAnalyzer

An analyzer of type custom that allows to combine a Tokenizer with zero or more Token Filters, and zero or more Char Filters.

The custom analyzer accepts a logical/registered name of the tokenizer to use, and a list of logical/registered names of token filters.

ICustomNormalizer

Normalizers are similar to analyzers except that they may only emit a single token. As a consequence, they do not have a tokenizer and only accept a subset of the available char filters and token filters. Only the filters that work on a per-character basis are allowed. For instance a lowercasing filter would be allowed, but not a stemming filter, which needs to look at the keyword as a whole.

OpenSearch does not ship with built-in normalizers so far, so the only way to create one is through composing a custom one

ICustomSimilarity

A custom similarity

IDFISimilarity

Similarity that implements the divergence from independence model

IDFRSimilarity

Implements the divergence from randomness (DFR) framework introduced in Gianni Amati and Cornelis Joost Van Rijsbergen. 2002. Probabilistic models of information retrieval based on measuring the divergence from randomness. ACM Trans. Inf. Syst. 20, 4 (October 2002), 357-389. The DFR scoring formula is composed of three separate components: the basic model, the aftereffect and an additional normalization component, represented by the classes BasicModel, AfterEffect and Normalization, respectively.The names of these classes were chosen to match the names of their counterparts in the Terrier IR engine.

IDataStreamTemplate

IDateHistogramAggregation

IDateHistogramCompositeAggregationSource

IDateIndexNameProcessor

The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.

IDateMath

IDateNanosProperty

The date nanos datatype is similar to IDateProperty, except that internally, the date is stored with nanosecond resolution. This limits its range of dates from roughly 1970 to 2262.

IDateProcessor

IDateProperty

The date datatype maps a field as a date in OpenSearch.

IDateRangeAggregation

IDateRangeExpression

IDateRangeProperty

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

IDateRangeQuery

IDecayFunction

IDecayFunction<TOrigin, TScale>

IDeleteAliasRequest

IDeleteAllPitsRequest

IDeleteByQueryRequest

Delete documents that match a given query

IDeleteByQueryRequest<TDocument>

Delete documents that match a given query

IDeleteByQueryRethrottleRequest

Rethrottles a running delete by query

IDeleteComponentTemplateRequest

IDeleteComposableIndexTemplateRequest

IDeleteDanglingIndexRequest

IDeleteIndexRequest

IDeleteIndexTemplateRequest

IDeletePipelineRequest

IDeletePitRequest

IDeleteRepositoryRequest

IDeleteRequest

IDeleteRequest<TDocument>

IDeleteScriptRequest

IDeleteSnapshotRequest

IDeleteVotingConfigExclusionsRequest

IDelimitedPayloadTokenFilter

Splits tokens into tokens and payload whenever a delimiter character is found.

IDerivativeAggregation

IDescriptor

IDictionaryDecompounderTokenFilter

IDictionaryResponse<TKey, TValue>

IDirectGenerator

IDisMaxQuery

IDiskBasedShardAllocationSettings

IDissectProcessor

IDistanceFeatureQuery

IDiversifiedSamplerAggregation

IDocValuesProperty

Properties of a mapping for a property type to a document field that has doc_values in OpenSearch

IDocumentExistsRequest

IDocumentExistsRequest<TDocument>

IDocumentPath

IDocumentRequest

Describes a request that serializes the document passed to DocumentPath<T> when calling the fluent API.

IDotExpanderProcessor

IDoubleRangeProperty

A range of double-precision 64-bit IEEE 754 floating point values.

IDropProcessor

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

IDynamicIndexSettings

Dynamic index settings

IDynamicResponse

IDynamicTemplate

A Dynamic template that defines custom mappings to be applied to dynamically added fields based on:

- the datatype detected by OpenSearch, with MatchMappingType.

- the name of the field, with Match and Unmatch or MatchPattern.

- the full dotted path to the field, with PathMatch and PathUnmatch.

IDynamicTemplateContainer

IEdgeNGramTokenFilter

A token filter of type edgeNGram.

IEdgeNGramTokenizer

A tokenizer of type edgeNGram.

IElisionTokenFilter

A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

IEnvelopeGeoShape

IEwmaModel

IExecutePainlessScriptRequest

The Painless execute API allows an arbitrary script to be executed and a result to be returned.

IExecutePainlessScriptResponse<TResult>

IExistsQuery

IExplainRequest

IExplainRequest<TDocument>

IExplainResponse<TDocument>

IExtendedStatsAggregation

IExtendedStatsBucketAggregation

IFailProcessor

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

IFieldAliasProperty

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

IFieldCapabilitiesRequest

IFieldCollapse

NOTE: The collapsing is applied to the top hits only and does not affect aggregations.

IFieldLookup

IFieldMapping

A document field mapping in OpenSearch

IFieldNameQuery

IFieldNamesField

IFieldSort

IFieldValueFactorFunction

IFielddata

IFielddataFilter

IFielddataFrequencyFilter

IFielddataRegexFilter

IFileSystemRepository

IFileSystemRepositorySettings

Repository settings for IFileSystemRepository

IFilterAggregation

IFiltersAggregation

IFingerprintAnalyzer

The fingerprint analyzer implements a fingerprinting algorithm which is used by the OpenRefine project to assist in clustering.

IFingerprintProcessor

IFingerprintTokenFilter

The fingerprint token filter emits a single token which is useful for fingerprinting a body of text, and/or providing a token that can be clustered on. It does this by sorting the tokens, deduplicating and then concatenating them back into a single token.

IFloatRangeProperty

A range of single-precision 32-bit IEEE 754 floating point values.

IFlushRequest

IForceMergeRequest

IForeachProcessor

IFormattableMetricAggregation

A metric aggregation that can accept a format to use for the output of the aggregation

IFunctionScoreQuery

IFuzziness

IFuzzyDateQuery

IFuzzyNumericQuery

IFuzzyQuery

IFuzzyQuery<TValue, TFuzziness>

IFuzzyStringQuery

IGenericProperty

A generic property to map properties that may be of different types. Not all methods are valid for all types.

IGeoBoundingBoxQuery

IGeoBoundsAggregation

IGeoCentroidAggregation

IGeoDistanceAggregation

IGeoDistanceQuery

IGeoDistanceSort

Allows you to sort based on a proximity to one or more GeoLocation

IGeoHashGridAggregation

IGeoIpProcessor

IGeoLineAggregation

IGeoPointFielddata

IGeoPointProperty

Data type mapping to map a property as a geopoint

IGeoPolygonQuery

IGeoShape

IGeoShapeProperty

Maps a property as a geo_shape field

IGeoShapeQuery

IGeoSuggestContext

IGeoTileGridAggregation

IGeoTileGridCompositeAggregationSource

A values source that is equivalent to a simple Geo aggregation.

IGeometryCollection

A geo shape representing a collection of IGeoShape geometries

IGetAliasRequest

IGetAllPitsRequest

IGetComponentTemplateRequest

IGetComposableIndexTemplateRequest

IGetFieldMappingRequest

IGetIndexRequest

IGetIndexSettingsRequest

IGetIndexTemplateRequest

IGetMappingRequest

IGetPipelineRequest

IGetRepositoryRequest

IGetRequest

IGetRequest<TDocument>

IGetResponse<TDocument>

IGetScriptRequest

IGetSnapshotRequest

IGetTaskRequest

IGlobalAggregation

IGoogleNormalizedDistanceHeuristic

IGrokProcessor

IGrokProcessorPatternsRequest

IGsubProcessor

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

IHDRHistogramMethod

IHasChildQuery

IHasParentQuery

IHdfsRepository

A snapshot repository that stores snapshot data within a Hadoop HDFS filesystem

Requires the repository-hdfs plugin to be installed on the cluster

IHdfsRepositorySettings

Snapshot repository settings for IHdfsRepository

IHighlight

IHighlightField

IHistogramAggregation

IHistogramCompositeAggregationSource

IHitMetadata<TDocument>

Metadata about a hit matching a query

IHit<TDocument>

A hit matching a query

IHitsMetadata<T>

IHoltLinearModel

IHoltWintersModel

IHtmlStripCharFilter

A char filter of type html_strip stripping out HTML elements from an analyzed text.

IHttpDeleteRequest

IHttpGetRequest

IHttpHeadRequest

IHttpPatchRequest

IHttpPostRequest

IHttpPutRequest

IHunspellTokenFilter

Basic support for hunspell stemming.

Hunspell dictionaries will be picked up from a dedicated hunspell directory on the filesystem.

IHyphenationDecompounderTokenFilter

Token filters that allow to decompose compound words.

IIBSimilarity

IIcuAnalyzer

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

IIcuCollationTokenFilter

IIcuFoldingTokenFilter

Case folding of Unicode characters based on UTR#30, like the ASCII-folding token filter on steroids.

IIcuNormalizationCharFilter

Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization

IIcuNormalizationTokenFilter

Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization

IIcuTokenizer

Tokenizes text into words on word boundaries, as defined in UAX #29: Unicode Text Segmentation. It behaves much like the standard tokenizer, but adds better support for some Asian languages by using a dictionary-based approach to identify words in Thai, Lao, Chinese, Japanese, and Korean, and using custom rules to break Myanmar and Khmer text into syllables.

IIcuTransformTokenFilter

Transforms are used to process Unicode text in many different ways, such as case mapping, normalization, transliteration and bidirectional text handling.

IIdsQuery

IImportDanglingIndexRequest

IIndexExistsRequest

IIndexRequest<TDocument>

IIndexSettings

The settings for an index

IIndexState

IIndexTemplateExistsRequest

IIndexedScript

IIndicesModuleSettings

Settings to control where, when, and how shards are allocated to nodes.

IIndicesRecoverySettings

IIndicesStatsRequest

IInferenceFieldMap

IInferenceProcessor

IInlineGet<TDocument>

IInlineScript

IInnerHits

IIntegerRangeProperty

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

IIntervals

An IIntervalsQuery rule with an optional filter

IIntervalsAllOf

A rule that returns matches that span a combination of other rules.

IIntervalsAnyOf

A rule that emits intervals produced by any of its sub-rules.

IIntervalsContainer

Container for an IIntervalsQuery rule

IIntervalsFilter

Filters intervals produced by any rules by their relation to the intervals produced by another rule

IIntervalsFuzzy

The fuzzy rule matches terms that are similar to the provided term, within an edit distance defined by Fuzziness. If the fuzzy expansion matches more than 128 terms, OpenSearch returns an error.

IIntervalsMatch

Matches the analyzed text

IIntervalsNoFilter

An IIntervalsQuery rule

IIntervalsPrefix

IIntervalsQuery

IIntervalsWildcard

Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms. If the pattern matches more than 128 terms, OpenSearch returns an error.

IIpProperty

An ip field can index/store either IPv4 or IPv6 addresses.

IIpRangeAggregation

IIpRangeAggregationRange

IIpRangeProperty

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

IIsADictionary

IIsADictionary<TKey, TValue>

IIsAReadOnlyDictionary

IIsAReadOnlyDictionary<TKey, TValue>

IJoinProcessor

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

IJoinProperty

The join datatype is a special field that creates parent/child relation within documents of the same index.

IJsonProcessor

Converts a JSON string into a structured JSON object.

IKStemTokenFilter

The kstem token filter is a high performance filter for english.

All terms must already be lowercased (use lowercase filter) for this filter to work correctly.

IKeepTypesTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

IKeepWordsTokenFilter

A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

IKeyValueProcessor

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

IKeywordAnalyzer

An analyzer of type keyword that “tokenizes” an entire stream as a single token. This is useful for data like zip codes, ids and so on.

Note, when using mapping definitions, it make more sense to simply mark the field as not_analyzed.

IKeywordMarkerTokenFilter

Protects words from being modified by stemmers. Must be placed before any stemming filters.

IKeywordProperty

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.

IKeywordTokenizer

A tokenizer of type keyword that emits the entire input as a single input.

IKnnMethod

IKnnMethodParameters

IKnnQuery

An approximate k-NN query.

IKnnVectorProperty

IKuromojiAnalyzer

An analyzer tailored for japanese that is bootstrapped with defaults. Part of the analysis-kuromoji plugin:

IKuromojiIterationMarkCharFilter

The kuromoji_iteration_mark normalizes Japanese horizontal iteration marks (odoriji) to their expanded form. Part of the analysis-kuromoji plugin:

IKuromojiPartOfSpeechTokenFilter

The kuromoji_part_of_speech token filter removes tokens that match a set of part-of-speech tags. Part of the analysis-kuromoji plugin:

IKuromojiReadingFormTokenFilter

The kuromoji_readingform token filter replaces the token with its reading form in either katakana or romaji. Part of the analysis-kuromoji plugin:

IKuromojiStemmerTokenFilter

The kuromoji_stemmer token filter normalizes common katakana spelling variations ending in a long sound character by removing this character (U+30FC). Only full-width katakana characters are supported. Part of the analysis-kuromoji plugin:

IKuromojiTokenizer

A tokenizer of type pattern that can flexibly separate text into terms via a regular expression. Part of the analysis-kuromoji plugin:

ILMDirichletSimilarity

A similarity with Bayesian smoothing using Dirichlet priors.

ILMJelinekMercerSimilarity

A similarity that attempts to capture important patterns in the text, while leaving out noise.

ILanguageAnalyzer

A set of analyzers aimed at analyzing specific language text.

ILaplaceSmoothingModel

ILazyDocument

A lazily deserialized document

ILengthTokenFilter

A token filter of type length that removes words that are too long or too short for the stream.

ILetterTokenizer

A tokenizer of type letter that divides text at non-letters. That’s to say, it defines tokens as maximal strings of adjacent letters.

Note, this does a decent job for most European languages, but does a terrible job for some Asian languages, where words are not separated by spaces.

ILikeDocument

An indexed or artificial document with which to find likeness

ILimitTokenCountTokenFilter

Limits the number of tokens that are indexed per document and field.

ILineStringGeoShape

ILinearInterpolationSmoothingModel

ILinearModel

IListDanglingIndicesRequest

IListTasksRequest

ILongRangeProperty

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

ILongRangeQuery

ILowercaseProcessor

Converts a string to its lowercase equivalent.

ILowercaseTokenFilter

A token filter of type lowercase that normalizes token text to lower case.

Lowercase token filter supports Greek and Turkish lowercase token filters through the language parameter.

ILowercaseTokenizer

A tokenizer of type lowercase that performs the function of Letter Tokenizer and Lower Case Token Filter together.

It divides text at non-letters and converts them to lower case.

While it is functionally equivalent to the combination of Letter Tokenizer and Lower Case Token Filter,

there is a performance advantage to doing the two tasks at once, hence this (redundant) implementation.

IMappingCharFilter

A char filter of type mapping replacing characters of an analyzed text with given mapping.

IMappingVisitor

IMatchAllQuery

IMatchBoolPrefixQuery

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

IMatchNoneQuery

IMatchPhrasePrefixQuery

IMatchPhraseQuery

IMatchQuery

A match query for a single field

IMatrixAggregation

IMatrixStatsAggregation

IMaxAggregation

IMaxBucketAggregation

IMedianAbsoluteDeviationAggregation

This single-value aggregation approximates the median absolute deviation of its search results.

It is calculated as the median of each data point’s deviation from the median of the entire sample. That is, for a random variable

, the median absolute deviation is

median(|median(X) - Xi|).

IMergePolicySettings

IMergeSchedulerSettings

IMergeSettings

IMetricAggregation

An aggregation that computes metrics based on values extracted in one way or another from the documents that are being aggregated.

IMinAggregation

IMinBucketAggregation

IMissingAggregation

IMoreLikeThisQuery

IMoveClusterRerouteCommand

IMovingAverageAggregation

IMovingAverageModel

IMovingFunctionAggregation

IMultiBucketsPath

IMultiGetHit<TDocument>

IMultiGetOperation

IMultiGetRequest

IMultiLineStringGeoShape

IMultiMatchQuery

A match query across multiple fields.

IMultiPointGeoShape

IMultiPolygonGeoShape

IMultiSearchRequest

IMultiSearchTemplateRequest

IMultiTermVectorOperation

An operation to define the calculation of term vectors when using Multi termvectors API

IMultiTermVectorsRequest

A Multi termvectors API request

IMultiTermsAggregation

IMultiplexerTokenFilter

IMurmur3HashProperty

IMutualInformationHeuristic

INGramTokenFilter

A token filter of type nGram.

INGramTokenizer

A tokenizer of type nGram.

INamedFiltersContainer

INestedAggregation

INestedProperty

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

INestedQuery

INestedSort

Sort on a field inside one or more nested objects.

INetworkCommunityIdProcessor

INetworkDirectionProcessor

INeuralQuery

A neural query.

INodesHotThreadsRequest

INodesInfoRequest

INodesStatsRequest

INodesUsageRequest

INoriAnalyzer

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

INoriPartOfSpeechTokenFilter

The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

INoriTokenizer

Tokenizer that ships with the analysis-nori plugin

INormalizer

INormalizers

INumberProperty

A numeric mapping that defaults to float.

INumericFielddata

INumericRangeQuery

IObjectProperty

A mapping for an inner object

IOpenIndexRequest

IOpenSearchClient

OpenSearch high level client

IPainlessContextSetup

Sets up contextual scope for the painless script the execute under.

IParentAggregation

A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.

IParentIdQuery

The parent_id query can be used to find child documents which belong to a particular parent.

IPathHierarchyTokenizer

The path_hierarchy tokenizer takes something like this:

/something/something/else

And produces tokens:

/something

/something/something

/something/something/else

IPatternAnalyzer

An analyzer of type pattern that can flexibly separate text into terms via a regular expression.

IPatternCaptureTokenFilter

The pattern_capture token filter, unlike the pattern tokenizer, emits a token for every capture group in the regular expression.

IPatternReplaceCharFilter

The pattern_replace char filter allows the use of a regex to manipulate the characters in a string before analysis.

IPatternReplaceTokenFilter

The pattern_replace token filter allows to easily handle string replacements based on a regular expression.

IPatternTokenizer

A tokenizer of type pattern that can flexibly separate text into terms via a regular expression.

IPerFieldAnalyzer

IPercentageScoreHeuristic

IPercentileRanksAggregation

IPercentilesAggregation

IPercentilesBucketAggregation

IPercentilesMethod

IPercolateQuery

The percolate query can be used to match queries stored in an index

IPercolatorProperty

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

IPhoneticTokenFilter

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

IPhraseSuggestCollate

Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.

IPhraseSuggestCollateQuery

A query to run for a phrase suggester collate

IPhraseSuggestHighlight

Highlighting for IPhraseSuggester

IPhraseSuggester

IPingRequest

IPipeline

IPipelineAggregation

IPipelineProcessor

Executes another pipeline.

IPointGeoShape

IPointInTime

IPolygonGeoShape

IPorterStemTokenFilter

A token filter of type porterStem that transforms the token stream as per the Porter stemming algorithm.

IPostVotingConfigExclusionsRequest

IPredicateTokenFilter

The predicate_token_filter token filter takes a predicate script, and removes tokens that do not match the predicate.

IPrefixQuery

IProcessor

Ingest pipelines are composed of one or more processors

IPromise<TValue>

IProperties

IPropertiesDescriptor<T, TReturnType>

IProperty

A mapping for a property type to a document field in OpenSearch

IPropertyMapping

Determines how a POCO property maps to the property on a JSON object when serialized

IPropertyMappingProvider

Provides mappings for CLR types

IPropertyVisitor

IPropertyWithClrOrigin

A mapping for a property from a CLR type

IProxyRequest

A request that that does not necessarily (de)serializes itself

IPutAliasRequest

A request to put an alias to one or more indices

IPutComponentTemplateRequest

IPutComposableIndexTemplateRequest

IPutIndexTemplateRequest

IPutMappingRequest

IPutMappingRequest<TDocument>

IPutPipelineRequest

IPutScriptRequest

IQueriesCacheSettings

IQueriesSettings

IQuery

IQueryContainer

IQueryStringQuery

A query that uses a query parser in order to parse its content

IQueryVisitor

IRandomScoreFunction

IRangeAggregation

IRangeProperty

IRangeQuery

IRankFeatureFunction

A function to boost scores in a rank_feature query, using the values of rank features.

IRankFeatureLinearFunction

Gives a score equal to the indexed value of S, where S is the value of the rank feature field.

If a rank feature field is indexed with "positive_score_impact": true, its indexed value is equal to S and rounded to preserve only 9 significant bits for the precision.

If a rank feature field is indexed with "positive_score_impact": false, its indexed value is equal to 1/S and rounded to preserve only 9 significant bits for the precision.

IRankFeatureLogarithmFunction

IRankFeatureProperty

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

IRankFeatureQuery

A query that only works on rank_feature fields and rank_features fields. Its goal is to boost the score of documents based on the values of numeric features. It is typically put in a should clause of a bool query so that its score is added to the score of the query.

Compared to using function_score or other ways to modify the score, this query has the benefit of being able to efficiently skip non-competitive hits when track_total_hits is not set to true. Speedups may be spectacular.

IRankFeatureSaturationFunction

IRankFeatureSigmoidFunction

IRankFeaturesProperty

IRareTermsAggregation

IRawQuery

IReadOnlyUrlRepository

IReadOnlyUrlRepositorySettings

Snapshot repository settings for IReadOnlyUrlRepository

IRefreshRequest

IRegexpQuery

Queries documents that contain terms matching a regular expression.

IReindexDestination

Configures the destination for a reindex API request

IReindexOnServerRequest

A request to Reindex API

IReindexRequest<TSource>

A reindex implementation that uses ScrollAll() BulkAll() to compose a reindex pipeline.

This differs from ReindexOnServer() in that documents are fetched from OpenSearch, transformed on the client side, then sent back to OpenSearch.

This will create the target index if it doesn't exist already. If CreateIndexRequest is not specified and the source of the reindex points to a single index we try and reuse the settings from source. You can completely opt out of all of this using OmitIndexCreation

IReindexRequest<TSource, TTarget>

A reindex implementation that uses ScrollAll() BulkAll() to compose a reindex pipeline.

This differs from ReindexOnServer() in that documents are fetched from OpenSearch, transformed on the client side, then sent back to OpenSearch.

IReindexRethrottleRequest

IReindexSource

Configures the source for a reindex API request

IRelations

IReloadSecureSettingsRequest

IRemoteInfoRequest

IRemoteSource

IRemoveDuplicatesTokenFilter

A token filter that drops identical tokens at the same position

IRemoveProcessor

Removes existing fields. If one field doesn't exist, an exception will be thrown.

IRenameProcessor

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

IRenderSearchTemplateRequest

IRepositorySettings

Snapshot repository settings

IRepositoryWithSettings

A snapshot repository with settings

IRepository<TSettings>

A snapshot repository with typed settings

IRequest

IRequest<TParameters>

IRescore

IRescoreQuery

IResolveIndexRequest

A request to the resolve index API

IResponse

A response from OpenSearch

IRestoreRequest

Restores a snapshot

IReverseNestedAggregation

IReverseTokenFilter

A token filter of type reverse that simply reverses the tokens.

IRolloverConditions

Conditions that must be satisfied for a new index to be created with the rollover index API

IRolloverIndexRequest

IRootNodeInfoRequest

IRoutingField

IRuntimeField

IRuntimeFields

IS3Repository

A snapshot repository that stores snapshots in an Amazon S3 bucket

Requires the repository-s3 plugin to be installed on the cluster

IS3RepositorySettings

Snapshot repository settings for IS3Repository

ISamplerAggregation

IScoreFunction

IScript

A script to execute to provide custom computation

IScriptField

IScriptFields

IScriptProcessor

Allows inline and stored scripts to be executed within ingest pipelines.

IScriptQuery

A query allowing to define a script to execute as a query

IScriptScoreFunction

The script score function allows you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.

IScriptScoreQuery

IScriptSort

IScriptedHeuristic

IScriptedMetricAggregation

IScriptedSimilarity

A similarity that allows a script to be used in order to specify how scores should be computed.

IScrollAllRequest

IScrollAllResponse<T>

A response returned for each scroll in ScrollAll()

IScrollRequest

ISearchAsYouTypeProperty

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

ISearchRequest

ISearchRequest<TInferDocument>

ISearchResponse<TDocument>

A response to a search request

ISearchShardsRequest

ISearchShardsRequest<TDocument>

ISearchTemplateRequest

ISelector

ISerialDifferencingAggregation

ISetProcessor

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

IShapeQuery

IShardAllocationSettings

IShardBalancingHeuristicsSettings

IShardRebalancingSettings

IShingleTokenFilter

A token filter of type shingle that constructs shingles (token n-grams) from a token stream.

In other words, it creates combinations of tokens as a single token.

IShrinkIndexRequest

ISignificantTermsAggregation

ISignificantTextAggregation

An aggregation that returns interesting or unusual occurrences of free-text terms in a set.

ISimilarities

ISimilarity

A similarity.

ISimpleAnalyzer

An analyzer of type simple that is built using a Lower Case Tokenizer.

ISimpleModel

ISimpleQueryStringQuery

ISimulatePipelineDocument

ISimulatePipelineRequest

ISizeField

ISlicedScroll

ISlowLog

ISlowLogIndexing

ISlowLogSearch

ISlowLogSearchFetch

ISlowLogSearchQuery

ISmoothingModel

ISmoothingModelContainer

ISnapshotRepository

A snapshot repository

ISnapshotRequest

ISnapshotStatusRequest

ISnowballAnalyzer

An analyzer of type snowball that uses the standard tokenizer, with standard filter, lowercase filter, stop filter, and snowball filter.

The Snowball Analyzer is a stemming analyzer from Lucene that is originally based on the snowball project from snowball.tartarus.org.

ISnowballTokenFilter

A filter that stems words using a Snowball-generated stemmer.

ISoftDeleteRetentionSettings

ISoftDeleteSettings

ISort

ISortOrder

ISortProcessor

ISortingSettings

ISourceExistsRequest

ISourceExistsRequest<TDocument>

ISourceField

ISourceFilter

ISourceOnlyRepository

ISourceRequest

ISourceRequest<TDocument>

ISourceResponse<TDocument>

ISpanContainingQuery

ISpanFieldMaskingQuery

ISpanFirstQuery

ISpanGapQuery

ISpanMultiTermQuery

ISpanNearQuery

ISpanNotQuery

ISpanOrQuery

ISpanQuery

ISpanSubQuery

ISpanTermQuery

ISpanWithinQuery

ISplitIndexRequest

A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

ISplitProcessor

Splits a field into an array using a separator character. Only works on string fields

IStandardAnalyzer

An analyzer of type standard that is built of using Standard Tokenizer, with Standard Token Filter, Lower Case Token Filter, and Stop Token Filter.

IStandardTokenizer

A tokenizer of type standard providing grammar based tokenizer that is a good tokenizer for most European language documents.

The tokenizer implements the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29.

IStatsAggregation

IStatsBucketAggregation

IStemmerOverrideTokenFilter

Overrides stemming algorithms, by applying a custom mapping, then protecting these terms from being modified by stemmers. Must be placed before any stemming filters.

IStemmerTokenFilter

A filter that stems words (similar to snowball, but with more options).

IStopAnalyzer

An analyzer of type stop that is built using a Lower Case Tokenizer, with Stop Token Filter.

IStopTokenFilter

A token filter of type stop that removes stop words from token streams.

IStoredScript

A Stored script

IStringFielddata

IStupidBackoffSmoothingModel

ISuggestBucket

ISuggestContainer

ISuggestContext

ISuggestContextQuery

ISuggestDictionary<T>

ISuggestFuzziness

Fuzziness options for a suggester

ISuggestOption<TDocument>

Suggest option

ISuggest<T>

ISuggester

A suggester that suggests similar looking terms based on a provided text

ISumAggregation

ISumBucketAggregation

ISynonymGraphTokenFilter

The synonym_graph token filter allows to easily handle synonyms, including multi-word synonyms correctly during the analysis process.

ISynonymTokenFilter

The synonym token filter allows to easily handle synonyms during the analysis process.

ITDigestMethod

ITemplate

ITemplateMapping

ITerm

ITermQuery

ITermRangeQuery

ITermSuggester

ITermVectorFilter

Filter terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

ITermVectors

ITermVectorsRequest<TDocument>

ITermsAggregation

ITermsCompositeAggregationSource

A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

ITermsQuery

ITermsSetQuery

ITextEmbeddingProcessor

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

ITextIndexPrefixes

ITextProperty

Text fields are not used for sorting and seldom used for aggregations

ITimestampField

ITokenCountProperty

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

ITokenFilter

ITokenFilters

ITokenizer

ITokenizers

ITopHitsAggregation

ITranslogFlushSettings

ITranslogSettings

ITrimProcessor

Trims whitespace from field. This only works on leading and trailing whitespace

ITrimTokenFilter

The trim token filter trims surrounding whitespaces around a token.

ITruncateTokenFilter

The truncate token filter can be used to truncate tokens into a specific length. This can come in handy with keyword (single token)

based mapped fields that are used for sorting in order to reduce memory usage.

ITypeExistsRequest

ITypeMapping

ITypedSearchRequest

Signals the type to deserialize hits into

IUaxEmailUrlTokenizer

A tokenizer of type uax_url_email which works exactly like the standard tokenizer, but tokenizes emails and urls as single tokens

IUniqueTokenFilter

The unique token filter can be used to only index unique tokens during analysis. By default it is applied on all the token stream

IUpdateByQueryRequest

IUpdateByQueryRequest<TDocument>

IUpdateByQueryRethrottleRequest

IUpdateIndexSettingsRequest

IUpdateRequest<TDocument, TPartialDocument>

IUpdateResponse<TDocument>

IUppercaseProcessor

Converts a string to its uppercase equivalent.

IUppercaseTokenFilter

A token filter of type uppercase that normalizes token text to upper case.

IUriPartsProcessor

IUrlDecodeProcessor

URL-decodes a string

IUserAgentProcessor

The user_agent processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the user_agent field. The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license.

IValidateQueryRequest

IValidateQueryRequest<TDocument>

IValueCountAggregation

IVariableWidthHistogramAggregation

IVerifyRepositoryRequest

IWeightFunction

IWeightedAverageAggregation

IWeightedAverageValue

The configuration for a field or script that provides a value or weight for WeightedAverageAggregation

IWhitespaceAnalyzer

An analyzer of type whitespace that is built using a Whitespace Tokenizer.

IWhitespaceTokenizer

A tokenizer of type whitespace that divides text at whitespace.

IWildcardQuery

IWordDelimiterGraphTokenFilter

Named word_delimiter, it Splits words into subwords and performs optional transformations on subword groups. Unlike the word_delimiter this token filter named word_delimiter_graph correctly handles multi terms expansion at query time.

IWordDelimiterTokenFilter

Named word_delimiter, it Splits words into subwords and performs optional transformations on subword groups.

Enums

AggregationVisitorScope

AllocationEnable

AllocationExplainDecision

AllowRebalance

BoundaryScanner

ChildScoreMode

ClusterStatus

ConvertProcessorType

DFIIndependenceMeasure

IDFISimilarity independence measure

DFRAfterEffect

DFRBasicModel

DateInterval

DateMathOperation

DateMathTimeUnit

DateRounding

Decision

DelimitedPayloadEncoding

DistanceUnit

DiversifiedSamplerAggregationExecutionHint

DynamicMapping

EdgeNGramSide

FieldType

Define the type of field content.

FieldValueFactorModifier

FielddataLoading

FileSystemStorageImplementation

The store module allows you to control how index data is stored and accessed on disk.

FunctionBoostMode

FunctionScoreMode

GapPolicy

GeoDistanceType

GeoExecution

GeoHashPrecision

GeoOrientation

GeoPointFielddataFormat

GeoShapeRelation

GeoStrategy

GeoTilePrecision

GeoTree

GeoValidationMethod

HighlighterEncoder

Indicates if the highlighted text should be HTML encoded

HighlighterFragmenter

Fragmenter can control how text should be broken up in highlight snippets. However, this option is applicable only for the Plain Highlighter

HighlighterOrder

Sorts highlighted fragments

HighlighterTagsSchema

Use a built-in tag schema

HighlighterType

Type of highlighter

HoltWintersType

IBDistribution

IBLambda

IcuCollationAlternate

Sets the alternate handling for strength quaternary to be either shifted or non-ignorable. Which boils down to ignoring punctuation and whitespace.

IcuCollationCaseFirst

Controls which case is sorted first when case is not ignored for strength tertiary. The default depends on the collation.

IcuCollationDecomposition

Setting this decomposition property to canonical allows the Collator to handle unnormalized text properly, producing the same results as if the text were normalized. If no is set, it is the user’s responsibility to insure that all text is already in the appropriate form before a comparison or before getting a CollationKey. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior. Since a great many of the world’s languages do not require text normalization, most locales set no as the default decomposition mode.

Delegates

ConnectionSettings.SourceSerializerFactory

A delegate used to construct a serializer to serialize CLR types representing documents and other types related to documents. By default, the internal serializer will be used to serializer all types.