164 строки
11 KiB
YAML
164 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri"
|
|
name: "IotHubUri"
|
|
nameWithType: "IotHubUri"
|
|
summary: "A URI for a device to connect to an IoT Hub."
|
|
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 **IotHubUri**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri()"
|
|
name: "IotHubUri()"
|
|
nameWithType: "IotHubUri.IotHubUri()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected IotHubUri()"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, String moduleId)"
|
|
name: "IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, String moduleId)"
|
|
nameWithType: "IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, String moduleId)"
|
|
summary: "Constructor."
|
|
parameters:
|
|
- description: "the IoT Hub hostname."
|
|
name: "iotHubHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the device ID."
|
|
name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the path from the IoT Hub resource to the\n method."
|
|
name: "iotHubMethodPath"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the module ID."
|
|
name: "moduleId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, String moduleId)"
|
|
desc: "Constructor. Equivalent to `new IotHubUri(iotHubHostname, deviceId, iotHubMethodPath, null)`."
|
|
- uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri(java.lang.String,java.lang.String,java.lang.String,java.util.Map<java.lang.String,java.lang.String>,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String,String> queryParams, String moduleId)"
|
|
name: "IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String,String> queryParams, String moduleId)"
|
|
nameWithType: "IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String,String> queryParams, String moduleId)"
|
|
summary: "Constructor."
|
|
parameters:
|
|
- description: "the IoT Hub hostname."
|
|
name: "iotHubHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the device ID."
|
|
name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the path from the IoT Hub resource to the\n method."
|
|
name: "iotHubMethodPath"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the URL query parameters. Can be null."
|
|
name: "queryParams"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the module ID. May be null"
|
|
name: "moduleId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String,String> queryParams, String moduleId)"
|
|
desc: "Constructor. Creates a URI to an IoT Hub method. The URI does not include a protocol. The function will safely escape the given arguments."
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.API_VERSION"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.API_VERSION"
|
|
name: "API_VERSION"
|
|
nameWithType: "IotHubUri.API_VERSION"
|
|
summary: "The API version will be passed as a param in the URI."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "api-version=2020-09-30"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String API_VERSION"
|
|
desc: "The API version will be passed as a param in the URI."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.getApiVersionString()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.getApiVersionString()"
|
|
name: "getApiVersionString()"
|
|
nameWithType: "IotHubUri.getApiVersionString()"
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static String getApiVersionString()"
|
|
returns:
|
|
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.net.IotHubUri.getHostname()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.getHostname()"
|
|
name: "getHostname()"
|
|
nameWithType: "IotHubUri.getHostname()"
|
|
summary: "Returns the string representation of the IoT Hub hostname."
|
|
syntax: "public String getHostname()"
|
|
desc: "Returns the string representation of the IoT Hub hostname."
|
|
returns:
|
|
description: "the string representation of the IoT Hub hostname."
|
|
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.net.IotHubUri.getPath()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.getPath()"
|
|
name: "getPath()"
|
|
nameWithType: "IotHubUri.getPath()"
|
|
summary: "Returns the string representation of the IoT Hub path."
|
|
syntax: "public String getPath()"
|
|
desc: "Returns the string representation of the IoT Hub path."
|
|
returns:
|
|
description: "the string representation of the IoT Hub path."
|
|
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.net.IotHubUri.getResourceUri(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.getResourceUri(String iotHubHostname, String deviceId, String moduleId)"
|
|
name: "getResourceUri(String iotHubHostname, String deviceId, String moduleId)"
|
|
nameWithType: "IotHubUri.getResourceUri(String iotHubHostname, String deviceId, String moduleId)"
|
|
summary: "Returns the string representation of the IoT Hub resource URI."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the IoT Hub hostname."
|
|
name: "iotHubHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the device ID."
|
|
name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the module ID."
|
|
name: "moduleId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static String getResourceUri(String iotHubHostname, String deviceId, String moduleId)"
|
|
desc: "Returns the string representation of the IoT Hub resource URI. The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub. Safely escapes the IoT Hub resource URI."
|
|
returns:
|
|
description: "the string representation of the IoT Hub resource URI."
|
|
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.net.IotHubUri.toString()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.toString()"
|
|
name: "toString()"
|
|
nameWithType: "IotHubUri.toString()"
|
|
summary: "Returns the string representation of the IoT Hub URI."
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
desc: "Returns the string representation of the IoT Hub URI."
|
|
returns:
|
|
description: "the string representation of the IoT Hub URI."
|
|
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.net.IotHubUri.toStringWithoutApiVersion()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.net.IotHubUri.toStringWithoutApiVersion()"
|
|
name: "toStringWithoutApiVersion()"
|
|
nameWithType: "IotHubUri.toStringWithoutApiVersion()"
|
|
syntax: "public String toStringWithoutApiVersion()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A URI for a device to connect to an IoT Hub."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.net"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|