Class IndicesOptions
java.lang.Object
co.elastic.clients.elasticsearch._types.IndicesOptions
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndicesOptions extends java.lang.Object implements JsonpSerializable
Controls how to deal with unavailable concrete indices (closed or missing),
how wildcard expressions are expanded to actual indices (all, closed or open
indices) and how to deal with wildcard expressions that resolve to no
indices.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndicesOptions.Builder
Builder forIndicesOptions
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<IndicesOptions>
_DESERIALIZER
Json deserializer forIndicesOptions
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
If false, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.java.util.List<ExpandWildcard>
expandWildcards()
Type of index that wildcard patterns can match.java.lang.Boolean
ignoreThrottled()
If true, concrete, expanded or aliased indices are ignored when frozen.java.lang.Boolean
ignoreUnavailable()
If true, missing or closed indices are not included in the response.static IndicesOptions
of(java.util.function.Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)
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
setupIndicesOptionsDeserializer(ObjectDeserializer<IndicesOptions.Builder> op)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forIndicesOptions
-
-
Method Details
-
of
public static IndicesOptions of(java.util.function.Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean allowNoIndices()If false, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
expandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such asopen,hidden
.API name:
expand_wildcards
-
ignoreThrottled
@Nullable public final java.lang.Boolean ignoreThrottled()If true, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupIndicesOptionsDeserializer
protected static void setupIndicesOptionsDeserializer(ObjectDeserializer<IndicesOptions.Builder> op)
-