Deprecated API

Contents

• Classes
• Exceptions
• Annotation Types
• Fields
• Methods
• Constructors
• Enum Constants

Classes

Class	Description
org.apache.lucene.queries.ExtendedCommonTermsQuery	Since max_optimization optimization landed in 7.0, normal MatchQuery will achieve the same result without any configuration.
org.opensearch.action.admin.indices.exists.types.TypesExistsRequestBuilder
org.opensearch.action.bulk.TransportSingleItemBulkWriteAction
org.opensearch.action.delete.TransportDeleteAction
org.opensearch.action.index.TransportIndexAction
org.opensearch.client.transport.TransportClient	TransportClient is deprecated in favour of the High Level REST client and will be removed in OpenSearch 1.0.0.
org.opensearch.common.joda.Joda
org.opensearch.common.rounding.Rounding
org.opensearch.index.mapper.LegacyGeoShapeFieldMapper	use GeoShapeFieldMapper
org.opensearch.index.mapper.LegacyGeoShapeFieldMapper.DeprecatedParameters
org.opensearch.index.query.CommonTermsQueryBuilder	Since max_optimization optimization landed in 7.0, normal MatchQuery will achieve the same result without any configuration.

Exceptions

Exceptions	Description
org.opensearch.script.GeneralScriptException	Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g. if thrown from various abstractions)

Annotation Types

Annotation Type	Description
org.opensearch.common.inject.assistedinject.AssistedInject	FactoryProvider now works better with the standard @Inject annotation. When using that annotation, parameters are matched by name and type rather than by position. In addition, values that use the standard @Inject constructor annotation are eligible for method interception.

Fields

Field	Description
org.opensearch.action.support.TransportAction.logger	declare your own logger.
org.opensearch.common.network.NetworkUtils.SUPPORTS_V6	transition mechanism only, do not use
org.opensearch.index.mapper.MapperService.INDEX_MAPPER_DYNAMIC_SETTING
org.opensearch.index.mapper.MapperService.META_FIELDS_BEFORE_7DOT8
org.opensearch.index.query.MatchQueryBuilder.CUTOFF_FREQUENCY_FIELD	Since max_optimization optimization landed in 7.0, normal MatchQuery will achieve the same result without any configuration.
org.opensearch.index.reindex.AbstractBulkByScrollRequest.SIZE_ALL_MATCHES	please use MAX_DOCS_ALL_MATCHES instead.
org.opensearch.rest.BaseRestHandler.logger	declare your own logger.
org.opensearch.search.suggest.completion.CompletionSuggestion.TYPE
org.opensearch.search.suggest.phrase.PhraseSuggestion.TYPE
org.opensearch.search.suggest.term.TermSuggestion.TYPE
org.opensearch.threadpool.ThreadPool.Names.LISTENER

Methods

