ErrorCodeDescription (Iot Hub Java Service SDK 2.1.9 API)

java.lang.Object
- java.lang.Enum<ErrorCodeDescription>
- - com.microsoft.azure.sdk.iot.service.exceptions.ErrorCodeDescription

All Implemented Interfaces:

Serializable, Comparable<ErrorCodeDescription>
```
public enum ErrorCodeDescription
extends Enum<ErrorCodeDescription>
```
The descriptions for all the possible 6 digit and 3 digit error codes returned by IoT hub for service calls. 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` Something in the request payload is invalid.
`ArgumentNull` Something in the payload is unexpectedly null.
`BadFormat` The general error for malformed service requests.
`BulkRegistryOperationFailure` An error was encountered processing bulk registry operations.
`Conflict` The general error for service requests that failed because the resource already exists.
`DeviceAlreadyExists` There's already a device with the same device Id in the IoT hub.
`DeviceDefinedMultipleTimes` A devices with the same Id was present multiple times in the input request for bulk device registry operations.
`DeviceMaximumQueueDepthExceeded` The underlying cause is that the number of cloud-to-device messages enqueued for the device exceeds the queue limit.
`DeviceNotFound` The operation failed because the device cannot be found by IoT hub.
`DeviceNotOnline` IoT hub failed to invoke the direct method because the target device was not connected at the time.
`Forbidden` The general error for forbidden service requests.
`InternalServerError` The general error for service requests that failed because the service encountered an error.
`InvalidOperation` The client has requested an operation that the hub recognizes as invalid.
`InvalidProtocolVersion` The API version used by the SDK is not supported by the IoT hub endpoint used in this connection.
`IotHubFormatError` Returned by the service if a JSON object provided by this library cannot be parsed, for instance, if the JSON provided for updating a twin is malformed.
`IotHubQuotaExceeded` Total number of messages on the hub exceeded the allocated quota.
`IotHubUnauthorizedAccess` The SAS token has expired or IoT hub couldn't authenticate the authentication header, rule, or key.
`MessageTooLarge` When the message that you attempted to send is too large for IoT hub you will receive this error.
`ModuleAlreadyExistsOnDevice` The operation failed because it attempted to add a module to a device when that device already has a module registered to it with the same Id.
`ModuleNotFound` The operation failed because the module cannot be found by IoT hub.
`NotFound` The general error for service requests that failed because a resource could not be found.
`PreconditionFailed` The general error for when a service request fails because it provided an out of date ETag such as when updating a twin.
`RequestEntityTooLarge` The general error for service requests that failed because a service request contained a resource that was larger than the service allows.
`ServerError` IoT hub encountered a service-side issue.
`ServiceUnavailable` The general error for service requests that failed because the service isn't available at the moment.
`ThrottleBacklogLimitExceeded` IoT hub throttling limits have been exceeded for the requested operation.
`ThrottlingException` IoT hub throttling limits have been exceeded for the requested operation.
`TooManyDevices` Too many devices were included in the bulk operation.
`Unauthorized` The general error for unauthorized service requests.
`UnclassifiedErrorCode` This library could not classify the received error code into a known description.

Method Summary

All Methods Static Methods Concrete Methods
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
```
    This library could not classify the received error code into a known description.
  - InvalidProtocolVersion
```
public static final ErrorCodeDescription InvalidProtocolVersion
```
    The API version used by the SDK is not supported by the IoT hub endpoint used in this connection. Usually this would mean that the region of the hub doesn't yet support the API version. One should consider downgrading to a previous version of the SDK that uses an older API version, or use a hub in a region that supports it.
  - InvalidOperation
```
public static final ErrorCodeDescription InvalidOperation
```
    The client has requested an operation that the hub recognizes as invalid. Check the error message for more information about what is invalid.
  - ArgumentInvalid
```
public static final ErrorCodeDescription ArgumentInvalid
```
    Something in the request payload is invalid. Check the error message for more information about what is invalid.
  - ArgumentNull
```
public static final ErrorCodeDescription ArgumentNull
```
    Something in the payload is unexpectedly null. Check the error message for more information about what is invalid.
  - IotHubFormatError
```
public static final ErrorCodeDescription IotHubFormatError
```
    Returned by the service if a JSON object provided by this library cannot be parsed, for instance, if the JSON provided for updating a twin is malformed.
  - DeviceDefinedMultipleTimes
```
public static final ErrorCodeDescription DeviceDefinedMultipleTimes
```
    A devices with the same Id was present multiple times in the input request for bulk device registry operations.
    
    See Also:
    
    Bulk registry operations
  - BulkRegistryOperationFailure
```
public static final ErrorCodeDescription BulkRegistryOperationFailure
```
    An error was encountered processing bulk registry operations.
  - IotHubUnauthorizedAccess
```
public static final ErrorCodeDescription IotHubUnauthorizedAccess
```
    The SAS token has expired or IoT hub couldn't authenticate the authentication header, rule, or key.
    
    See Also:
    
    More details
  - IotHubQuotaExceeded
