com.microsoft.azure.sdk.iot.device

Enum IotHubStatusCode

java.lang.Object

java.lang.Enum<IotHubStatusCode>

com.microsoft.azure.sdk.iot.device.IotHubStatusCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IotHubStatusCode>

public enum IotHubStatusCode
extends java.lang.Enum<IotHubStatusCode>

An IoT Hub status code. Included in a message from an IoT Hub to a device.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_FORMAT The request failed because it had one or more format issues.
DEVICE_OPERATION_TIMED_OUT The request failed because it took longer than the device operation timeout as defined in InternalClient.setOperationTimeout(long) or took longer than the timeout as defined in a synchronous operation such as InternalClient.sendEvent(Message, int).
ERROR The request failed for an unknown reason.
INTERNAL_SERVER_ERROR The service encountered an error while handling the request.
IO_ERROR The request failed because of network level issues.
MESSAGE_CANCELLED_ONCLOSE The request failed to be sent to the service and/or acknowledged by the service before the client was closed.
MESSAGE_EXPIRED The request failed to be sent to the service and/or acknowledged by the service before it expired.
NOT_FOUND The request failed because the resource the request targeted does not exist.
OK The request completed without exception
PRECONDITION_FAILED The request failed because the request provided an out of date ETag or version number.
QUOTA_EXCEEDED The request failed because the quota for such operations has been exceeded.
REQUEST_ENTITY_TOO_LARGE The request failed because the request payload exceeded IoT Hub's size limits.
SERVER_BUSY The request was rejected by the service because it is too busy to handle it right now.
THROTTLED The request was rejected by the service because the service is handling too many requests right now.
UNAUTHORIZED The request failed because the provided credentials are out of date or incorrect.

Method Summary

Modifier and Type	Method and Description
static IotHubServiceException	getConnectionStatusException(IotHubStatusCode statusCode, java.lang.String statusDescription)
static IotHubStatusCode	getIotHubStatusCode(int httpsStatus) Returns the IoT Hub status code referenced by the HTTPS status code.
static boolean	isRetryable(IotHubStatusCode statusCode) Returns true if this event callback signals that the asynchronous action was unsuccessful, but could be retried.
static boolean	isSuccessful(IotHubStatusCode statusCode) Returns true if this event callback signals that the asynchronous action was successful, and false otherwise.
static IotHubClientException	toException(IotHubStatusCode statusCode)
static IotHubStatusCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IotHubStatusCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final IotHubStatusCode OK

The request completed without exception

BAD_FORMAT

public static final IotHubStatusCode BAD_FORMAT

The request failed because it had one or more format issues.

UNAUTHORIZED

public static final IotHubStatusCode UNAUTHORIZED

The request failed because the provided credentials are out of date or incorrect.

QUOTA_EXCEEDED

public static final IotHubStatusCode QUOTA_EXCEEDED

The request failed because the quota for such operations has been exceeded.

For file upload operations, this signifies that the maximum number of concurrent file upload operations are already happening.

For telemetry operations, this signifies that the IoT hub has reached its daily quota for the number of messages ingested.

NOT_FOUND

public static final IotHubStatusCode NOT_FOUND

The request failed because the resource the request targeted does not exist.

PRECONDITION_FAILED

public static final IotHubStatusCode PRECONDITION_FAILED

The request failed because the request provided an out of date ETag or version number.

REQUEST_ENTITY_TOO_LARGE

public static final IotHubStatusCode REQUEST_ENTITY_TOO_LARGE

The request failed because the request payload exceeded IoT Hub's size limits.

THROTTLED

public static final IotHubStatusCode THROTTLED

The request was rejected by the service because the service is handling too many requests right now.

INTERNAL_SERVER_ERROR

public static final IotHubStatusCode INTERNAL_SERVER_ERROR

The service encountered an error while handling the request.

SERVER_BUSY

public static final IotHubStatusCode SERVER_BUSY

The request was rejected by the service because it is too busy to handle it right now.

ERROR

public static final IotHubStatusCode ERROR

The request failed for an unknown reason.

MESSAGE_EXPIRED

public static final IotHubStatusCode MESSAGE_EXPIRED

The request failed to be sent to the service and/or acknowledged by the service before it expired.

MESSAGE_CANCELLED_ONCLOSE

public static final IotHubStatusCode MESSAGE_CANCELLED_ONCLOSE

The request failed to be sent to the service and/or acknowledged by the service before the client was closed.

IO_ERROR

public static final IotHubStatusCode IO_ERROR

The request failed because of network level issues.

DEVICE_OPERATION_TIMED_OUT

public static final IotHubStatusCode DEVICE_OPERATION_TIMED_OUT

The request failed because it took longer than the device operation timeout as defined in InternalClient.setOperationTimeout(long) or took longer than the timeout as defined in a synchronous operation such as InternalClient.sendEvent(Message, int).

Method Detail

values

public static IotHubStatusCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IotHubStatusCode c : IotHubStatusCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IotHubStatusCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getConnectionStatusException

public static IotHubServiceException getConnectionStatusException(IotHubStatusCode statusCode,
                                                                  java.lang.String statusDescription)

getIotHubStatusCode

public static IotHubStatusCode getIotHubStatusCode(int httpsStatus)

Returns the IoT Hub status code referenced by the HTTPS status code.

Parameters:

httpsStatus - the HTTPS status code.

Returns:

the corresponding IoT Hub status code.

Throws:

java.lang.IllegalArgumentException - if the HTTPS status code does not map to an IoT Hub status code.

isRetryable

public static boolean isRetryable(IotHubStatusCode statusCode)

Returns true if this event callback signals that the asynchronous action was unsuccessful, but could be retried. Returns false if it was successful, or it was unsuccessful but should not be retried.

Parameters:

statusCode - The status code.

Returns:

true if this event callback signals that the asynchronous action was unsuccessful, but could be retried, and false otherwise.

isSuccessful

public static boolean isSuccessful(IotHubStatusCode statusCode)

Returns true if this event callback signals that the asynchronous action was successful, and false otherwise.

Parameters:

statusCode - The status code.

Returns:

true if this event callback signals that the asynchronous action was successful, and false otherwise.

toException

public static IotHubClientException toException(IotHubStatusCode statusCode)