Package org.opensearch.client.opensearch.indices

Class GetSettingsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.indices.GetSettingsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetSettingsRequest>

Enclosing class:

GetSettingsRequest

public static class GetSettingsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetSettingsRequest>

Builder for GetSettingsRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSettingsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
GetSettingsRequest.Builder	addName(java.lang.String value)	Add a value to name(List), creating the list if needed.
GetSettingsRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
GetSettingsRequest	build()	Builds a GetSettingsRequest.
GetSettingsRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
GetSettingsRequest.Builder	flatSettings(java.lang.Boolean value)	API name: flat_settings
GetSettingsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
GetSettingsRequest.Builder	includeDefaults(java.lang.Boolean value)	API name: include_defaults
GetSettingsRequest.Builder	index(java.lang.String... value)	API name: index
GetSettingsRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
GetSettingsRequest.Builder	local(java.lang.Boolean value)	API name: local
GetSettingsRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
GetSettingsRequest.Builder	name(java.lang.String... value)	API name: name
GetSettingsRequest.Builder	name(java.util.List<java.lang.String> value)	API name: name

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public GetSettingsRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

public GetSettingsRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public GetSettingsRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

name

public GetSettingsRequest.Builder name(@Nullable java.util.List<java.lang.String> value)

API name: name

name

public GetSettingsRequest.Builder name(java.lang.String... value)

API name: name

addName

public GetSettingsRequest.Builder addName(java.lang.String value)

Add a value to name(List), creating the list if needed.

allowNoIndices

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

API name: allow_no_indices

expandWildcards

public GetSettingsRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

flatSettings

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

API name: flat_settings

ignoreUnavailable

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

API name: ignore_unavailable

includeDefaults

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

API name: include_defaults

local

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

API name: local

masterTimeout

public GetSettingsRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

API name: master_timeout

build

public GetSettingsRequest build()

Builds a GetSettingsRequest.

Specified by:

build in interface ObjectBuilder<GetSettingsRequest>

Throws:

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