Package org.opensearch.client.opensearch.search_relevance

Class GetStatsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetStatsRequest.Builder>

org.opensearch.client.opensearch.search_relevance.GetStatsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<GetStatsRequest.Builder,GetStatsRequest>, MutableBuilder<GetStatsRequest.Builder,GetStatsRequest>, ObjectBuilder<GetStatsRequest>

Enclosing class:

GetStatsRequest

public static class GetStatsRequest.Builder
extends RequestBase.AbstractBuilder<GetStatsRequest.Builder>
implements CopyableBuilder<GetStatsRequest.Builder,GetStatsRequest>

Builder for GetStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetStatsRequest	build()	Builds a GetStatsRequest.
GetStatsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetStatsRequest.Builder	flatStatPaths(String value)	Requests flattened stat paths as keys
final GetStatsRequest.Builder	includeAllNodes(String value)	Whether to include all nodes
final GetStatsRequest.Builder	includeIndividualNodes(String value)	Whether to include individual nodes
final GetStatsRequest.Builder	includeInfo(String value)	Whether to include info
final GetStatsRequest.Builder	includeMetadata(String value)	Whether to include metadata
protected GetStatsRequest.Builder	self()
final GetStatsRequest.Builder	stat(String value)	The statistic to return

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetStatsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetStatsRequest.Builder,GetStatsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetStatsRequest.Builder>

flatStatPaths

@Nonnull
public final GetStatsRequest.Builder flatStatPaths(@Nullable
 String value)

Requests flattened stat paths as keys

API name: flat_stat_paths

includeAllNodes

@Nonnull
public final GetStatsRequest.Builder includeAllNodes(@Nullable
 String value)

Whether to include all nodes

API name: include_all_nodes

includeIndividualNodes

@Nonnull
public final GetStatsRequest.Builder includeIndividualNodes(@Nullable
 String value)

Whether to include individual nodes

API name: include_individual_nodes

includeInfo

@Nonnull
public final GetStatsRequest.Builder includeInfo(@Nullable
 String value)

Whether to include info

API name: include_info

includeMetadata

@Nonnull
public final GetStatsRequest.Builder includeMetadata(@Nullable
 String value)

Whether to include metadata

API name: include_metadata

stat

@Nonnull
public final GetStatsRequest.Builder stat(@Nullable
 String value)

The statistic to return

API name: stat

build

@Nonnull
public GetStatsRequest build()

Builds a GetStatsRequest.

Specified by:

build in interface ObjectBuilder<GetStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.