Package org.opensearch.client.opensearch.indices

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 Classes

Modifier and Type	Class	Description
static class	ResolveIndexRequest.Builder	Builder for ResolveIndexRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ResolveIndexRequest,ResolveIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.resolve_index".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static ResolveIndexRequest.Builder	builder()
boolean	equals(Object o)
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
int	hashCode()
final List<String>	name()	Required - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve.
static ResolveIndexRequest	of(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)
ResolveIndexRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<ResolveIndexRequest,ResolveIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.resolve_index".

Method Details

of

public static ResolveIndexRequest of(Function<ResolveIndexRequest.Builder,ObjectBuilder<ResolveIndexRequest>> fn)

expandWildcards

@Nonnull
public final List<ExpandWildcard> 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 as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

name

@Nonnull
public final List<String> 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

@Nonnull
public ResolveIndexRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ResolveIndexRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object