/
com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.yml
100 lines (100 loc) · 8.35 KB
/
com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException"
name: "IotHubException"
nameWithType: "IotHubException"
summary: "Super class for Iot<wbr>Hub exceptions"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Exception?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Throwable?alt=java.lang.Throwable&text=Throwable\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Throwable.addSuppressed(java.lang.Throwable)?alt=java.lang.Throwable.addSuppressed&text=addSuppressed\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.fillInStackTrace()?alt=java.lang.Throwable.fillInStackTrace&text=fillInStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.getCause()?alt=java.lang.Throwable.getCause&text=getCause\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.getLocalizedMessage()?alt=java.lang.Throwable.getLocalizedMessage&text=getLocalizedMessage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.getMessage()?alt=java.lang.Throwable.getMessage&text=getMessage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.getStackTrace()?alt=java.lang.Throwable.getStackTrace&text=getStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.getSuppressed()?alt=java.lang.Throwable.getSuppressed&text=getSuppressed\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.initCause(java.lang.Throwable)?alt=java.lang.Throwable.initCause&text=initCause\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.printStackTrace()?alt=java.lang.Throwable.printStackTrace&text=printStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.printStackTrace(java.io.PrintStream)?alt=java.lang.Throwable.printStackTrace&text=printStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.printStackTrace(java.io.PrintWriter)?alt=java.lang.Throwable.printStackTrace&text=printStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[])?alt=java.lang.Throwable.setStackTrace&text=setStackTrace\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Throwable.toString()?alt=java.lang.Throwable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **IotHubException**</br> extends <xref href=\"java.lang.Exception?alt=java.lang.Exception&text=Exception\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException()"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException()"
name: "IotHubException()"
nameWithType: "IotHubException.IotHubException()"
summary: "Instantiate a new Iot<wbr>Hub<wbr>Exception with no details."
syntax: "public IotHubException()"
desc: "Instantiate a new IotHubException with no details."
- uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException(int,java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException(int errorCode, String message)"
name: "IotHubException(int errorCode, String message)"
nameWithType: "IotHubException.IotHubException(int errorCode, String message)"
summary: "Instantiate a new Iot<wbr>Hub<wbr>Exception."
parameters:
- description: "the Http status code (200, 401, 404, etc.)"
name: "errorCode"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "the human readable description for why this exception was thrown."
name: "message"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public IotHubException(int errorCode, String message)"
desc: "Instantiate a new IotHubException."
- uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.IotHubException(String message)"
name: "IotHubException(String message)"
nameWithType: "IotHubException.IotHubException(String message)"
summary: "Instantiate a new Iot<wbr>Hub<wbr>Exception."
parameters:
- description: "the human readable description for why this exception was thrown."
name: "message"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public IotHubException(String message)"
desc: "Instantiate a new IotHubException."
fields:
- uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.errorCode"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.errorCode"
name: "errorCode"
nameWithType: "IotHubException.errorCode"
summary: "Provides the HTTP error code, if applicable."
modifiers:
- "protected"
field:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected int errorCode"
desc: "Provides the HTTP error code, if applicable.\n\nThis value will be a 6 digital error code such as 404001 if the service provided one in response message to the HTTP request. Otherwise it will be a 3 digit status code such as 404.\n\nFor AMQP operations such as sending cloud to device messages, receiving message feedback, and getting file upload notifications, this field will not be populated."
- uid: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.errorCodeDescription"
fullName: "com.microsoft.azure.sdk.iot.service.exceptions.IotHubException.errorCodeDescription"
name: "errorCodeDescription"
nameWithType: "IotHubException.errorCodeDescription"
summary: "Provides the HTTP error code description, if applicable."
modifiers:
- "protected"
field:
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.ErrorCodeDescription?alt=com.microsoft.azure.sdk.iot.deps.serializer.ErrorCodeDescription&text=ErrorCodeDescription\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected ErrorCodeDescription errorCodeDescription"
desc: "Provides the HTTP error code description, if applicable.\n\nFor AMQP operations such as sending cloud to device messages, receiving message feedback, and getting file upload notifications, this field will not be populated."
type: "class"
desc: "Super class for IotHub exceptions"
metadata: {}
package: "com.microsoft.azure.sdk.iot.service.exceptions"
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0