/
com.microsoft.azure.sdk.iot.device.MessageProperty.yml
224 lines (224 loc) · 12.4 KB
/
com.microsoft.azure.sdk.iot.device.MessageProperty.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.device.MessageProperty"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty"
name: "MessageProperty"
nameWithType: "MessageProperty"
summary: "An IoT Hub message property."
inheritances:
- "<xref href=\"java.lang.Object?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.toString()?alt=java.lang.Object.toString&text=toString\" 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\" />"
syntax: "public final class **MessageProperty**"
constructors:
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty()"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty()"
name: "MessageProperty()"
nameWithType: "MessageProperty.MessageProperty()"
modifiers:
- "protected"
syntax: "protected MessageProperty()"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty(String name, String value)"
name: "MessageProperty(String name, String value)"
nameWithType: "MessageProperty.MessageProperty(String name, String value)"
summary: "Constructor."
parameters:
- description: "The IoT Hub message property name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The IoT Hub message property value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MessageProperty(String name, String value)"
desc: "Constructor."
fields:
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_DEVICE_ID"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_DEVICE_ID"
name: "CONNECTION_DEVICE_ID"
nameWithType: "MessageProperty.CONNECTION_DEVICE_ID"
modifiers:
- "static"
- "final"
field:
value: "iothub-connection-device-id"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String CONNECTION_DEVICE_ID"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_MODULE_ID"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_MODULE_ID"
name: "CONNECTION_MODULE_ID"
nameWithType: "MessageProperty.CONNECTION_MODULE_ID"
modifiers:
- "static"
- "final"
field:
value: "iothub-connection-module-id"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String CONNECTION_MODULE_ID"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_ENCODING"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_ENCODING"
name: "IOTHUB_CONTENT_ENCODING"
nameWithType: "MessageProperty.IOTHUB_CONTENT_ENCODING"
modifiers:
- "static"
- "final"
field:
value: "iothub-contentencoding"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String IOTHUB_CONTENT_ENCODING"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_TYPE"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_TYPE"
name: "IOTHUB_CONTENT_TYPE"
nameWithType: "MessageProperty.IOTHUB_CONTENT_TYPE"
modifiers:
- "static"
- "final"
field:
value: "iothub-contenttype"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String IOTHUB_CONTENT_TYPE"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CREATION_TIME_UTC"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CREATION_TIME_UTC"
name: "IOTHUB_CREATION_TIME_UTC"
nameWithType: "MessageProperty.IOTHUB_CREATION_TIME_UTC"
modifiers:
- "static"
- "final"
field:
value: "iothub-creation-time-utc"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String IOTHUB_CREATION_TIME_UTC"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
name: "IOTHUB_SECURITY_INTERFACE_ID"
nameWithType: "MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
modifiers:
- "static"
- "final"
field:
value: "iothub-interface-id"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String IOTHUB_SECURITY_INTERFACE_ID"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
name: "IOTHUB_SECURITY_INTERFACE_ID_VALUE"
nameWithType: "MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
modifiers:
- "static"
- "final"
field:
value: "urn:azureiot:Security:SecurityAgent:1"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String IOTHUB_SECURITY_INTERFACE_ID_VALUE"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.OUTPUT_NAME_PROPERTY"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.OUTPUT_NAME_PROPERTY"
name: "OUTPUT_NAME_PROPERTY"
nameWithType: "MessageProperty.OUTPUT_NAME_PROPERTY"
modifiers:
- "static"
- "final"
field:
value: "iothub-outputname"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final String OUTPUT_NAME_PROPERTY"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.RESERVED_PROPERTY_NAMES"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.RESERVED_PROPERTY_NAMES"
name: "RESERVED_PROPERTY_NAMES"
nameWithType: "MessageProperty.RESERVED_PROPERTY_NAMES"
summary: "A set of reserved property names."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public static final Set<String> RESERVED_PROPERTY_NAMES"
desc: "A set of reserved property names. The reserved property names are interpreted in a meaningful way by the device and the IoT Hub."
methods:
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.getName()"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.getName()"
name: "getName()"
nameWithType: "MessageProperty.getName()"
summary: "Returns the property name."
syntax: "public String getName()"
desc: "Returns the property name."
returns:
description: "the property name."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.getValue()"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.getValue()"
name: "getValue()"
nameWithType: "MessageProperty.getValue()"
summary: "Returns the property value."
syntax: "public String getValue()"
desc: "Returns the property value."
returns:
description: "the property value."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.hasSameName(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.hasSameName(String name)"
name: "hasSameName(String name)"
nameWithType: "MessageProperty.hasSameName(String name)"
summary: "Equivalent to property.<wbr>get<wbr>Name().equals<wbr>Ignore<wbr>Case(name)."
parameters:
- description: "the property name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public boolean hasSameName(String name)"
desc: "Equivalent to property.getName().equalsIgnoreCase(name)."
returns:
description: "true if the given name is the property name."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidAppProperty(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidAppProperty(String name, String value)"
name: "isValidAppProperty(String name, String value)"
nameWithType: "MessageProperty.isValidAppProperty(String name, String value)"
summary: "Returns whether the property is a valid application property."
modifiers:
- "static"
parameters:
- description: "the property name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the property value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static boolean isValidAppProperty(String name, String value)"
desc: "Returns whether the property is a valid application property. The property is valid if it is not one of the reserved properties, only uses US-ASCII"
returns:
description: "whether the property is a valid application property."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidSystemProperty(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidSystemProperty(String name, String value)"
name: "isValidSystemProperty(String name, String value)"
nameWithType: "MessageProperty.isValidSystemProperty(String name, String value)"
summary: "Returns whether the property is a valid system property."
modifiers:
- "static"
parameters:
- description: "the property name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the property value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static boolean isValidSystemProperty(String name, String value)"
desc: "Returns whether the property is a valid system property. The property is valid if it is one of the reserved properties and only uses US-ASCII"
returns:
description: "whether the property is a valid system property."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An IoT Hub message property."
metadata: {}
package: "com.microsoft.azure.sdk.iot.device"
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1