IndicesRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.cat.CatRequestBase
  - - org.opensearch.client.opensearch.cat.IndicesRequest

```
public class IndicesRequest
extends CatRequestBase
```
Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IndicesRequest.Builder
Builder for IndicesRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase
  CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<IndicesRequest,IndicesResponse,ErrorResponse> _ENDPOINT
Endpoint "cat.indices".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Bytes`	`bytes()`	The unit in which to display byte values
`java.util.List<ExpandWildcard>`	`expandWildcards()`	Whether to expand wildcard expression to concrete indices that are open, closed or both.
`HealthStatus`	`health()`	A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
`java.lang.Boolean`	`includeUnloadedSegments()`	If set to true segment stats will include stats for segments that are not currently loaded into memory
`java.util.List<java.lang.String>`	`index()`	A comma-separated list of index names to limit the returned information
`static IndicesRequest`	`of(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)`
`java.lang.Boolean`	`pri()`	Set to true to return stats only for primary shards

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase
headers, queryParameters, sort

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<IndicesRequest,IndicesResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "cat.indices".
- Method Detail
  - of
```
public static IndicesRequest of(java.util.function.Function<IndicesRequest.Builder,ObjectBuilder<IndicesRequest>> fn)
```
  - bytes
```
@Nullable
public final Bytes bytes()
```
    The unit in which to display byte values
    API name: bytes
  - expandWildcards
```
public final java.util.List<ExpandWildcard> expandWildcards()
```
    Whether to expand wildcard expression to concrete indices that are open, closed or both.
    API name: expand_wildcards
  - health
```
@Nullable
public final HealthStatus health()
```
    A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
    API name: health
  - includeUnloadedSegments
```
@Nullable
public final java.lang.Boolean includeUnloadedSegments()
```
    If set to true segment stats will include stats for segments that are not currently loaded into memory
    API name: include_unloaded_segments
  - index
```
public final java.util.List<java.lang.String> index()
```
    A comma-separated list of index names to limit the returned information
    API name: index
  - pri
```
@Nullable
public final java.lang.Boolean pri()
```
    Set to true to return stats only for primary shards
    API name: pri