GetSettingsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.GetSettingsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetSettingsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetSettingsRequest.Builder
Builder for GetSettingsRequest.

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<GetSettingsRequest,GetSettingsResponse,ElasticsearchError> ENDPOINT
Endpoint "cluster.get_settings".

Constructor Summary

Constructors
Constructor	Description
`GetSettingsRequest(GetSettingsRequest.Builder builder)`
`GetSettingsRequest(java.util.function.Function<GetSettingsRequest.Builder,GetSettingsRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`flatSettings()`	Return settings in flat format (default: false)
`java.lang.Boolean`	`includeDefaults()`	Whether to return all default clusters setting.
`java.lang.String`	`masterTimeout()`	Explicit operation timeout for connection to master node
`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<GetSettingsRequest,GetSettingsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "cluster.get_settings".
Constructor Details
- GetSettingsRequest
  
  public GetSettingsRequest(GetSettingsRequest.Builder builder)
- GetSettingsRequest
  
  public GetSettingsRequest(java.util.function.Function<GetSettingsRequest.Builder,GetSettingsRequest.Builder> fn)
Method Details
- flatSettings
  
  @Nullable public java.lang.Boolean flatSettings()
  
  Return settings in flat format (default: false)
  API name: flat_settings
- includeDefaults
  
  @Nullable public java.lang.Boolean includeDefaults()
  
  Whether to return all default clusters setting.
  API name: include_defaults
- masterTimeout
  
  @Nullable public java.lang.String masterTimeout()
  
  Explicit operation timeout for connection to master node
  API name: master_timeout
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Explicit operation timeout
  API name: timeout