Skip to content

Commit d6fe751

Browse files
committed
Merge pull request #17243 from colings86/docs/searchRequestBreakingChanges
added breaking changes for the Java API to the breaking changes doc for 5.0
2 parents 8004c51 + 25c4446 commit d6fe751

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

docs/reference/migration/migrate_5_0/java.asciidoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,58 @@ The `addSuggestion` method now required the user specified suggestion name, prev
225225
===== SuggestionBuilder
226226

227227
The `field` setter has been deleted. Instead the field name needs to be specified as constructor argument.
228+
229+
==== SearchSourceBuilder
230+
231+
All methods which take an `XContentBuilder`, `BytesReference` `Map<String, Object>` or `bytes[]` have been removed in favor of providing the
232+
relevant builder object for that feature (e.g. `HighlightBuilder`, `AggregationBuilder`, `SuggestBuilder`) . This means that all search requests
233+
can now be validated at call time which results in much clearer errors.
234+
235+
The `defaultResourceWindowSize(int)` method has been removed. The window size should be set explicitly on all `RescoreBuilder` objects.
236+
237+
==== SearchRequestBuilder
238+
239+
All methods which take an `XContentBuilder`, `BytesReference` `Map<String, Object>` or `bytes[]` have been removed in favor of providing the
240+
relevant builder object for that feature (e.g. `HighlightBuilder`, `AggregationBuilder`, `SuggestBuilder`) . This means that all search requests
241+
can now be validated at call time which results in much clearer errors.
242+
243+
All highlighter methods have been removed in favor of a single `highlighter(HighlightBuilder)` method.
244+
245+
The `setExtraSource(SearchSourceBuilder)` method has been removed.
246+
247+
The `setTemplateSource(String)` and `setTemplateSource(BytesReference)` methods have been removed. Use `setTemplate(Template)` instead.
248+
249+
`setRescorer(Rescorer)` and `setRescorer(Rescorer, int)` have been removed infavor of `setRescorer(RescoreBuilder)` and `setRescorer(RescoreBuilder, int)`
250+
251+
==== SearchRequest
252+
253+
All `template` methods have been removed in favor of a single `template(Template)` method.
254+
255+
All `source` methods have been removed in favor of a single `source(SearchSourceBuilder)` method. This means that all search requests can now be validated
256+
at call time which results in much clearer errors.
257+
258+
All `extraSource` methods have been removed.
259+
260+
==== AggregationBuilder
261+
262+
All methods which take an `XContentBuilder`, `BytesReference` `Map<String, Object>` or `bytes[]` have been removed in favor of providing the
263+
relevant builder object (i.e. `subAggregation(AggregationBuilder)` or `subAggregation(PipelineAggregationBuilder)`). This means that all
264+
requests can now be validated at call time which results in much clearer errors.
265+
266+
==== ValidateQueryRequest
267+
268+
`source(QuerySourceBuilder)`, `source(Map)`, `source(XContentBuilder)`, `source(String)`, `source(byte[])`, `source(byte[], int, int)`,
269+
`source(BytesReference)` and `source()` have been removed in favor of using `query(QueryBuilder<?>)` and `query()`
270+
271+
==== ValidateQueryRequestBuilder
272+
273+
`setSource()` methods have been removed in favor of using `setQuery(QueryBuilder<?>)`
274+
275+
==== ExplainRequest
276+
277+
`source(QuerySourceBuilder)`, `source(Map)`, `source(BytesReference)` and `source()` have been removed in favor of using
278+
`query(QueryBuilder<?>)` and `query()`
279+
280+
==== ExplainRequestBuilder
281+
282+
The `setQuery(BytesReference)` method have been removed in favor of using `setQuery(QueryBuilder<?>)`

0 commit comments

Comments
 (0)