Method	Description
org.apache.lucene.queries.BlendedTermQuery.commonTermsBlendedQuery(Term[], float[], float)	Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest.types()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.
org.opensearch.action.bulk.BulkProcessor.builder(Client, BulkProcessor.Listener)	Use BulkProcessor.builder(java.util.function.BiConsumer, org.opensearch.action.bulk.BulkProcessor.Listener) with client::bulk as the first argument, or BulkProcessor.builder(org.opensearch.client.Client, org.opensearch.action.bulk.BulkProcessor.Listener, org.opensearch.threadpool.Scheduler, org.opensearch.threadpool.Scheduler, java.lang.Runnable) and manage the flush and retry schedulers explicitly
org.opensearch.action.bulk.BulkRequest.add(byte[], int, int, String, String, XContentType)	use BulkRequest.add(byte[], int, int, String, XContentType) instead
org.opensearch.action.bulk.BulkRequestBuilder.add(byte[], int, int, String, String, XContentType)	use BulkRequestBuilder.add(byte[], int, int, String, XContentType) instead
org.opensearch.action.bulk.BulkRequestParser.parse(BytesReference, String, String, String, FetchSourceContext, String, Boolean, boolean, XContentType, Consumer<IndexRequest>, Consumer<UpdateRequest>, Consumer<DeleteRequest>)	Use BulkRequestParser.parse(BytesReference, String, String, FetchSourceContext, String, Boolean, boolean, XContentType, Consumer, Consumer, Consumer) instead.
org.opensearch.action.delete.DeleteRequest.defaultTypeIfNull(String)	Types are in the process of being removed.
org.opensearch.action.delete.DeleteRequest.type()	Types are in the process of being removed.
org.opensearch.action.DocWriteResponse.getType()	Types are in the process of being removed.
org.opensearch.action.explain.ExplainRequest.type()	Types are in the process of being removed.
org.opensearch.action.explain.ExplainResponse.getType()	Types are in the process of being removed.
org.opensearch.action.get.GetRequest.type(String)	Types are in the process of being removed.
org.opensearch.action.get.GetResponse.iterator()	Use GetResponse.getSource() instead
org.opensearch.action.get.MultiGetRequest.add(String, String, String)	Types are in the process of being removed, use MultiGetRequest.add(String, String) instead.
org.opensearch.action.index.IndexRequest.defaultTypeIfNull(String)	Types are in the process of being removed.
org.opensearch.action.index.IndexRequest.type()	Types are in the process of being removed.
org.opensearch.action.search.SearchRequest.types()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.
org.opensearch.action.search.SearchRequestBuilder.setTypes(String...)	Types are going away, prefer filtering on a field.
org.opensearch.action.termvectors.MultiTermVectorsResponse.Failure.getType()	Types are in the process of being removed.
org.opensearch.action.termvectors.TermVectorsRequest.doc(BytesReference, boolean)	use TermVectorsRequest.doc(BytesReference, boolean, XContentType) to avoid content auto detection
org.opensearch.action.update.UpdateRequest.addScriptParam(String, Object)	Use UpdateRequest.script(Script) instead
org.opensearch.action.update.UpdateRequest.defaultTypeIfNull(String)	Types are in the process of being removed.
org.opensearch.action.update.UpdateRequest.script(String, ScriptType)	Use UpdateRequest.script(Script) instead
org.opensearch.action.update.UpdateRequest.scriptLang(String)	Use UpdateRequest.script(Script) instead
org.opensearch.action.update.UpdateRequest.scriptParams()	Use UpdateRequest.script() instead
org.opensearch.action.update.UpdateRequest.scriptString()	Use UpdateRequest.script() instead
org.opensearch.action.update.UpdateRequest.scriptType()	Use UpdateRequest.script() instead
org.opensearch.action.update.UpdateRequest.type()	Types are in the process of being removed.
org.opensearch.client.IndicesAdminClient.prepareTypesExists(String...)	Types are deprecated and are in the process of being removed.
org.opensearch.client.IndicesAdminClient.typesExists(TypesExistsRequest)	Types are deprecated and are in the process of being removed.
org.opensearch.cluster.metadata.IndexMetadata.getMappings()	Use IndexMetadata.mapping() instead now that indices have a single type
org.opensearch.common.network.NetworkUtils.sortAddresses(List<InetAddress>)	remove this when multihoming is really correct
org.opensearch.common.Rounding.nextRoundingValue(long)	Prefer Rounding.prepare(long, long) and then Rounding.Prepared.nextRoundingValue(long)
org.opensearch.common.Rounding.offset()	We're in the process of abstracting offset *into* Rounding so keep any usage to migratory shims
org.opensearch.common.Rounding.round(long)	Prefer Rounding.prepare(long, long) and then Rounding.Prepared.round(long)
org.opensearch.common.time.DateMathParser.parse(String, LongSupplier, boolean, DateTimeZone)
org.opensearch.common.unit.ByteSizeValue.bytesAsInt()
org.opensearch.common.xcontent.XContentHelper.convertToJson(BytesReference, boolean)
org.opensearch.common.xcontent.XContentHelper.convertToMap(BytesReference, boolean)	this method relies on auto-detection of content type. Use XContentHelper.convertToMap(BytesReference, boolean, XContentType) instead with the proper XContentType
org.opensearch.common.xcontent.XContentHelper.createParser(NamedXContentRegistry, DeprecationHandler, BytesReference)	use XContentHelper.createParser(NamedXContentRegistry, DeprecationHandler, BytesReference, XContentType) to avoid content type auto-detection
org.opensearch.common.xcontent.XContentHelper.writeRawField(String, BytesReference, XContentBuilder, ToXContent.Params)	use XContentHelper.writeRawField(String, BytesReference, XContentType, XContentBuilder, Params) to avoid content type auto-detection
org.opensearch.common.xcontent.XContentHelper.xContentType(BytesReference)	the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.
org.opensearch.ExceptionsHelper.detailedMessage(Throwable)	Don't swallow exceptions, allow them to propagate.
org.opensearch.index.IndexSettings.getMaxAdjacencyMatrixFilters()	This setting will be removed in 8.0
org.opensearch.index.mapper.GeoShapeQueryable.geoShapeQuery(Geometry, String, SpatialStrategy, ShapeRelation, QueryShardContext)
org.opensearch.index.query.AbstractGeometryQueryBuilder.indexedShapeType()	Types are in the process of being removed.
org.opensearch.index.query.IdsQueryBuilder.types(String...)	Types are in the process of being removed, prefer to filter on a field instead.
org.opensearch.index.query.MatchQueryBuilder.cutoffFrequency(float)	see MatchQueryBuilder.CUTOFF_FREQUENCY_FIELD for more details
org.opensearch.index.query.MoreLikeThisQueryBuilder.Item.type()	Types are in the process of being removed.
org.opensearch.index.query.MultiMatchQueryBuilder.cutoffFrequency(float)	Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.
org.opensearch.index.query.QueryBuilders.commonTermsQuery(String, Object)	See CommonTermsQueryBuilder
org.opensearch.index.query.QueryBuilders.geoDisjointQuery(String, ShapeBuilder)	use QueryBuilders.geoDisjointQuery(String, Geometry) instead
org.opensearch.index.query.QueryBuilders.geoIntersectionQuery(String, ShapeBuilder)	use QueryBuilders.geoIntersectionQuery(String, Geometry) instead
org.opensearch.index.query.QueryBuilders.geoShapeQuery(String, ShapeBuilder)	use QueryBuilders.geoShapeQuery(String, Geometry) instead
org.opensearch.index.query.QueryBuilders.geoWithinQuery(String, ShapeBuilder)	use QueryBuilders.geoWithinQuery(String, Geometry) instead
org.opensearch.index.query.QueryBuilders.idsQuery(String...)	Types are in the process of being removed, use QueryBuilders.idsQuery() instead.
org.opensearch.index.query.QueryBuilders.typeQuery(String)	Types are going away, prefer filtering on a field.
org.opensearch.index.reindex.AbstractBulkByScrollRequest.getSize()	please use getMaxDocs() instead.
org.opensearch.index.reindex.AbstractBulkByScrollRequest.setSize(int)	please use setMaxDocs(int) instead.
org.opensearch.index.reindex.AbstractBulkByScrollRequestBuilder.size(int)	please use maxDocs(int) instead.
org.opensearch.index.reindex.DeleteByQueryRequest.getDocTypes()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.
org.opensearch.index.reindex.DeleteByQueryRequest.setDocTypes(String...)	Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.
org.opensearch.index.reindex.DeleteByQueryRequest.types()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.
org.opensearch.index.reindex.ReindexRequest.addSortField(String, SortOrder)	Specifying a sort field for reindex is deprecated. If using this in combination with maxDocs, consider using a query filter instead.
org.opensearch.index.reindex.UpdateByQueryRequest.getDocTypes()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.
org.opensearch.index.reindex.UpdateByQueryRequest.setDocTypes(String...)	Types are in the process of being removed. Instead of using a type, prefer to filter on a field of the document.
org.opensearch.index.search.MatchQuery.setCommonTermsCutoff(Float)	See MatchQuery.setCommonTermsCutoff(Float) for more details
org.opensearch.indices.TermsLookup.type()	Types are in the process of being removed.
org.opensearch.plugins.SearchPlugin.PipelineAggregationSpec.getAggregatorReader()	Pipelines implemented after 7.8.0 do not need to be sent across the wire
org.opensearch.repositories.Repository.initializeSnapshot(SnapshotId, List<IndexId>, Metadata)	this method is only used when taking snapshots in a mixed version cluster where a master node older than SnapshotsService.NO_REPO_INITIALIZE_VERSION is present.
org.opensearch.script.JodaCompatibleZonedDateTime.getCenturyOfEra()
org.opensearch.script.JodaCompatibleZonedDateTime.getDayOfWeek()
org.opensearch.script.JodaCompatibleZonedDateTime.getEra()
org.opensearch.script.JodaCompatibleZonedDateTime.getHourOfDay()
org.opensearch.script.JodaCompatibleZonedDateTime.getMillis()
org.opensearch.script.JodaCompatibleZonedDateTime.getMillisOfDay()
org.opensearch.script.JodaCompatibleZonedDateTime.getMillisOfSecond()
org.opensearch.script.JodaCompatibleZonedDateTime.getMinuteOfDay()
org.opensearch.script.JodaCompatibleZonedDateTime.getMinuteOfHour()
org.opensearch.script.JodaCompatibleZonedDateTime.getMonthOfYear()
org.opensearch.script.JodaCompatibleZonedDateTime.getSecondOfDay()
org.opensearch.script.JodaCompatibleZonedDateTime.getSecondOfMinute()
org.opensearch.script.JodaCompatibleZonedDateTime.getWeekOfWeekyear()
org.opensearch.script.JodaCompatibleZonedDateTime.getWeekyear()
org.opensearch.script.JodaCompatibleZonedDateTime.getYearOfCentury()
org.opensearch.script.JodaCompatibleZonedDateTime.getYearOfEra()
org.opensearch.script.JodaCompatibleZonedDateTime.toString(String)
org.opensearch.search.aggregations.bucket.BucketsAggregator.mergeBuckets(long[], long)	use BucketsAggregator.mergeBuckets(long,java.util.function.LongUnaryOperator)
org.opensearch.search.aggregations.bucket.composite.DateHistogramValuesSourceBuilder.dateHistogramInterval()
org.opensearch.search.aggregations.bucket.composite.DateHistogramValuesSourceBuilder.interval()
org.opensearch.search.aggregations.bucket.histogram.DateHistogramAggregationBuilder.dateHistogramInterval()
org.opensearch.search.aggregations.bucket.histogram.DateHistogramAggregationBuilder.interval()
org.opensearch.search.aggregations.bucket.histogram.DateIntervalConsumer.dateHistogramInterval(DateHistogramInterval)
org.opensearch.search.aggregations.bucket.histogram.DateIntervalConsumer.interval(long)
org.opensearch.search.aggregations.bucket.histogram.DateIntervalWrapper.dateHistogramInterval()
org.opensearch.search.aggregations.bucket.histogram.DateIntervalWrapper.interval()
org.opensearch.search.aggregations.bucket.MergingBucketsDeferringCollector.mergeBuckets(long[])	use MergingBucketsDeferringCollector.mergeBuckets(java.util.function.LongUnaryOperator)
org.opensearch.search.aggregations.InternalAggregation.pipelineAggregatorsForBwcSerialization()	only use these for serializing to older OpenSearch versions
org.opensearch.search.aggregations.InternalAggregations.getTopLevelPipelineAggregators()	these only exist for BWC serialization
org.opensearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder.compression(double)
org.opensearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder.method(PercentilesMethod)
org.opensearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder.numberOfSignificantValueDigits(int)
org.opensearch.search.aggregations.metrics.PercentilesConfig.fromLegacy(PercentilesMethod, double, int)
org.opensearch.search.aggregations.pipeline.PipelineAggregator.doWriteTo(StreamOutput)	pipeline aggregations added after 7.8.0 don't need to implement this
org.opensearch.search.aggregations.pipeline.PipelineAggregator.getWriteableName()	pipeline aggregations added after 7.8.0 don't need to implement this
org.opensearch.search.aggregations.pipeline.PipelineAggregator.writeTo(StreamOutput)	pipeline aggregations added after 7.8.0 shouldn't call this
org.opensearch.search.aggregations.PipelineAggregatorBuilders.movingAvg(String, String)	use PipelineAggregatorBuilders.movingFunction(String, Script, String, int) instead
org.opensearch.search.SearchHit.getType()	Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.
org.opensearch.search.sort.FieldSortBuilder.getNestedFilter()	set nested sort with FieldSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with FieldSortBuilder.getNestedSort()
org.opensearch.search.sort.FieldSortBuilder.getNestedPath()	set nested sort with FieldSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with FieldSortBuilder.getNestedSort()
org.opensearch.search.sort.FieldSortBuilder.setNestedFilter(QueryBuilder)	set nested sort with FieldSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with FieldSortBuilder.getNestedSort()
org.opensearch.search.sort.FieldSortBuilder.setNestedPath(String)	set nested sort with FieldSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with FieldSortBuilder.getNestedSort()
org.opensearch.search.sort.GeoDistanceSortBuilder.getNestedFilter()	set nested sort with GeoDistanceSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with GeoDistanceSortBuilder.getNestedSort()
org.opensearch.search.sort.GeoDistanceSortBuilder.getNestedPath()	set nested sort with GeoDistanceSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with GeoDistanceSortBuilder.getNestedSort()
org.opensearch.search.sort.GeoDistanceSortBuilder.setNestedFilter(QueryBuilder)	set nested sort with GeoDistanceSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with GeoDistanceSortBuilder.getNestedSort()
org.opensearch.search.sort.GeoDistanceSortBuilder.setNestedPath(String)	set nested sort with GeoDistanceSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with GeoDistanceSortBuilder.getNestedSort()
org.opensearch.search.sort.ScriptSortBuilder.getNestedFilter()	set nested sort with ScriptSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with ScriptSortBuilder.getNestedSort()
org.opensearch.search.sort.ScriptSortBuilder.getNestedPath()	set nested sort with ScriptSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with ScriptSortBuilder.getNestedSort()
org.opensearch.search.sort.ScriptSortBuilder.setNestedFilter(QueryBuilder)	set nested sort with ScriptSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with ScriptSortBuilder.getNestedSort()
org.opensearch.search.sort.ScriptSortBuilder.setNestedPath(String)	set nested sort with ScriptSortBuilder.setNestedSort(NestedSortBuilder) and retrieve with ScriptSortBuilder.getNestedSort()
org.opensearch.search.suggest.Suggest.Suggestion.getWriteableType()

