Package org.opensearch.client.opensearch.cat

Class FielddataRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.FielddataRequest

All Implemented Interfaces:

ToCopyableBuilder<FielddataRequest.Builder,FielddataRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class FielddataRequest
extends CatRequestBase
implements ToCopyableBuilder<FielddataRequest.Builder,FielddataRequest>

Shows how much heap memory is currently being used by field data on every data node in the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FielddataRequest.Builder	Builder for FielddataRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<FielddataRequest,FielddataResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.fielddata".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static FielddataRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
boolean	equals(Object o)
final List<String>	fields()	A comma-separated list of fields used to limit the amount of returned information.
int	hashCode()
static FielddataRequest	of(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)
FielddataRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

headers, sort

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

errorTrace, human

Methods inherited from class java.lang.Object

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

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

copy

Field Details

_ENDPOINT

public static final Endpoint<FielddataRequest,FielddataResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.fielddata".

Method Details

of

public static FielddataRequest of(Function<FielddataRequest.Builder,ObjectBuilder<FielddataRequest>> fn)

bytes

@Nullable
public final Bytes bytes()

The units used to display byte values.

API name: bytes

fields

@Nonnull
public final List<String> fields()

A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.

API name: fields

toBuilder

@Nonnull
public FielddataRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FielddataRequest.Builder,FielddataRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static FielddataRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object