com.microsoft.azure.sdk.iot.service.exceptions

Class IotHubException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microsoft.azure.sdk.iot.service.exceptions.IotHubException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IotHubBadFormatException, IotHubBadGatewayException, IotHubConflictException, IotHubDeviceMaximumQueueDepthExceededException, IotHubDeviceNotFoundException, IotHubGatewayTimeoutException, IotHubInternalServerErrorException, IotHubInvalidOperationException, IotHubMessageTooLargeException, IotHubNotFoundException, IotHubNotSupportedException, IotHubPreconditionFailedException, IotHubServerBusyException, IotHubTooManyDevicesException, IotHubTooManyRequestsException, IotHubUnathorizedException

public class IotHubException
extends Exception

Super class for IotHub exceptions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	errorCode Provides the HTTP error code, if applicable.
protected com.microsoft.azure.sdk.iot.deps.serializer.ErrorCodeDescription	errorCodeDescription Provides the HTTP error code description, if applicable.

Constructor Summary

Constructors

Constructor and Description
IotHubException() Instantiate a new IotHubException with no details.
IotHubException(int errorCode, String message) Instantiate a new IotHubException.
IotHubException(String message) Instantiate a new IotHubException.

Method Summary

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

errorCode

protected int errorCode

Provides the HTTP error code, if applicable.

This value will be a 6 digital error code such as 404001 if the service provided one in response message to the HTTP request. Otherwise it will be a 3 digit status code such as 404.

For AMQP operations such as sending cloud to device messages, receiving message feedback, and getting file upload notifications, this field will not be populated.

errorCodeDescription

protected com.microsoft.azure.sdk.iot.deps.serializer.ErrorCodeDescription errorCodeDescription

Provides the HTTP error code description, if applicable.

For AMQP operations such as sending cloud to device messages, receiving message feedback, and getting file upload notifications, this field will not be populated.

Constructor Detail

IotHubException

public IotHubException()

Instantiate a new IotHubException with no details.

IotHubException

public IotHubException(String message)

Instantiate a new IotHubException.

Parameters:

message - the human readable description for why this exception was thrown.

IotHubException

public IotHubException(int errorCode,
                       String message)

Instantiate a new IotHubException.

Parameters:

errorCode - the Http status code (200, 401, 404, etc.)

message - the human readable description for why this exception was thrown.