Constructors

Constructor	Description
org.opensearch.action.bulk.BulkRequest(String, String)	Types are in the process of being removed. Use BulkRequest(String) instead
org.opensearch.action.bulk.BulkRequestBuilder(OpenSearchClient, BulkAction, String, String)	use BulkRequestBuilder(OpenSearchClient, BulkAction, String) instead
org.opensearch.action.delete.DeleteRequest(String, String, String)	Types are in the process of being removed. Use DeleteRequest(String, String) instead.
org.opensearch.action.explain.ExplainRequest(String, String, String)	Types are in the process of being removed. Use instead.
org.opensearch.action.get.GetRequest(String, String, String)	Types are in the process of being removed, use GetRequest(java.lang.String,java.lang.String) instead.
org.opensearch.action.get.MultiGetRequest.Item(String, String, String)	Types are in the process of being removed, use instead.
org.opensearch.action.index.IndexRequest(String, String)	Types are in the process of being removed. Use IndexRequest(String) instead.
org.opensearch.action.update.UpdateRequest(String, String, String)	Types are in the process of being removed. Use UpdateRequest(String, String) instead.
org.opensearch.common.settings.SecureString(String)	Only use for compatibility between deprecated string settings and new secure strings
org.opensearch.index.query.AbstractGeometryQueryBuilder(String, ShapeBuilder)	use AbstractGeometryQueryBuilder(String, Geometry) instead
org.opensearch.index.query.CommonTermsQueryBuilder(String, Object)	See CommonTermsQueryBuilder for more details.
org.opensearch.index.query.GeoShapeQueryBuilder(String, ShapeBuilder)	use GeoShapeQueryBuilder(String, Geometry) instead
org.opensearch.index.query.MoreLikeThisQueryBuilder.Item(String, String, String)	Types are in the process of being removed, use Item(java.lang.String,java.lang.String) instead.
org.opensearch.indices.TermsLookup(String, String, String, String)	Types are in the process of being removed, use TermsLookup(java.lang.String,java.lang.String,java.lang.String) instead.
org.opensearch.plugins.SearchPlugin.AggregationSpec(ParseField, Writeable.Reader<? extends AggregationBuilder>, Aggregator.Parser)	Use the ctor that takes a ContextParser instead
org.opensearch.plugins.SearchPlugin.PipelineAggregationSpec(ParseField, Writeable.Reader<? extends PipelineAggregationBuilder>, Writeable.Reader<? extends PipelineAggregator>, ContextParser<String, ? extends PipelineAggregationBuilder>)	Use PipelineAggregationSpec(ParseField, Writeable.Reader, ContextParser) for pipelines implemented after 7.8.0
org.opensearch.search.aggregations.pipeline.PipelineAggregator(StreamInput)	pipeline aggregations added after 7.8.0 shouldn't call this

Enum Constants

Enum Constant	Description
org.opensearch.index.translog.Translog.Operation.Type.CREATE