Package org.opensearch.client.opensearch.indices

Class GetAliasRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.GetAliasRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetAliasRequest>

Enclosing class:

GetAliasRequest

public static class GetAliasRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetAliasRequest>

Builder for GetAliasRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetAliasRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
GetAliasRequest	build()	Builds a GetAliasRequest.
GetAliasRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetAliasRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetAliasRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
GetAliasRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names to filter aliases
GetAliasRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names to filter aliases
GetAliasRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)
GetAliasRequest.Builder	name(java.lang.String value, java.lang.String... values)	A comma-separated list of alias names to return
GetAliasRequest.Builder	name(java.util.List<java.lang.String> list)	A comma-separated list of alias names to return

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

_checkSingleUse, _listAdd, _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

allowNoIndices

public final GetAliasRequest.Builder allowNoIndices(@Nullable
                                                    java.lang.Boolean value)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final GetAliasRequest.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 GetAliasRequest.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.

ignoreUnavailable

public final GetAliasRequest.Builder ignoreUnavailable(@Nullable
                                                       java.lang.Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final GetAliasRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names to filter aliases

API name: index

Adds all elements of list to index.

index

public final GetAliasRequest.Builder index(java.lang.String value,
                                           java.lang.String... values)

A comma-separated list of index names to filter aliases

API name: index

Adds one or more values to index.

local

public final GetAliasRequest.Builder local(@Nullable
                                           java.lang.Boolean value)

Return local information, do not retrieve the state from cluster-manager node (default: false)

API name: local

name

public final GetAliasRequest.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 GetAliasRequest.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 GetAliasRequest build()

Builds a GetAliasRequest.

Specified by:

build in interface ObjectBuilder<GetAliasRequest>

Throws:

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