Package org.opensearch.core.common.breaker

Class CircuitBreakingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.core.common.breaker.CircuitBreakingException

All Implemented Interfaces:

Serializable, Writeable, ToXContent, ToXContentFragment

public class CircuitBreakingException
extends OpenSearchException

Exception thrown when the circuit breaker trips

See Also:

• Serialized Form

Opensearch.internal:

Nested Class Summary

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

OpenSearchException.OpenSearchExceptionHandle, OpenSearchException.OpenSearchExceptionHandleRegistry

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.WriteableRegistry, 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
CircuitBreakingException(String message, long bytesWanted, long byteLimit, CircuitBreaker.Durability durability)
CircuitBreakingException(String message, CircuitBreaker.Durability durability)
CircuitBreakingException(StreamInput in)

Method Summary

Modifier and Type	Method	Description
long	getByteLimit()
long	getBytesWanted()
CircuitBreaker.Durability	getDurability()
protected void	metadataToXContent(XContentBuilder builder, ToXContent.Params params)	Renders additional per exception information into the XContent
RestStatus	status()	Always returns RestStatus.TOO_MANY_REQUESTS
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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, 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

CircuitBreakingException

public CircuitBreakingException(StreamInput in)
                         throws IOException

Throws:

IOException

CircuitBreakingException

public CircuitBreakingException(String message,
 CircuitBreaker.Durability durability)

CircuitBreakingException

public CircuitBreakingException(String message,
 long bytesWanted,
 long byteLimit,
 CircuitBreaker.Durability durability)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class OpenSearchException

Throws:

IOException

getBytesWanted

public long getBytesWanted()

getByteLimit

public long getByteLimit()

getDurability

public CircuitBreaker.Durability getDurability()

status

public RestStatus status()

Always returns RestStatus.TOO_MANY_REQUESTS

Overrides:

status in class OpenSearchException

metadataToXContent

protected void metadataToXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Description copied from class: OpenSearchException

Renders additional per exception information into the XContent

Overrides:

metadataToXContent in class OpenSearchException

Throws:

IOException