Package org.opensearch.client.opensearch.cat

Class AliasesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

ObjectBuilder

Enclosing class:

AliasesRequest

public static class AliasesRequest.Builder
extends CatRequestBase.CatRequestBaseBuilder<AliasesRequest.Builder>

Builder for AliasesRequest.

Field Summary

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

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasesRequest	build()	Builds a AliasesRequest.
AliasesRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
AliasesRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
AliasesRequest.Builder	name(java.lang.String value, java.lang.String... values)	A comma-separated list of alias names to return
AliasesRequest.Builder	name(java.util.List<java.lang.String> list)	A comma-separated list of alias names to return
protected AliasesRequest.Builder	self()

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

headers, sort

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

expandWildcards

public final AliasesRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

name

public final AliasesRequest.Builder name(java.util.List<java.lang.String> list)

A comma-separated list of alias names to return

API name: name

Adds all elements of list to name.

name

public final AliasesRequest.Builder name(java.lang.String value,
                                         java.lang.String... values)

A comma-separated list of alias names to return

API name: name

Adds one or more values to name.

build

public AliasesRequest build()

Builds a AliasesRequest.

Throws:

java.lang.NullPointerException - if some of the required fields are null.

self

protected AliasesRequest.Builder self()

Specified by:

self in class CatRequestBase.CatRequestBaseBuilder<AliasesRequest.Builder>