Package org.opensearch.client.opensearch.cat.aliases

Class AliasesRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.aliases.AliasesRecord.Builder

All Implemented Interfaces:

ObjectBuilder<AliasesRecord>

Enclosing class:

AliasesRecord

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

Builder for AliasesRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasesRecord.Builder	alias(java.lang.String value)	alias name
AliasesRecord	build()	Builds a AliasesRecord.
AliasesRecord.Builder	filter(java.lang.String value)	filter
AliasesRecord.Builder	index(java.lang.String value)	index alias points to
AliasesRecord.Builder	isWriteIndex(java.lang.String value)	write index
AliasesRecord.Builder	routingIndex(java.lang.String value)	index routing
AliasesRecord.Builder	routingSearch(java.lang.String value)	search routing

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

alias

public final AliasesRecord.Builder alias(@Nullable
                                         java.lang.String value)

alias name

API name: alias

index

public final AliasesRecord.Builder index(@Nullable
                                         java.lang.String value)

index alias points to

API name: index

filter

public final AliasesRecord.Builder filter(@Nullable
                                          java.lang.String value)

filter

API name: filter

routingIndex

public final AliasesRecord.Builder routingIndex(@Nullable
                                                java.lang.String value)

index routing

API name: routing.index

routingSearch

public final AliasesRecord.Builder routingSearch(@Nullable
                                                 java.lang.String value)

search routing

API name: routing.search

isWriteIndex

public final AliasesRecord.Builder isWriteIndex(@Nullable
                                                java.lang.String value)

write index

API name: is_write_index

build

public AliasesRecord build()

Builds a AliasesRecord.

Specified by:

build in interface ObjectBuilder<AliasesRecord>

Throws:

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