com.microsoft.azure.sdk.iot.deps.serializer

Enum ErrorCodeDescription

java.lang.Object

java.lang.Enum<ErrorCodeDescription>

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

All Implemented Interfaces:

Serializable, Comparable<ErrorCodeDescription>

public enum ErrorCodeDescription
extends Enum<ErrorCodeDescription>

See https://docs.microsoft.com/en-us/rest/api/iothub/common-error-codes for additional details

Enum Constant Summary

Enum Constants

Enum Constant and Description
ArgumentInvalid
ArgumentNull
BadFormat
BlobContainerValidationError
BulkRegistryOperationFailure
CannotRegisterModuleToModule
Conflict
ConnectionForcefullyClosedOnNewConnection
DeserializationError
DeviceAlreadyExists
DeviceConnectionClosedRemotely
DeviceDefinedMultipleTimes
DeviceInvalidResultCount
DeviceMaximumQueueDepthExceeded
DeviceMessageLockLost
DeviceNotFound
DeviceNotOnline
DeviceStorageEntitySerializationError
Forbidden
ImportWarningExistsError
InternalServerError
InvalidOperation
InvalidProtocolVersion
InvalidSchemaVersion
InvalidThrottleParameter
IotHubFormatError
IotHubMaxCbsTokenExceeded
IotHubNotFound
IotHubQuotaExceeded
IotHubSuspended
IotHubUnauthorized
IotHubUnauthorizedAccess
JobCancelled
JobNotFound
JobQuotaExceeded
MessageTooLarge
ModuleAlreadyExistsOnDevice
ModuleNotFound
NotFound
PartitionNotFound
PreconditionFailed Represents status code for 429 and for status code 429001
RequestEntityTooLarge
ServerError
ServiceUnavailable Defined for status code 503 and 503001
ThrottleBacklogLimitExceeded
ThrottlingException Represents status code for 429 and 429001
TooManyDevices
TooManyModulesOnDevice
Unauthorized
UnclassifiedErrorCode

Method Summary

Modifier and Type	Method and Description
static ErrorCodeDescription	Parse(int errorCode) Get the ErrorCodeDescription tied to the provided errorCode
static ErrorCodeDescription	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorCodeDescription[]	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

UnclassifiedErrorCode

public static final ErrorCodeDescription UnclassifiedErrorCode

InvalidProtocolVersion

public static final ErrorCodeDescription InvalidProtocolVersion

DeviceInvalidResultCount

public static final ErrorCodeDescription DeviceInvalidResultCount

InvalidOperation

public static final ErrorCodeDescription InvalidOperation

ArgumentInvalid

public static final ErrorCodeDescription ArgumentInvalid

ArgumentNull

public static final ErrorCodeDescription ArgumentNull

IotHubFormatError

public static final ErrorCodeDescription IotHubFormatError

DeviceStorageEntitySerializationError

public static final ErrorCodeDescription DeviceStorageEntitySerializationError

BlobContainerValidationError

public static final ErrorCodeDescription BlobContainerValidationError

ImportWarningExistsError

public static final ErrorCodeDescription ImportWarningExistsError

InvalidSchemaVersion

public static final ErrorCodeDescription InvalidSchemaVersion

DeviceDefinedMultipleTimes

public static final ErrorCodeDescription DeviceDefinedMultipleTimes

DeserializationError

public static final ErrorCodeDescription DeserializationError

BulkRegistryOperationFailure

public static final ErrorCodeDescription BulkRegistryOperationFailure

CannotRegisterModuleToModule

public static final ErrorCodeDescription CannotRegisterModuleToModule

IotHubNotFound

public static final ErrorCodeDescription IotHubNotFound

IotHubUnauthorizedAccess

public static final ErrorCodeDescription IotHubUnauthorizedAccess

IotHubUnauthorized

public static final ErrorCodeDescription IotHubUnauthorized

IotHubSuspended

public static final ErrorCodeDescription IotHubSuspended

IotHubQuotaExceeded

public static final ErrorCodeDescription IotHubQuotaExceeded

JobQuotaExceeded

public static final ErrorCodeDescription JobQuotaExceeded

DeviceMaximumQueueDepthExceeded

public static final ErrorCodeDescription DeviceMaximumQueueDepthExceeded

IotHubMaxCbsTokenExceeded

public static final ErrorCodeDescription IotHubMaxCbsTokenExceeded

DeviceNotFound

public static final ErrorCodeDescription DeviceNotFound

JobNotFound

public static final ErrorCodeDescription JobNotFound

PartitionNotFound

public static final ErrorCodeDescription PartitionNotFound

ModuleNotFound

public static final ErrorCodeDescription ModuleNotFound

DeviceAlreadyExists

public static final ErrorCodeDescription DeviceAlreadyExists

ModuleAlreadyExistsOnDevice

public static final ErrorCodeDescription ModuleAlreadyExistsOnDevice

DeviceMessageLockLost

public static final ErrorCodeDescription DeviceMessageLockLost

MessageTooLarge

public static final ErrorCodeDescription MessageTooLarge

TooManyDevices

public static final ErrorCodeDescription TooManyDevices

TooManyModulesOnDevice

public static final ErrorCodeDescription TooManyModulesOnDevice

ThrottleBacklogLimitExceeded

public static final ErrorCodeDescription ThrottleBacklogLimitExceeded

InvalidThrottleParameter

public static final ErrorCodeDescription InvalidThrottleParameter

ServerError

public static final ErrorCodeDescription ServerError

JobCancelled

public static final ErrorCodeDescription JobCancelled

ConnectionForcefullyClosedOnNewConnection

public static final ErrorCodeDescription ConnectionForcefullyClosedOnNewConnection

DeviceNotOnline

public static final ErrorCodeDescription DeviceNotOnline

DeviceConnectionClosedRemotely

public static final ErrorCodeDescription DeviceConnectionClosedRemotely

BadFormat

public static final ErrorCodeDescription BadFormat

Unauthorized

public static final ErrorCodeDescription Unauthorized

Forbidden

public static final ErrorCodeDescription Forbidden

NotFound

public static final ErrorCodeDescription NotFound

Conflict

public static final ErrorCodeDescription Conflict

PreconditionFailed

public static final ErrorCodeDescription PreconditionFailed

Represents status code for 429 and for status code 429001

RequestEntityTooLarge

public static final ErrorCodeDescription RequestEntityTooLarge

ThrottlingException

public static final ErrorCodeDescription ThrottlingException

Represents status code for 429 and 429001

InternalServerError

public static final ErrorCodeDescription InternalServerError

ServiceUnavailable

public static final ErrorCodeDescription ServiceUnavailable

Defined for status code 503 and 503001

Method Detail

values

public static ErrorCodeDescription[] 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 (ErrorCodeDescription c : ErrorCodeDescription.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorCodeDescription 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

Parse

public static ErrorCodeDescription Parse(int errorCode)

Get the ErrorCodeDescription tied to the provided errorCode

Parameters:

errorCode - the service error code, such as 404, or 429001

Returns:

the corresponding ErrorCodeDescription