Package co.elastic.clients.elasticsearch.cluster

Class StateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.StateRequest
All Implemented Interfaces:
ElasticsearchCommonRequest
public final class StateRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  StateRequest.Builder
    Builder for StateRequest.

    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<StateRequest,​StateResponse,​ElasticsearchError> ENDPOINT
    Endpoint "cluster.state".

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean allowNoIndices()
    Whether to ignore if a wildcard indices expression resolves into no concrete indices.
    java.util.List<ExpandWildcardOptions> expandWildcards()
    Whether to expand wildcard expression to concrete indices that are open, closed or both.
    java.lang.Boolean flatSettings()
    Return settings in flat format (default: false)
    java.lang.Boolean ignoreUnavailable()
    Whether specified concrete indices should be ignored when unavailable (missing or closed)
    java.util.List<java.lang.String> index()
    A comma-separated list of index names; use _all or empty string to perform the operation on all indices
    java.lang.Boolean local()
    Return local information, do not retrieve the state from master node (default: false)
    java.lang.String masterTimeout()
    Specify timeout for connection to master
    java.util.List<java.lang.String> metric()
    Limit the information returned to the specified metrics
    java.lang.Long waitForMetadataVersion()
    Wait for the metadata version to be equal or greater than the specified metadata version
    java.lang.String waitForTimeout()
    The maximum time to wait for wait_for_metadata_version before timing out

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • metric

      @Nullable public java.util.List<java.lang.String> metric()
      Limit the information returned to the specified metrics

      API name: metric

    • index

      @Nullable public java.util.List<java.lang.String> index()
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • allowNoIndices

      @Nullable public java.lang.Boolean allowNoIndices()
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      @Nullable public java.util.List<ExpandWildcardOptions> expandWildcards()
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • flatSettings

      @Nullable public java.lang.Boolean flatSettings()
      Return settings in flat format (default: false)

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public java.lang.Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • local

      @Nullable public java.lang.Boolean local()
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • masterTimeout

      @Nullable public java.lang.String masterTimeout()
      Specify timeout for connection to master

      API name: master_timeout

    • waitForMetadataVersion

      @Nullable public java.lang.Long waitForMetadataVersion()
      Wait for the metadata version to be equal or greater than the specified metadata version

      API name: wait_for_metadata_version

    • waitForTimeout

      @Nullable public java.lang.String waitForTimeout()
      The maximum time to wait for wait_for_metadata_version before timing out

      API name: wait_for_timeout