java.lang.Object

org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest

All Implemented Interfaces:: IndicesRequest, IndicesRequest.Replaceable, Writeable, TaskAwareRequest

public class GetSettingsRequest
extends MasterNodeReadRequest<GetSettingsRequest>
implements IndicesRequest.Replaceable

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
Field Summary

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Constructor Summary

Constructors

Constructor Description

GetSettingsRequest()

GetSettingsRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`boolean`	`humanReadable()`
`GetSettingsRequest`	`humanReadable(boolean humanReadable)`
`boolean`	`includeDefaults()`
`GetSettingsRequest`	`includeDefaults(boolean includeDefaults)`	When include_defaults is set, return default values which are normally suppressed.
`java.lang.String[]`	`indices()`	Returns the array of indices that the action relates to
`GetSettingsRequest`	`indices(java.lang.String... indices)`	Sets the indices that the action relates to.
`IndicesOptions`	`indicesOptions()`	Returns the indices options used to resolve indices.
`GetSettingsRequest`	`indicesOptions(IndicesOptions indicesOptions)`
`java.lang.String[]`	`names()`
`GetSettingsRequest`	`names(java.lang.String... names)`
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest

local, local

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details
- GetSettingsRequest
  
  public GetSettingsRequest()
- GetSettingsRequest
  
  public GetSettingsRequest(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- indices
  
  public GetSettingsRequest indices(java.lang.String... indices)
  
  Description copied from interface: IndicesRequest.Replaceable
  
  Sets the indices that the action relates to.
  
  Specified by:
  
  indices in interface IndicesRequest.Replaceable
- indicesOptions
  
  public GetSettingsRequest indicesOptions(IndicesOptions indicesOptions)
- includeDefaults
  
  public GetSettingsRequest includeDefaults(boolean includeDefaults)
  
  When include_defaults is set, return default values which are normally suppressed. This flag is specific to the rest client.
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class MasterNodeReadRequest<GetSettingsRequest>
  
  Throws:
  
  java.io.IOException
- indices
  
  public java.lang.String[] indices()
  
  Description copied from interface: IndicesRequest
  
  Returns the array of indices that the action relates to
  
  Specified by:
  
  indices in interface IndicesRequest
- indicesOptions
  
  public IndicesOptions indicesOptions()
  
  Description copied from interface: IndicesRequest
  
  Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.
  
  Specified by:
  
  indicesOptions in interface IndicesRequest
- names
  
  public java.lang.String[] names()
- names
  
  public GetSettingsRequest names(java.lang.String... names)
- humanReadable
  
  public boolean humanReadable()
- humanReadable
  
  public GetSettingsRequest humanReadable(boolean humanReadable)
- includeDefaults
  
  public boolean includeDefaults()
- validate
  
  public ActionRequestValidationException validate()
  
  Specified by:
  
  validate in class ActionRequest
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object

Constructors
Constructor	Description
`GetSettingsRequest()`
`GetSettingsRequest(StreamInput in)`

Class GetSettingsRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

Constructor Summary