ErrorCodeDescription Enum
- java.
lang. Object - java.
lang. Enum<ErrorCodeDescription> - com.
microsoft. azure. sdk. iot. service. exceptions. ErrorCodeDescription
- com.
- java.
public 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
Fields
| ArgumentInvalid |
Something in the request payload is invalid. Check the error message for more information about what is invalid. |
| ArgumentNull |
Something in the payload is unexpectedly null. Check the error message for more information about what is invalid. |
| 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. This can be returned on by the service when adding a device to your IoT hub with an Id that is already in use. |
| 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. 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. |
| 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. |
| 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. |
| 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. Check the error message for more information about what is invalid. |
| 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. |
| 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. To resolve this, increase units for this hub to increase the 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. This issue can be fixed by removing the existing module from the device first. |
| 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. |
| 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. 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. |
| 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. |
Inherited Members
Methods
Parse(int errorCode)
public static ErrorCodeDescription Parse(int errorCode)
Get the ErrorCodeDescription tied to the provided errorCode
Parameters
- errorCode
- int
Returns
Applies to
Azure SDK for Java