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:

Serializable, Comparable<IotHubStatusCode>

public enum IotHubStatusCode
extends 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
ERROR
HUB_OR_DEVICE_ID_NOT_FOUND
INTERNAL_SERVER_ERROR
MESSAGE_EXPIRED
OK
OK_EMPTY
PRECONDITION_FAILED
REQUEST_ENTITY_TOO_LARGE
SERVER_BUSY
THROTTLED
TOO_MANY_DEVICES
UNAUTHORIZED

Method Summary

Modifier and Type	Method and Description
static IotHubStatusCode	getIotHubStatusCode(int httpsStatus) Returns the IoT Hub status code referenced by the HTTPS status code.
static IotHubStatusCode	valueOf(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

OK_EMPTY

public static final IotHubStatusCode OK_EMPTY

BAD_FORMAT

public static final IotHubStatusCode BAD_FORMAT

UNAUTHORIZED

public static final IotHubStatusCode UNAUTHORIZED

TOO_MANY_DEVICES

public static final IotHubStatusCode TOO_MANY_DEVICES

HUB_OR_DEVICE_ID_NOT_FOUND

public static final IotHubStatusCode HUB_OR_DEVICE_ID_NOT_FOUND

PRECONDITION_FAILED

public static final IotHubStatusCode PRECONDITION_FAILED

REQUEST_ENTITY_TOO_LARGE

public static final IotHubStatusCode REQUEST_ENTITY_TOO_LARGE

THROTTLED

public static final IotHubStatusCode THROTTLED

INTERNAL_SERVER_ERROR

public static final IotHubStatusCode INTERNAL_SERVER_ERROR

SERVER_BUSY

public static final IotHubStatusCode SERVER_BUSY

ERROR

public static final IotHubStatusCode ERROR

MESSAGE_EXPIRED

public static final IotHubStatusCode MESSAGE_EXPIRED

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(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:

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

NullPointerException - if the argument is null

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:

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