Package org.opensearch.cluster.block

Class ClusterBlockException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.opensearch.OpenSearchException
org.opensearch.cluster.block.ClusterBlockException
All Implemented Interfaces:
Serializable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
Direct Known Subclasses:
IndexCreateBlockException
@PublicApi(since="1.0.0") public class ClusterBlockException extends org.opensearch.OpenSearchException
Internal exception on obtaining a cluster block
See Also:
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.OpenSearchException

    org.opensearch.OpenSearchException.OpenSearchExceptionHandle, org.opensearch.OpenSearchException.OpenSearchExceptionHandleRegistry

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from class org.opensearch.OpenSearchException

    headers, metadata, REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE, UNKNOWN_VERSION_ADDED

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClusterBlockException(Map<String,Set<ClusterBlock>> indexLevelBlocks)
     
    ClusterBlockException(Set<ClusterBlock> globalLevelBlocks)
     
    ClusterBlockException(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<ClusterBlock>
    blocks()
     
    boolean
    retryable()
     
    org.opensearch.core.rest.RestStatus
    status()
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.opensearch.OpenSearchException

    addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getExceptionSimpleClassName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, headerToXContent, innerFromXContent, innerToXContent, isRegistered, metadataToXContent, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, unwrapCause, writeStackTraces

    Methods inherited from class java.lang.Throwable

    addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • ClusterBlockException

      public ClusterBlockException(Set<ClusterBlock> globalLevelBlocks)

    • ClusterBlockException

      public ClusterBlockException(Map<String,Set<ClusterBlock>> indexLevelBlocks)

    • ClusterBlockException

      public ClusterBlockException(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Overrides:
      writeTo in class org.opensearch.OpenSearchException
      Throws:
      IOException

    • retryable

      public boolean retryable()

    • blocks

      public Set<ClusterBlock> blocks()

    • status

      public org.opensearch.core.rest.RestStatus status()
      Overrides:
      status in class org.opensearch.OpenSearchException