Package org.opensearch.client.opensearch.indices

Class ResolveIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ResolveIndexRequest.Builder>

org.opensearch.client.opensearch.indices.ResolveIndexRequest.Builder

All Implemented Interfaces:

CopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>, MutableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>, ObjectBuilder<ResolveIndexRequest>

Enclosing class:

ResolveIndexRequest

public static class ResolveIndexRequest.Builder
extends RequestBase.AbstractBuilder<ResolveIndexRequest.Builder>
implements CopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>

Builder for ResolveIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ResolveIndexRequest	build()	Builds a ResolveIndexRequest.
ResolveIndexRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ResolveIndexRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final ResolveIndexRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final ResolveIndexRequest.Builder	name(String value, String... values)	Required - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve.
final ResolveIndexRequest.Builder	name(List<String> list)	Required - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve.
protected ResolveIndexRequest.Builder	self()

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ResolveIndexRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ResolveIndexRequest.Builder,ResolveIndexRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ResolveIndexRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ResolveIndexRequest.Builder>

expandWildcards

@Nonnull
public final ResolveIndexRequest.Builder expandWildcards(List<ExpandWildcard> list)

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

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final ResolveIndexRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

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

Adds one or more values to expandWildcards.

name

@Nonnull
public final ResolveIndexRequest.Builder name(List<String> list)

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

Adds all elements of list to name.

name

@Nonnull
public final ResolveIndexRequest.Builder name(String value,
 String... values)

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

Adds one or more values to name.

build

@Nonnull
public ResolveIndexRequest build()

Builds a ResolveIndexRequest.

Specified by:

build in interface ObjectBuilder<ResolveIndexRequest>

Throws:

NullPointerException - if some of the required fields are null.