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, AllPitSegmentsRequest, ClusterManagerRequest, CountRequest, FielddataRequest, HealthRequest, HelpRequest, IndicesRequest, MasterRequest, NodeattrsRequest, NodesRequest, PendingTasksRequest, PitSegmentsRequest, PluginsRequest, RecoveryRequest, RepositoriesRequest, SegmentReplicationRequest, SegmentsRequest, ShardsRequest, SnapshotsRequest, TasksRequest, TemplatesRequest, ThreadPoolRequest

public abstract class CatRequestBase
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CatRequestBase()
protected	CatRequestBase(CatRequestBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
final List<String>	headers()	A comma-separated list of headers to limit the returned information
final List<String>	sort()	A comma-separated list of headers to sort the returned information

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

errorTrace, human

Methods inherited from class java.lang.Object

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

Constructor Details

CatRequestBase

protected CatRequestBase()

CatRequestBase

protected CatRequestBase(CatRequestBase.AbstractBuilder<?> builder)

Method Details

headers

@Nonnull
public final List<String> headers()

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

API name: h

sort

@Nonnull
public final List<String> sort()

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

API name: s

applyQueryParameters

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

Overrides:

applyQueryParameters in class RequestBase