Class MultisearchHeader
java.lang.Object
co.elastic.clients.elasticsearch.core.msearch.MultisearchHeader
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MultisearchHeader extends java.lang.Object implements JsonpSerializable
Contains parameters used to limit or change the subsequent search body
request.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MultisearchHeader.Builder
Builder forMultisearchHeader
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<MultisearchHeader>
_DESERIALIZER
Json deserializer forMultisearchHeader
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
API name:allow_no_indices
java.lang.Boolean
allowPartialSearchResults()
API name:allow_partial_search_results
java.lang.Boolean
ccsMinimizeRoundtrips()
API name:ccs_minimize_roundtrips
java.util.List<ExpandWildcard>
expandWildcards()
API name:expand_wildcards
java.lang.Boolean
ignoreThrottled()
API name:ignore_throttled
java.lang.Boolean
ignoreUnavailable()
API name:ignore_unavailable
java.util.List<java.lang.String>
index()
API name:index
static MultisearchHeader
of(java.util.function.Function<MultisearchHeader.Builder,ObjectBuilder<MultisearchHeader>> fn)
java.lang.String
preference()
API name:preference
java.lang.Boolean
requestCache()
API name:request_cache
java.lang.String
routing()
API name:routing
SearchType
searchType()
API name:search_type
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupMultisearchHeaderDeserializer(ObjectDeserializer<MultisearchHeader.Builder> op)
java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forMultisearchHeader
-
-
Method Details
-
of
public static MultisearchHeader of(java.util.function.Function<MultisearchHeader.Builder,ObjectBuilder<MultisearchHeader>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean allowNoIndices()API name:allow_no_indices
-
expandWildcards
API name:expand_wildcards
-
index
public final java.util.List<java.lang.String> index()API name:index
-
preference
@Nullable public final java.lang.String preference()API name:preference
-
requestCache
@Nullable public final java.lang.Boolean requestCache()API name:request_cache
-
routing
@Nullable public final java.lang.String routing()API name:routing
-
searchType
API name:search_type
-
ccsMinimizeRoundtrips
@Nullable public final java.lang.Boolean ccsMinimizeRoundtrips()API name:ccs_minimize_roundtrips
-
allowPartialSearchResults
@Nullable public final java.lang.Boolean allowPartialSearchResults()API name:allow_partial_search_results
-
ignoreThrottled
@Nullable public final java.lang.Boolean ignoreThrottled()API name:ignore_throttled
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupMultisearchHeaderDeserializer
protected static void setupMultisearchHeaderDeserializer(ObjectDeserializer<MultisearchHeader.Builder> op)
-