```
public static final ErrorCodeDescription IotHubQuotaExceeded
```
    Total number of messages on the hub exceeded the allocated quota. To resolve this, increase units for this hub to increase the quota.
    
    See Also:
    
    More details on throttling limits.
  - DeviceMaximumQueueDepthExceeded
```
public static final ErrorCodeDescription DeviceMaximumQueueDepthExceeded
```
    The underlying cause is that the number of cloud-to-device messages enqueued for the device exceeds the queue limit. To resolve this issue, you will need to make sure your device is actively completing or abandoning the currently queued messages, or you will need to purge the cloud to device message queue.
    
    See Also:
    
    More details on cloud to device messaging
  - DeviceNotFound
```
public static final ErrorCodeDescription DeviceNotFound
```
    The operation failed because the device cannot be found by IoT hub. The device is either not registered or disabled. May be thrown by operations such as getting a device by id.
  - ModuleNotFound
```
public static final ErrorCodeDescription ModuleNotFound
```
    The operation failed because the module cannot be found by IoT hub. The module is either not registered or disabled. May be thrown by operations such as getting a module by id.
  - DeviceAlreadyExists
```
public static final ErrorCodeDescription DeviceAlreadyExists
```
    There's already a device with the same device Id in the IoT hub. This can be returned on by the service when adding a device to your IoT hub with an Id that is already in use.
  - ModuleAlreadyExistsOnDevice
```
public static final ErrorCodeDescription ModuleAlreadyExistsOnDevice
```
    The operation failed because it attempted to add a module to a device when that device already has a module registered to it with the same Id. This issue can be fixed by removing the existing module from the device first.
  - MessageTooLarge
```
public static final ErrorCodeDescription MessageTooLarge
```
    When the message that you attempted to send is too large for IoT hub you will receive this error.
    
    See Also:
    
    More details on message size limits
  - TooManyDevices
```
public static final ErrorCodeDescription TooManyDevices
```
    Too many devices were included in the bulk operation.
    
    See Also:
    
    More details on device count limits
  - ThrottleBacklogLimitExceeded
```
public static final ErrorCodeDescription ThrottleBacklogLimitExceeded
```
    IoT hub throttling limits have been exceeded for the requested operation.
    
    See Also:
    
    More details on throttling limits.
  - ServerError
```
public static final ErrorCodeDescription ServerError
```
    IoT hub encountered a service-side issue. There can be a number of causes for a 500xxx error response. In all cases, the issue is most likely transient. IoT hub nodes can occasionally experience transient faults. When your application tries to connect to a node that is having issues, you receive this error. To mitigate 500xxx errors, issue a retry from your application.
  - DeviceNotOnline
```
public static final ErrorCodeDescription DeviceNotOnline
```
    IoT hub failed to invoke the direct method because the target device was not connected at the time. To resolve this issue, you will need to make sure that your device is connected.
  - BadFormat
```
public static final ErrorCodeDescription BadFormat
```
    The general error for malformed service requests.
  - Unauthorized
```
public static final ErrorCodeDescription Unauthorized
```
    The general error for unauthorized service requests.
  - Forbidden
```
public static final ErrorCodeDescription Forbidden
```
    The general error for forbidden service requests.
  - NotFound
```
public static final ErrorCodeDescription NotFound
```
    The general error for service requests that failed because a resource could not be found.
  - Conflict
```
public static final ErrorCodeDescription Conflict
```
    The general error for service requests that failed because the resource already exists.
  - PreconditionFailed
```
public static final ErrorCodeDescription PreconditionFailed
```
    The general error for when a service request fails because it provided an out of date ETag such as when updating a twin.
  - RequestEntityTooLarge
```
public static final ErrorCodeDescription RequestEntityTooLarge
```
    The general error for service requests that failed because a service request contained a resource that was larger than the service allows.
  - ThrottlingException
```
public static final ErrorCodeDescription ThrottlingException
```
    IoT hub throttling limits have been exceeded for the requested operation.
    
    See Also:
    
    More details on throttling limits.
  - InternalServerError
```
public static final ErrorCodeDescription InternalServerError
```
    The general error for service requests that failed because the service encountered an error.
  - ServiceUnavailable
```
public static final ErrorCodeDescription ServiceUnavailable
```
    The general error for service requests that failed because the service isn't available at the moment.
- 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

Enum ErrorCodeDescription

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UnclassifiedErrorCode

InvalidProtocolVersion

InvalidOperation

ArgumentInvalid

ArgumentNull

IotHubFormatError

DeviceDefinedMultipleTimes

BulkRegistryOperationFailure

IotHubUnauthorizedAccess

IotHubQuotaExceeded

DeviceMaximumQueueDepthExceeded

DeviceNotFound

ModuleNotFound

DeviceAlreadyExists

ModuleAlreadyExistsOnDevice

MessageTooLarge

TooManyDevices

ThrottleBacklogLimitExceeded

ServerError

DeviceNotOnline

BadFormat

Unauthorized

Forbidden

NotFound

Conflict

PreconditionFailed

RequestEntityTooLarge

ThrottlingException

InternalServerError

ServiceUnavailable

Method Detail

values

valueOf

Parse