Package org.opensearch.client.opensearch.indices

Class CloseRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.indices.CloseRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CloseRequest>

Enclosing class:

CloseRequest

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

Builder for CloseRequest.

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

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

API name: index

index

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

API name: index

addIndex

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

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

allowNoIndices

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

API name: allow_no_indices

expandWildcards

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

API name: expand_wildcards

ignoreUnavailable

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

API name: ignore_unavailable

masterTimeout

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

API name: master_timeout

timeout

public CloseRequest.Builder timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

waitForActiveShards

public CloseRequest.Builder waitForActiveShards(@Nullable jakarta.json.JsonValue value)

API name: wait_for_active_shards

build

public CloseRequest build()

Builds a CloseRequest.

Specified by:

build in interface ObjectBuilder<CloseRequest>

Throws:

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