Package org.opensearch.client.opensearch.cat

Class CatRequestBase

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

Direct Known Subclasses:

AliasesRequest, AllocationRequest, ClusterManagerRequest, CountRequest, FielddataRequest, HealthRequest, HelpRequest, IndicesRequest, NodeattrsRequest, NodesRequest, PendingTasksRequest, PitSegmentsRequest, PluginsRequest, RecoveryRequest, RepositoriesRequest, SegmentsRequest, ShardsRequest, SnapshotsRequest, TasksRequest, TemplatesRequest, ThreadPoolRequest

public abstract class CatRequestBase
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	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>>

Constructor Summary

Constructors

Constructor	Description
CatRequestBase()
CatRequestBase(CatRequestBase.CatRequestBaseBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	headers()	A comma-separated list of headers to limit the returned information
protected java.util.Map<java.lang.String,java.lang.String>	queryParameters()
java.lang.String	sort()	A comma-separated list of headers to sort the returned information

Methods inherited from class java.lang.Object

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

Constructor Detail

CatRequestBase

public CatRequestBase()

CatRequestBase

public CatRequestBase(CatRequestBase.CatRequestBaseBuilder<?> builder)

Method Detail

queryParameters

protected final java.util.Map<java.lang.String,java.lang.String> queryParameters()

headers

public final java.lang.String headers()

A comma-separated list of headers to limit the returned information

API name: h

sort

public final java.lang.String sort()

A comma-separated list of headers to sort the returned information

API name: s