Package org.opensearch.client.opensearch.cluster

Class StateRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.cluster.StateRequest
public final class StateRequest
extends RequestBase

  • Nested Class Summary

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Endpoint<StateRequest,​StateResponse,​OpenSearchError> ENDPOINT
    Endpoint "cluster.state".

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected StateRequest​(StateRequest.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean allowNoIndices()
    API name: allow_no_indices
    jakarta.json.JsonValue expandWildcards()
    API name: expand_wildcards
    java.lang.Boolean flatSettings()
    API name: flat_settings
    java.lang.Boolean ignoreUnavailable()
    API name: ignore_unavailable
    java.util.List<java.lang.String> index()
    API name: index
    java.lang.Boolean local()
    API name: local
    jakarta.json.JsonValue masterTimeout()
    API name: master_timeout
    java.util.List<java.lang.String> metric()
    API name: metric
    java.lang.Number waitForMetadataVersion()
    API name: wait_for_metadata_version
    jakarta.json.JsonValue waitForTimeout()
    API name: wait_for_timeout

    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()
      API name: metric

    • index

      @Nullable public java.util.List<java.lang.String> index()
      API name: index

    • allowNoIndices

      @Nullable public java.lang.Boolean allowNoIndices()
      API name: allow_no_indices

    • expandWildcards

      @Nullable public jakarta.json.JsonValue expandWildcards()
      API name: expand_wildcards

    • flatSettings

      @Nullable public java.lang.Boolean flatSettings()
      API name: flat_settings

    • ignoreUnavailable

      @Nullable public java.lang.Boolean ignoreUnavailable()
      API name: ignore_unavailable

    • local

      @Nullable public java.lang.Boolean local()
      API name: local

    • masterTimeout

      @Nullable public jakarta.json.JsonValue masterTimeout()
      API name: master_timeout

    • waitForMetadataVersion

      @Nullable public java.lang.Number waitForMetadataVersion()
      API name: wait_for_metadata_version

    • waitForTimeout

      @Nullable public jakarta.json.JsonValue waitForTimeout()
      API name: wait_for_timeout