UsageRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.nodes.UsageRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class UsageRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class UsageRequest.Builder
Builder for UsageRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
Field Summary

Fields

Modifier and Type Field Description

static Endpoint<UsageRequest,UsageResponse,ElasticsearchError> ENDPOINT
Endpoint "nodes.usage".
Constructor Summary

Constructors

Constructor Description

UsageRequest(UsageRequest.Builder builder)

UsageRequest(java.util.function.Function<UsageRequest.Builder,UsageRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`metric()`	Limit the information returned to the specified metrics
`java.util.List<java.lang.String>`	`nodeId()`	A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
`java.lang.String`	`timeout()`	Explicit operation timeout

Methods inherited from class java.lang.Object

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

Field Details
- ENDPOINT
  
  public static final Endpoint<UsageRequest,UsageResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "nodes.usage".
Constructor Details
- UsageRequest
  
  public UsageRequest(UsageRequest.Builder builder)
- UsageRequest
  
  public UsageRequest(java.util.function.Function<UsageRequest.Builder,UsageRequest.Builder> fn)
Method Details
- nodeId
  
  @Nullable public java.util.List<java.lang.String> nodeId()
  
  A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
  API name: node_id
- metric
  
  @Nullable public java.util.List<java.lang.String> metric()
  
  Limit the information returned to the specified metrics
  API name: metric
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Explicit operation timeout
  API name: timeout