Class MsearchTemplateRequest.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.core.MsearchTemplateRequest.Builder
-
- All Implemented Interfaces:
ObjectBuilder<MsearchTemplateRequest>
- Enclosing class:
- MsearchTemplateRequest
public static class MsearchTemplateRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<MsearchTemplateRequest>
Builder forMsearchTemplateRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MsearchTemplateRequestbuild()Builds aMsearchTemplateRequest.MsearchTemplateRequest.BuilderccsMinimizeRoundtrips(java.lang.Boolean value)Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionMsearchTemplateRequest.Builderindex(java.lang.String value, java.lang.String... values)A comma-separated list of index names to use as defaultMsearchTemplateRequest.Builderindex(java.util.List<java.lang.String> list)A comma-separated list of index names to use as defaultMsearchTemplateRequest.BuildermaxConcurrentSearches(java.lang.Long value)Controls the maximum number of concurrent searches the multi search api will executeMsearchTemplateRequest.BuildersearchTemplates(java.util.function.Function<RequestItem.Builder,ObjectBuilder<RequestItem>> fn)Required - Request body.MsearchTemplateRequest.BuildersearchTemplates(java.util.List<RequestItem> list)Required - Request body.MsearchTemplateRequest.BuildersearchTemplates(RequestItem value, RequestItem... values)Required - Request body.MsearchTemplateRequest.BuildersearchType(SearchType value)Search operation type-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
ccsMinimizeRoundtrips
public final MsearchTemplateRequest.Builder ccsMinimizeRoundtrips(@Nullable java.lang.Boolean value)
Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionAPI name:
ccs_minimize_roundtrips
-
index
public final MsearchTemplateRequest.Builder index(java.util.List<java.lang.String> list)
A comma-separated list of index names to use as defaultAPI name:
indexAdds all elements of
listtoindex.
-
index
public final MsearchTemplateRequest.Builder index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names to use as defaultAPI name:
indexAdds one or more values to
index.
-
maxConcurrentSearches
public final MsearchTemplateRequest.Builder maxConcurrentSearches(@Nullable java.lang.Long value)
Controls the maximum number of concurrent searches the multi search api will executeAPI name:
max_concurrent_searches
-
searchType
public final MsearchTemplateRequest.Builder searchType(@Nullable SearchType value)
Search operation typeAPI name:
search_type
-
searchTemplates
public final MsearchTemplateRequest.Builder searchTemplates(java.util.List<RequestItem> list)
Required - Request body.API name:
_value_bodyAdds all elements of
listtosearchTemplates.
-
searchTemplates
public final MsearchTemplateRequest.Builder searchTemplates(RequestItem value, RequestItem... values)
Required - Request body.API name:
_value_bodyAdds one or more values to
searchTemplates.
-
searchTemplates
public final MsearchTemplateRequest.Builder searchTemplates(java.util.function.Function<RequestItem.Builder,ObjectBuilder<RequestItem>> fn)
Required - Request body.API name:
_value_bodyAdds a value to
searchTemplatesusing a builder lambda.
-
build
public MsearchTemplateRequest build()
Builds aMsearchTemplateRequest.- Specified by:
buildin interfaceObjectBuilder<MsearchTemplateRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-