Package org.opensearch.client.opensearch._global

Class SearchShardsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.SearchShardsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SearchShardsRequest>

Enclosing class:

SearchShardsRequest

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

Builder for SearchShardsRequest.

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
SearchShardsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
SearchShardsRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
SearchShardsRequest	build()	Builds a SearchShardsRequest.
SearchShardsRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
SearchShardsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
SearchShardsRequest.Builder	index(java.lang.String... value)	API name: index
SearchShardsRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
SearchShardsRequest.Builder	local(java.lang.Boolean value)	API name: local
SearchShardsRequest.Builder	preference(java.lang.String value)	API name: preference
SearchShardsRequest.Builder	routing(jakarta.json.JsonValue value)	API name: routing

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 SearchShardsRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

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

API name: index

addIndex

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

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

allowNoIndices

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

API name: allow_no_indices

expandWildcards

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

API name: expand_wildcards

ignoreUnavailable

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

API name: ignore_unavailable

local

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

API name: local

preference

public SearchShardsRequest.Builder preference(@Nullable java.lang.String value)

API name: preference

routing

public SearchShardsRequest.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

build

public SearchShardsRequest build()

Builds a SearchShardsRequest.

Specified by:

build in interface ObjectBuilder<SearchShardsRequest>

Throws:

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