EventHubException Class

  • Reference
Package:
com.microsoft.azure.eventhubs
Maven Artifact:
com.microsoft.azure:azure-eventhubs:3.2.2
  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • com.microsoft.azure.eventhubs.EventHubException

public class EventHubException
extends Exception

This is the base exception that service bus will produce for all error cases.

Constructor Summary

Constructor Description
EventHubException(boolean isTransient, String message)
EventHubException(boolean isTransient, String message, Throwable cause)
EventHubException(boolean isTransient, Throwable cause)

Method Summary

Modifier and Type Method and Description
ErrorContext getContext()
boolean getIsTransient()

A boolean indicating if the exception is a transient error or not.
String getMessage()
void setContext(ErrorContext errorContext)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll wait wait wait

Methods inherited from java.lang.Throwable

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

Constructor Details

EventHubException

public EventHubException(boolean isTransient, String message)

Parameters:

isTransient
message

EventHubException

public EventHubException(boolean isTransient, String message, Throwable cause)

Parameters:

isTransient
message
cause

EventHubException

public EventHubException(boolean isTransient, Throwable cause)

Parameters:

isTransient
cause

Method Details

getContext

public ErrorContext getContext()

getIsTransient

public boolean getIsTransient()

A boolean indicating if the exception is a transient error or not.

Returns:

returns true when user can retry the operation that generated the exception without additional intervention.

getMessage

public String getMessage()

Overrides:

EventHubException.getMessage()

setContext

public void setContext(ErrorContext errorContext)

Parameters:

errorContext

Applies to