Package org.opensearch.client.opensearch.search_relevance

Class GetStatsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.search_relevance.GetStatsRequest

All Implemented Interfaces:

ToCopyableBuilder<GetStatsRequest.Builder,GetStatsRequest>

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

Gets stats.

Nested Class Summary

Nested Classes

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

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 final Endpoint<GetStatsRequest,GetStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_relevance.get_stats".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetStatsRequest.Builder	builder()
boolean	equals(Object o)
final String	flatStatPaths()	Requests flattened stat paths as keys
int	hashCode()
final String	includeAllNodes()	Whether to include all nodes
final String	includeIndividualNodes()	Whether to include individual nodes
final String	includeInfo()	Whether to include info
final String	includeMetadata()	Whether to include metadata
static GetStatsRequest	of(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)
final String	stat()	The statistic to return
GetStatsRequest.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._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<GetStatsRequest,GetStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "search_relevance.get_stats".

Method Details

of

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

flatStatPaths

@Nullable
public final String flatStatPaths()

Requests flattened stat paths as keys

API name: flat_stat_paths

includeAllNodes

@Nullable
public final String includeAllNodes()

Whether to include all nodes

API name: include_all_nodes

includeIndividualNodes

@Nullable
public final String includeIndividualNodes()

Whether to include individual nodes

API name: include_individual_nodes

includeInfo

@Nullable
public final String includeInfo()

Whether to include info

API name: include_info

includeMetadata

@Nullable
public final String includeMetadata()

Whether to include metadata

API name: include_metadata

stat

@Nullable
public final String stat()

The statistic to return

API name: stat

toBuilder

@Nonnull
public GetStatsRequest.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<GetStatsRequest.Builder,GetStatsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetStatsRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object