Package org.opensearch.client.opensearch.indices

Class ExistsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.ExistsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ExistsRequest>

Enclosing class:

ExistsRequest

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

Builder for ExistsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExistsRequest.Builder	allowNoIndices(java.lang.Boolean value)	Ignore if a wildcard expression resolves to no concrete indices (default: false)
ExistsRequest	build()	Builds a ExistsRequest.
ExistsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether wildcard expressions should get expanded to open or closed indices (default: open)
ExistsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether wildcard expressions should get expanded to open or closed indices (default: open)
ExistsRequest.Builder	flatSettings(java.lang.Boolean value)	Return settings in flat format (default: false)
ExistsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Ignore unavailable indexes (default: false)
ExistsRequest.Builder	includeDefaults(java.lang.Boolean value)	Whether to return all default setting for each of the indices.
ExistsRequest.Builder	index(java.lang.String value, java.lang.String... values)	Required - A comma-separated list of index names
ExistsRequest.Builder	index(java.util.List<java.lang.String> list)	Required - A comma-separated list of index names
ExistsRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)

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

allowNoIndices

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

Ignore if a wildcard expression resolves to no concrete indices (default: false)

API name: allow_no_indices

expandWildcards

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

Whether wildcard expressions should get expanded to open or closed indices (default: open)

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Whether wildcard expressions should get expanded to open or closed indices (default: open)

API name: expand_wildcards

Adds one or more values to expandWildcards.

flatSettings

public final ExistsRequest.Builder flatSettings(@Nullable
                                                java.lang.Boolean value)

Return settings in flat format (default: false)

API name: flat_settings

ignoreUnavailable

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

Ignore unavailable indexes (default: false)

API name: ignore_unavailable

includeDefaults

public final ExistsRequest.Builder includeDefaults(@Nullable
                                                   java.lang.Boolean value)

Whether to return all default setting for each of the indices.

API name: include_defaults

index

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

Required - A comma-separated list of index names

API name: index

Adds all elements of list to index.

index

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

Required - A comma-separated list of index names

API name: index

Adds one or more values to index.

local

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

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

API name: local

build

public ExistsRequest build()

Builds a ExistsRequest.

Specified by:

build in interface ObjectBuilder<ExistsRequest>

Throws:

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