AliasesRequest.Builder (java-client 2.1.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.cat.AliasesRequest.Builder

All Implemented Interfaces:: ObjectBuilder<AliasesRequest>

Enclosing class:: AliasesRequest

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

Builder for AliasesRequest.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
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

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
  - 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.
    
    Specified by:
    
    build in interface ObjectBuilder<AliasesRequest>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.