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

Class GetSettingsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.MasterNodeReadRequest<GetSettingsRequest>
org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest
All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest
public class GetSettingsRequest
extends MasterNodeReadRequest<GetSettingsRequest>
implements IndicesRequest.Replaceable

  • 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

    • includeDataStreams

      public boolean includeDataStreams()
      Description copied from interface: IndicesRequest
      Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.
      Specified by:
      includeDataStreams 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