Skip to content

Commit dc0ff14

Browse files
Add msearch allow_partial_results flag (#1904) (#1905)
* Add msearch allow_partial_results flag * Update changelog * Fix compilation failure --------- Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
1 parent 24e9c49 commit dc0ff14

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
33

44
## [Unreleased 3.x]
55
### Added
6+
- Add msearch `allow_partial_results` flag ([#1904](https://github.com/opensearch-project/opensearch-java/pull/1904))
7+
68

79
### Dependencies
810
- Bump `com.github.jk1.dependency-license-report` from 3.0.1 to 3.1.1 ([#1895](https://github.com/opensearch-project/opensearch-java/pull/1895), [#1896](https://github.com/opensearch-project/opensearch-java/pull/1896))

java-client/src/main/java/org/opensearch/client/opensearch/core/MsearchRequest.java

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ public class MsearchRequest extends RequestBase implements NdJsonpSerializable,
7373
@Nullable
7474
private final Boolean ccsMinimizeRoundtrips;
7575

76+
@Nullable
77+
private final Boolean allowPartialResults;
78+
7679
private final List<ExpandWildcard> expandWildcards;
7780

7881
@Nullable
@@ -104,6 +107,7 @@ private MsearchRequest(Builder builder) {
104107
this.allowNoIndices = builder.allowNoIndices;
105108
this.cancelAfterTimeInterval = builder.cancelAfterTimeInterval;
106109
this.ccsMinimizeRoundtrips = builder.ccsMinimizeRoundtrips;
110+
this.allowPartialResults = builder.allowPartialResults;
107111
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
108112
this.ignoreThrottled = builder.ignoreThrottled;
109113
this.ignoreUnavailable = builder.ignoreUnavailable;
@@ -161,6 +165,16 @@ public final Boolean ccsMinimizeRoundtrips() {
161165
return this.ccsMinimizeRoundtrips;
162166
}
163167

168+
/**
169+
* If true, return partial results if there are shard request timeouts or shard failures.
170+
* <p>
171+
* API name: {@code allow_partial_results}
172+
*/
173+
@Nullable
174+
public final Boolean allowPartialResults() {
175+
return this.allowPartialResults;
176+
}
177+
164178
/**
165179
* Type of index that wildcard expressions can match. If the request can target
166180
* data streams, this argument determines whether wildcard expressions match
@@ -274,6 +288,7 @@ public Builder toBuilder() {
274288
return new Builder().allowNoIndices(allowNoIndices)
275289
.cancelAfterTimeInterval(cancelAfterTimeInterval)
276290
.ccsMinimizeRoundtrips(ccsMinimizeRoundtrips)
291+
.allowPartialResults(allowPartialResults)
277292
.expandWildcards(expandWildcards)
278293
.ignoreThrottled(ignoreThrottled)
279294
.ignoreUnavailable(ignoreUnavailable)
@@ -301,6 +316,9 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder<M
301316
@Nullable
302317
private Boolean ccsMinimizeRoundtrips;
303318

319+
@Nullable
320+
private Boolean allowPartialResults;
321+
304322
@Nullable
305323
private List<ExpandWildcard> expandWildcards;
306324

@@ -373,6 +391,16 @@ public final Builder ccsMinimizeRoundtrips(@Nullable Boolean value) {
373391
return this;
374392
}
375393

394+
/**
395+
* If true, return partial results if there are shard request timeouts or shard failures.
396+
* <p>
397+
* API name: {@code allow_partial_results}
398+
*/
399+
public final Builder allowPartialResults(@Nullable Boolean value) {
400+
this.allowPartialResults = value;
401+
return this;
402+
}
403+
376404
/**
377405
* Type of index that wildcard expressions can match. If the request can target
378406
* data streams, this argument determines whether wildcard expressions match
@@ -611,6 +639,9 @@ public MsearchRequest build() {
611639
if (request.ccsMinimizeRoundtrips != null) {
612640
params.put("ccs_minimize_roundtrips", String.valueOf(request.ccsMinimizeRoundtrips));
613641
}
642+
if (request.allowPartialResults != null) {
643+
params.put("allow_partial_results", String.valueOf(request.allowPartialResults));
644+
}
614645
return params;
615646

616647
},

0 commit comments

Comments
 (0)