Package org.opensearch.client.opensearch.cat

Class AliasesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<AliasesRequest.Builder>

org.opensearch.client.opensearch.cat.AliasesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AliasesRequest

public static class AliasesRequest.Builder
extends CatRequestBase.AbstractBuilder<AliasesRequest.Builder>
implements CopyableBuilder<AliasesRequest.Builder,AliasesRequest>

Builder for AliasesRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasesRequest	build()	Builds a AliasesRequest.
AliasesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AliasesRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Specifies the type of index that wildcard expressions can match.
final AliasesRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Specifies the type of index that wildcard expressions can match.
final AliasesRequest.Builder	name(String value, String... values)	A comma-separated list of aliases to retrieve.
final AliasesRequest.Builder	name(List<String> list)	A comma-separated list of aliases to retrieve.
protected AliasesRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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 AliasesRequest.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<AliasesRequest.Builder,AliasesRequest>

Returns:

a new builder instance.

self

@Nonnull
protected AliasesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AliasesRequest.Builder>

expandWildcards

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

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds one or more values to expandWildcards.

name

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

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

API name: name

Adds all elements of list to name.

name

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

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

API name: name

Adds one or more values to name.

build

@Nonnull
public AliasesRequest build()

Builds a AliasesRequest.

Specified by:

build in interface ObjectBuilder<AliasesRequest>

Throws:

NullPointerException - if some of the required fields are null.