Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions docs/release-notes/9-5-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
navigation_title: "9.5.0"
---
# Elasticsearch Java Client 9.5.0 [elasticsearch-java-client-950]

Discover what changed in the 9.5.0 version of the Java client.

## Breaking changes [elasticsearch-java-client-950-breaking-changes]

This version presents many updates to existing fields that were wrongly mapped, or incomplete. Here is the complete list of changes:

::::{dropdown} From single value to union type

Some fields have been remapped to tagged unions to correctly represent that they can accept more than one shape.

- elasticsearch._types.mapping.DocValuesPropertyBase
- `docValues`: modified from `Boolean` to `elasticsearch._types.mapping.DocValues`, now a union of a simple `Boolean` (`enabled`) or a `DocValuesConfig` object (`config`)

- elasticsearch.inference.RerankRequest
- `input`: modified from `List<String>` to `elasticsearch.inference.rerank.RerankInput`, now a union of a list of strings (`string`) or a list of objects (`object`)
- `query`: modified from `String` to `elasticsearch.inference.rerank.RerankQuery`, now a union of a simple string (`string`) or an object (`object`)

Check notice on line 21 in docs/release-notes/9-5-0.md

View workflow job for this annotation

GitHub Actions / build / vale

Elastic.WordChoice: Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI.
::::

::::{dropdown} Snapshot source-only repository remapping

`SourceOnlyRepositorySettings` is now a tagged union discriminated by `delegate_type`: choosing a delegate type (`azure`, `gcs`, `url`, `s3` or `fs`) makes its own settings available.

- elasticsearch.snapshot.SourceOnlyRepositorySettings: now a tagged union (`azure`, `gcs`, `url`, `s3`, `fs`)

For example, to register a source-only repository delegating to a shared file system (`fs`):

```java
esClient.snapshot().createRepository(r -> r
.name("my_src_only_repository")
.repository(repo -> repo
.source(source -> source
.settings(settings -> settings
.fs(fs -> fs
.location("my_backup_repository")
)
)
)
)
);
```
::::

::::{dropdown} Watcher fixes

Most of the watcher types were outdated and wrongly mapped. The following changes bring them in line with the actual API:

- elasticsearch.watcher.ExecutionResultCondition
- `status`: modified from `elasticsearch.watcher.ActionStatusOptions` to `elasticsearch.watcher.ExecutionResultStatus`

- elasticsearch.watcher.ExecutionResultInput
- `status`: modified from `elasticsearch.watcher.ActionStatusOptions` to `elasticsearch.watcher.ExecutionResultStatus`

- elasticsearch.watcher.IndexResult
- `response`: modified from `elasticsearch.watcher.IndexResultSummary` to `List<IndexResultSummary>`. `IndexResult` is now a union that can hold either the `response` of an executed index action or the `request` that would have run when the action is simulated

- elasticsearch.watcher.IndexResultSummary
- `created`: modified from `boolean` to `Boolean`, now optional
- `version`: modified from `long` to `Long`, now optional

- elasticsearch.watcher.SearchInputRequestBody: **removed**

- elasticsearch.watcher.SearchInputRequestDefinition
- `body`: modified from `elasticsearch.watcher.SearchInputRequestBody` to `elasticsearch.core.search.SearchRequestBody`
::::

::::{dropdown} Other changes

- elasticsearch._types.analysis.SynonymTokenFilterBase
- `synonymsSet`: modified from `String` to `List<String>`, now required

- elasticsearch.cluster.stats.DenseVectorOffHeapStats
- `totalCenifSizeBytes`: renamed to `totalCenivfSizeBytes`
- `totalCenifSize`: renamed to `totalCenivfSize`

- elasticsearch.indices.stats.ShardStats
- `indices`: modified from `elasticsearch.indices.stats.IndicesStats` to `Map<String, ShardStats>`, now required

- elasticsearch.inference.EmbeddingContentObject
- `content`: modified from `elasticsearch.inference.EmbeddingContentObjectContents` to `List<EmbeddingContentObjectItem>`

- elasticsearch.inference.EmbeddingContentObjectContents: **removed**

- elasticsearch.security.Role
- `indices`: modified from `List<IndicesPrivileges>` to `List<IndicesPrivilegesRead>`

- elasticsearch._types.mapping.SourceField
- `compress`: **removed**
- `compressThreshold`: **removed**
::::

## Features and enhancements [elasticsearch-java-client-950-features-enhancements]

Nothing was added in this version of the client.

## Deprecations [elasticsearch-java-client-950-deprecations]

Nothing was deprecated in this version of the client.
3 changes: 3 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ To check for security updates, refer to [Security announcements for the Elastic

To check for issues, refer to [Known issues](../release-notes/known-issues.md).

## 9.5.0
[Release notes](../release-notes/9-5-0.md)

## 9.4.0
[Release notes](../release-notes/9-4-0.md)

Expand Down
1 change: 1 addition & 0 deletions docs/release-notes/toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
toc:
- file: index.md
- file: known-issues.md
- file: 9-5-0.md
- file: 9-4-0.md
- file: 9-3-0.md
- file: 9-2-0.md
Expand Down
Loading