Package org.opensearch.client.opensearch.indices

Class GetIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.GetIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetIndexRequest>

Enclosing class:

GetIndexRequest

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

Builder for GetIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetIndexRequest.Builder	allowNoIndices(java.lang.Boolean value)	Ignore if a wildcard expression resolves to no concrete indices (default: false)
GetIndexRequest	build()	Builds a GetIndexRequest.
GetIndexRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
GetIndexRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
GetIndexRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Type of index that wildcard expressions can match.
GetIndexRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard expressions can match.
GetIndexRequest.Builder	flatSettings(java.lang.Boolean value)	If true, returns settings in flat format.
GetIndexRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	If false, requests that target a missing index return an error.
GetIndexRequest.Builder	includeDefaults(java.lang.Boolean value)	If true, return all default settings in the response.
GetIndexRequest.Builder	index(java.lang.String value, java.lang.String... values)	Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.
GetIndexRequest.Builder	index(java.util.List<java.lang.String> list)	Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.
GetIndexRequest.Builder	local(java.lang.Boolean value)	If true, the request retrieves information from the local node only.
GetIndexRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
GetIndexRequest.Builder	masterTimeout(Time value)	Deprecated.

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

allowNoIndices

public final GetIndexRequest.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 GetIndexRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds one or more values to expandWildcards.

flatSettings

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

If true, returns settings in flat format.

API name: flat_settings

ignoreUnavailable

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

If false, requests that target a missing index return an error.

API name: ignore_unavailable

includeDefaults

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

If true, return all default settings in the response.

API name: include_defaults

index

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

Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

API name: index

Adds all elements of list to index.

index

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

Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

API name: index

Adds one or more values to index.

local

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

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

API name: local

masterTimeout

@Deprecated
public final GetIndexRequest.Builder masterTimeout(@Nullable
                                                   Time value)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
public final GetIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

public final GetIndexRequest.Builder clusterManagerTimeout(@Nullable
                                                           Time value)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

public final GetIndexRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

build

public GetIndexRequest build()

Builds a GetIndexRequest.

Specified by:

build in interface ObjectBuilder<GetIndexRequest>

Throws:

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