Package co.elastic.clients.elasticsearch.cluster

Class StateRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.cluster.StateRequest.Builder
All Implemented Interfaces:
ObjectBuilder<StateRequest>
Enclosing class:
StateRequest
public static class StateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<StateRequest>
Builder for StateRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metric

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

      API name: metric

    • metric

      public StateRequest.Builder metric​(java.lang.String... value)
      Limit the information returned to the specified metrics

      API name: metric

    • addMetric

      public StateRequest.Builder addMetric​(java.lang.String value)
      Add a value to metric(List), creating the list if needed.

    • index

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

      API name: index

    • index

      public StateRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • addIndex

      public StateRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • allowNoIndices

      public StateRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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

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

      API name: expand_wildcards

    • expandWildcards

      public StateRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public StateRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • local

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

      API name: local

    • masterTimeout

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

      API name: master_timeout

    • waitForMetadataVersion

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

      API name: wait_for_metadata_version

    • waitForTimeout

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

      API name: wait_for_timeout

    • build

      public StateRequest build()
      Builds a StateRequest.
      Specified by:
      build in interface ObjectBuilder<StateRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.