Package co.elastic.clients.elasticsearch.cat

Class IndicesRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<IndicesRequest.Builder>

co.elastic.clients.elasticsearch.cat.IndicesRequest.Builder

All Implemented Interfaces:

WithJson<IndicesRequest.Builder>, ObjectBuilder<IndicesRequest>

Enclosing class:

IndicesRequest

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

Builder for IndicesRequest.

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 unit used to display byte values.
final IndicesRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	The type of index that wildcard patterns can match.
final IndicesRequest.Builder	expandWildcards(List<ExpandWildcard> list)	The type of index that wildcard patterns can match.
final IndicesRequest.Builder	health(HealthStatus value)	The health status used to limit returned indices.
final IndicesRequest.Builder	includeUnloadedSegments(Boolean value)	If true, the response includes information from segments that are not loaded into memory.
final IndicesRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indices, and aliases used to limit the request.
final IndicesRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indices, and aliases used to limit the request.
final IndicesRequest.Builder	pri(Boolean value)	If true, the response only includes information from primary shards.
protected IndicesRequest.Builder	self()
final IndicesRequest.Builder	time(TimeUnit value)	The unit used to display time values.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

bytes

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

The unit used to display byte values.

API name: bytes

expandWildcards

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

The type of index that wildcard patterns can match.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

The type of index that wildcard patterns can match.

API name: expand_wildcards

Adds one or more values to expandWildcards.

health

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

The health status used to limit returned indices. By default, the response includes indices of any health status.

API name: health

includeUnloadedSegments

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

If true, the response includes information from segments that are not loaded into memory.

API name: include_unloaded_segments

index

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

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

API name: index

Adds all elements of list to index.

index

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

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

API name: index

Adds one or more values to index.

pri

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

If true, the response only includes information from primary shards.

API name: pri

time

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

The unit used to display time values.

API name: time

self

protected IndicesRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<IndicesRequest.Builder>

build

public IndicesRequest build()

Builds a IndicesRequest.

Specified by:

build in interface ObjectBuilder<IndicesRequest>

Throws:

NullPointerException - if some of the required fields are null.