UPGRADING.md

UPGRADING

Upgrading 2.x to 3.0

URL Path Encoding

• The default URL path encoding has been changed to be more conservative. Previously the !, $, &, ', (, ), *, +, ,, ;, =, @ and : characters were left un-encoded, they will now be percent-encoded. If you require the previous behavior you can specify the org.opensearch.path.encoding=HTTP_CLIENT_V4_EQUIV system property.

SearchAfter of SearchRequest type

• Changed SearchAfter of SearchRequest type to FieldValue instead of String (#769)
• Consider using FieldValue.of to make string type values compatible.

Before:

.searchAfter("string")
.searchAfter("string1", "string2")
.searchAfter(List.of("String"))

After:

.searchAfter(FieldValue.of("string"))
.searchAfter(FieldValue.of("string1"), FieldValue.of("string2"))
.searchAfter(List.of(FieldValue.of("String")))

DanglingIndex creationDateMillis type

• The type of DanglingIndex's creationDateMillis field has been corrected from a String to a long.

ShardStatistics properties types

• The type of the total, successful and failed fields has been corrected from Number to int.
• The type of the skipped field has been corrected from Number to Integer.

Unified tasks.Info & tasks.State classes into tasks.TaskInfo

• The tasks.Info and tasks.State classes have been unified into tasks.TaskInfo, this affects:
  • TaskExecutingNode's tasks field.
  • GetTasksResponse's task field.
  • core.update_by_query_rethrottle.UpdateByQueryRethrottleNode's tasks field.
• The headers field is now a Map<String, String> instead of a Map<String, List<String>>.

tasks.ListResponse properties lifted to tasks.TaskListResponseBase

• All fields previously defined on tasks.ListResponse have been lifted to tasks.TaskListResponseBase.
• DeleteByQueryRethrottleResponse now extends tasks.TaskListResponseBase instead of tasks.ListResponse.
• The tasks field is now a TaskInfos union type instead of a Map<String, Info> to correctly handle groupBy parents or none.

GetTasksResponse response type

• The type of GetTasksResponse's response field has been changed from tasks.Status to tasks.TaskResponse.

VerifyRepositoryRequest property naming

• The name field, getter and builder method have been renamed to repository.

CleanupRepositoryRequest property naming

• The name field, getter and builder method have been renamed to repository.

CloneSnapshotRequest timeout removal

• The timeout field, getter and builder method have been removed from CloneSnapshotRequest as it is not supported by OpenSearch.

DynamicMapping

• Removed the Runtime variant from the DynamicMapping enum as it is not supported by OpenSearch.

TypeMapping

• Removed the runtime field, getter and builder methods from TypeMapping as it is not supported by OpenSearch.

InlineScript

• The lang property now accepts a ScriptLanguage enum instead of a String.

IcuCollationDecomposition enum variants

• The IcuCollationDecomposition.Identical variant has been corrected to be IcuCollationDecomposition.Canonical.

IcuCollationTokenFilter property name casing

• The following fields, getters and builder methods on IcuCollationTokenFilter have had their casing corrected:
  • casefirst -> caseFirst
  • caselevel -> caseLevel
  • hiraganaquaternarymode -> hiraganaQuaternaryMode
  • variabletop -> variableTop

TokenFilterDefinition

• The smartcn_stop Builder method has been renamed to smartcnStop.

TokenizerDefinition

• The smartcn Builder method has been renamed to smartcnTokenizer.

PointProperty

• PointProperty has been removed and is replaced by XyPointProperty.

PropertyBase

• The name and localMetadata fields, getters and builder methods have been removed from PropertyBase as they are not supported by OpenSearch.

IndexTemplate

• IndexTemplate has been moved from the org.opensearch.client.opensearch.indices.get_index_template package to the org.opensearch.client.opensearch.indices package.
• The dataStream property is now of type IndexTemplateDataStreamConfiguration instead of Map<String, JsonData>.

IndexTemplateSummary

• IndexTemplateSummary has been moved from the org.opensearch.client.opensearch.indices.get_index_template package to the org.opensearch.client.opensearch.indices package.
• The settings property is now of type IndexSettings instead of Map<String, JsonData>.

DataStream renamed to IndexTemplateDataStreamConfiguration

• The DataStream class has been renamed to IndexTemplateDataStreamConfiguration, this affects:
  • PutIndexTemplateRequest's dataStream field.
  • SimulateIndexTemplateRequest's dataStream field.

Translog

• The durability property now accepts a TranslogDurability enum instead of a String.

IndexSettingsMapping

• The mapping limit fields now have specialized types instead of a generic IndexSettingsMappingLimit type:
  • depth is now of type IndexSettingsMappingLimitDepth.
  • fieldNameLength is now of type IndexSettingsMappingLimitFieldNameLength.
  • nestedFields is now of type IndexSettingsMappingLimitNestedFields.
  • nestedObjects is now of type IndexSettingsMappingLimitNestedObjects.
  • totalFields is now of type IndexSettingsMappingLimitTotalFields.

IndexSettings

• The creationDate property is now of type Long instead of String.
• The translogDurability property now accepts a TranslogDurability enum instead of a String.
• The numberOfReplicas property is now of type Integer instead of String.
• The numberOfShards property is now of type Integer instead of String.

BoostingQuery

• The negativeBoost property has been corrected to be of type float instead of double.

DisMaxQuery

• The tieBreaker property has been corrected to be of type Float instead of Double.

FunctionScoreQuery

• The maxBoost property has been corrected to be of type Float instead of Double.
• The minScore property has been corrected to be of type Float instead of Double.

KnnQuery

• The filter property is now of type List<Query> instead of Query.
• The vector property is now of type List<Float> instead of float[].

LikeDocument

• The type property has been removed as it is not supported by OpenSearch as of version 2.0.0.

MatchQuery

• The cutoffFrequency property has been corrected to be of type Float instead of Double.

MoreLikeThisQuery

• The boostTerms property has been corrected to be of type Float instead of Double.

MultiMatchQuery

• The cutoffFrequency property has been corrected to be of type Float instead of Double.
• The tieBreaker property has been corrected to be of type Float instead of Double.

QueryStringQuery

• The phraseSlop property has been corrected to be of type Integer instead of Double.
• The tieBreaker property has been corrected to be of type Float instead of Double.

simulate_template.Template

• The settings property is now of type IndexSettings instead of Map<String, JsonData>.
• The overlapping property has been moved to SimulateTemplateResponse.

PutTemplateRequest

• The flatSettings property has been removed as it is not supported by OpenSearch.
• The timeout property has been removed as it is not supported by OpenSearch.

DataStreamInfo renamed to DataStream

• The DataStreamInfo class has been renamed to DataStream, this affects:
  • GetDataStreamResponse's dataStreams field.
• The generation property is now of type long instead of int.

DataStreamIndexInfo renamed to DataStreamIndex

• The DataStreamIndexInfo class has been renamed to DataStreamIndex, this affects:
  • DataStream's (previously DataStreamInfo) indices field.

RepositorySettings

• The concurrentStreams property is now of type Integer instead of String.

snapshot.RestoreRequest renamed to snapshot.RestoreSnapshotRequest

• The snapshot.RestoreRequest class has been renamed to snapshot.RestoreSnapshotRequest.
• The indexSettings property has been corrected to be of type IndexSettings instead of PutIndicesSettingsRequest.

snapshot.RestoreResponse renamed to snapshot.RestoreSnapshotResponse

• The snapshot.RestoreResponse class has been renamed to snapshot.RestoreSnapshotResponse.

snapshot.Status renamed to snapshot.SnapshotStatus

• The snapshot.Status class has been renamed to snapshot.SnapshotStatus, this affects:
  • snapshot.SnapshotStatusResponse's snapshots field.

snapshot.ShardStats renamed to snapshot.SnapshotShardStats

• The snapshot.ShardStats class has been renamed to snapshot.SnapshotShardStats, this affects:
  • snapshot.SnapshotStatus's (previous snapshot.Status) shardsStats field.
  • snapshot.SnapshotIndexStats's shardsStats field.

snapshot.ShardsStatsStage renamed to snapshot.SnapshotShardsStatsStage

• The snapshot.ShardsStatsStage class has been renamed to snapshot.SnapshotShardsStatsStage, this affects:
  • snapshot.SnapshotShardsStatus's stage field.

snapshot.ShardsStatsSummary renamed to snapshot.SnapshotShardsStatsSummary

• The snapshot.ShardsStatsSummary class has been renamed to snapshot.SnapshotShardsStatsSummary, this affects:
  • snapshot.SnapshotShardsStatus's summary field.

snapshot.ShardsStatsSummaryItem renamed to snapshot.SnapshotShardsStatsSummaryItem

• The snapshot.ShardsStatsSummaryItem class has been renamed to snapshot.SnapshotShardsStatsSummaryItem, this affects:
  • snapshot.SnapshotShardsStatsSummary's (previously snapshot.ShardsStatsSummary) incremental and total fields.

AnalyzeToken

• The endOffset, position, positionLength and startOffset properties have been corrected to be of type int instead of long.

ExplainAnalyzeToken

• The endOffset, position, positionLength, startOffset and termFrequency properties have been corrected to be of type int instead of long.
• The positionlength and termfrequency properties have had their casing corrected to positionLength and termFrequency respectively.

RecoveryBytes

• The recoveredFromSnapshotInBytes, recoveredInBytes, reusedInBytes and totalInBytes properties have been corrected to be of type long instead of String.

RecoveryIndexStatus

• The sourceThrottleTimeInMillis, targetThrottleTimeInMillis and totalTimeInMillis properties have been corrected to be of type long instead of String.

RecoveryOrigin

• The restoreuuid property has had its casing corrected to restoreUuid.

RecoveryStartStatus

• The checkIndexTime property has been corrected to be of type Time instead of long.
• The totalTimeInMillis property has been corrected to be of type long instead of String.

ShardRecovery

• The id property has been corrected to be of type int instead of long.
• The startTimeInMillis, stopTimeInMillis and totalTimeInMillis properties have been corrected to be of type long instead of String.
• The totalTime property has been corrected to be of type Time instead of String.

indices.recovery.TranslogStatus

• The recovered, total and totalOnStart properties have been corrected to be of type int instead of long.
• The totalTime property has been corrected to be of type Time instead of String.
• The totalTimeInMillis property has been corrected to be of type long instead of String.

indices.recovery.VerifyIndex

• The checkIndexTimeInMillis and totalTimeInMillis properties have been corrected to be of type long instead of String.

RolloverRequest

• The mappings property is now of type TypeMapping instead of IndexRolloverMapping.

IndexRolloverMapping

• The IndexRolloverMapping class has been removed.

Segment

• The deletedDocs and numDocs properties have been corrected to be of type int instead of long.
• The memoryInBytes and sizeInBytes properties have been corrected to be of type long instead of double.

ShardStore

• The attributes, id, legacyVersion, name and transportAddress properties have been removed and are now correctly nested within the NodeAttributes under the nodes property map.

FlushStats

• The totalTime property has been corrected to be of type Time instead of String.

GetStats

• The existsTime, missingTime and time properties have been corrected to be of type Time instead of String.

IndexingStats

• The deleteTime, indexTime and throttleTime properties have been corrected to be of type Time instead of String.
• The types property has been removed as it is no longer supported by OpenSearch as of version 2.0.0.

MergesStats

• The totalStoppedTime, totalThrottledTime and totalTime properties have been corrected to be of type Time instead of String.

RecoveryStats

• The throttleTime property has been corrected to be of type Time instead of String.

RefreshStats

• The totalTime property has been corrected to be of type Time instead of String.

SegmentsStats

• The storedMemory property has been renamed to storedFieldsMemory to match the OpenSearch response.

StoreStats

• The totalDataSetSize and totalDataSetSizeInBytes properties have been removed as they are not returned by OpenSearch.

TranslogStats

• The operations property has been corrected to be of type int instead of long.

WarmerStats

• The totalTime property has been corrected to be of type Time instead of String.

IndicesStatsRequest

• The metric property is now of type List<IndicesStatsMetric> instead of List<String>.
• The types property has been removed as it is no longer supported by OpenSearch as of version 2.0.0.

IndicesStatsResponse

• The all property is now of type AllIndicesStats instead of IndicesStats.

ShardStats renamed to IndexShardStats

• The ShardStats class has been renamed to IndexShardStats, this affects:
  • IndicesStats's shards field.