Package org.opensearch.client.opensearch.cat

Class IndicesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<IndicesRequest.Builder>

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<IndicesRequest.Builder>

org.opensearch.client.opensearch.cat.IndicesRequest.Builder

All Implemented Interfaces:

CopyableBuilder<IndicesRequest.Builder,IndicesRequest>, MutableBuilder<IndicesRequest.Builder,IndicesRequest>, ObjectBuilder<IndicesRequest>

Enclosing class:

IndicesRequest

public static class IndicesRequest.Builder
extends CatRequestBase.AbstractBuilder<IndicesRequest.Builder>
implements CopyableBuilder<IndicesRequest.Builder,IndicesRequest>

Builder for IndicesRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndicesRequest	build()	Builds a IndicesRequest.
final IndicesRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final IndicesRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final IndicesRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
IndicesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndicesRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Specifies the type of index that wildcard expressions can match.
final IndicesRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Specifies the type of index that wildcard expressions can match.
final IndicesRequest.Builder	health(HealthStatus value)	Limits indexes based on their health status.
final IndicesRequest.Builder	includeUnloadedSegments(Boolean value)	Whether to include information from segments not loaded into memory.
final IndicesRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final IndicesRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final IndicesRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final IndicesRequest.Builder	masterTimeout(Time value)	Deprecated.
final IndicesRequest.Builder	pri(Boolean value)	When true, returns information only from the primary shards.
protected IndicesRequest.Builder	self()
final IndicesRequest.Builder	time(TimeUnit value)	Specifies the time units.

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public IndicesRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<IndicesRequest.Builder,IndicesRequest>

Returns:

a new builder instance.

self

@Nonnull
protected IndicesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<IndicesRequest.Builder>

bytes

@Nonnull
public final IndicesRequest.Builder bytes(@Nullable
 Bytes value)

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nonnull
public final IndicesRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final IndicesRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

expandWildcards

@Nonnull
public final IndicesRequest.Builder expandWildcards(List<ExpandWildcard> list)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final IndicesRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

Adds one or more values to expandWildcards.

health

@Nonnull
public final IndicesRequest.Builder health(@Nullable
 HealthStatus value)

Limits indexes based on their health status. Supported values are green, yellow, and red.

API name: health

includeUnloadedSegments

@Nonnull
public final IndicesRequest.Builder includeUnloadedSegments(@Nullable
 Boolean value)

Whether to include information from segments not loaded into memory.

API name: include_unloaded_segments

index

@Nonnull
public final IndicesRequest.Builder index(List<String> list)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final IndicesRequest.Builder index(String value,
 String... values)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

masterTimeout

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

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final IndicesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

pri

@Nonnull
public final IndicesRequest.Builder pri(@Nullable
 Boolean value)

When true, returns information only from the primary shards.

API name: pri

time

@Nonnull
public final IndicesRequest.Builder time(@Nullable
 TimeUnit value)

Specifies the time units.

API name: time

build

@Nonnull
public IndicesRequest build()

Builds a IndicesRequest.

Specified by:

build in interface ObjectBuilder<IndicesRequest>

Throws:

NullPointerException - if some of the required fields are null.