Class ResolveIndexRequest
java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.ResolveIndexRequest
- All Implemented Interfaces:
ToCopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class ResolveIndexRequest
extends RequestBase
implements ToCopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>
Returns information about any matching indexes, aliases, and data streams.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Endpoint<ResolveIndexRequest, ResolveIndexResponse, ErrorResponse> Endpoint "indices.resolve_index". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) static ResolveIndexRequest.Builderbuilder()booleanfinal List<ExpandWildcard> Type of index that wildcard patterns can match.inthashCode()name()Required - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve.static ResolveIndexRequestCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_ENDPOINT
Endpoint "indices.resolve_index".
-
-
Method Details
-
of
public static ResolveIndexRequest of(Function<ResolveIndexRequest.Builder, ObjectBuilder<ResolveIndexRequest>> fn) -
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. Valid values are:all,open,closed,hidden,none.API name:
expand_wildcards -
name
Required - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the<cluster>:<name>syntax.API name:
name -
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest> - Returns:
- a new builder instance.
-
builder
-
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-