IotHubConnectionString Class

  • Reference

Definition

Package:
com.microsoft.azure.sdk.iot.service
Maven Artifact:
com.microsoft.azure.sdk.iot:iot-service-client:1.30.0

Expose all connections string properties and methods for user, device and connection string serialization.

public class IotHubConnectionString extends IotHubConnectionStringBuilder
Inheritance
java.lang.Object
IotHubConnectionStringBuilder
IotHubConnectionString

Inherited Members

IotHubConnectionStringBuilder.createConnectionString(String connectionString) IotHubConnectionStringBuilder.createConnectionString(String hostName, AuthenticationMethod authenticationMethod) IotHubConnectionStringBuilder.createIotHubConnectionString(String connectionString) IotHubConnectionStringBuilder.createIotHubConnectionString(String hostName, AuthenticationMethod authenticationMethod) IotHubConnectionStringBuilder.parse(String connectionString, IotHubConnectionString iotHubConnectionString) IotHubConnectionStringBuilder.parseIotHubName(IotHubConnectionString iotHubConnectionString) IotHubConnectionStringBuilder.setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString) IotHubConnectionStringBuilder.setHostName(String hostName, IotHubConnectionString iotHubConnectionString) IotHubConnectionStringBuilder.validate(IotHubConnectionString iotHubConnectionString) IotHubConnectionStringBuilder.validateFormat(String value, String regex) IotHubConnectionStringBuilder.validateFormatIfSpecified(String value, String regex) java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

IotHubConnectionString()

Fields

HOST_NAME_PROPERTY_NAME
HOST_NAME_SEPARATOR
SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
SHARED_ACCESS_KEY_PROPERTY_NAME
SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
VALUE_PAIR_DELIMITER
VALUE_PAIR_SEPARATOR
authenticationMethod
hostName
iotHubName
sharedAccessKey
sharedAccessKeyName
sharedAccessSignature

Methods

getAuthenticationMethod()

Getter for authenticationMethod
getHostName()

Getter for hostName
getIotHubName()

Getter for iotHubName
getSharedAccessKey()

Getter for sharedAccessKey
getSharedAccessKeyName()

Getter for sharedAccessKeyName
getSharedAccessSignature()

Getter for sharedAccessSignature
getUrlApplyConfigurationContent(String deviceId)

Create the url needed to apply some configuration content to a device
getUrlApplyConfigurationContent(String hostName, String deviceId)

Create the url needed to apply some configuration content to a device
getUrlConfiguration(String configurationId)

Create url for requesting configuration data
getUrlConfiguration(String hostName, String configurationId)

Create url for requesting configuration data
getUrlConfigurationsList(Integer maxCount)

Create url for requesting configuration data
getUrlConfigurationsList(String hostName, Integer maxCount)

Create url for requesting configuration data
getUrlCreateExportImportJob()

Create url for processing a bulk import/export job
getUrlCreateExportImportJob(String hostName)

Create url for processing a bulk import/export job
getUrlDevice(String deviceId)

Create url for requesting device data
getUrlDevice(String hostName, String deviceId)

Create url for requesting device data
getUrlDeviceList(Integer maxCount)

Create url for requesting device list
getUrlDeviceList(String hostName, Integer maxCount)

Create url for requesting device list
getUrlDeviceStatistics()

Create url for requesting device statistics
getUrlDeviceStatistics(String hostName)

Create url for requesting device statistics
getUrlImportExportJob(String jobId)
getUrlImportExportJob(String hostName, String jobId)
getUrlJobs(String jobId)

Create url for requesting jobs
getUrlJobs(String hostName, String jobId)

Create url for requesting jobs
getUrlJobsCancel(String jobId)

Create url for cancelling jobs
getUrlJobsCancel(String hostName, String jobId)

Create url for cancelling jobs
getUrlMethod(String deviceId)

Create url for requesting device method
getUrlMethod(String hostName, String deviceId)

Create url for requesting device method
getUrlModule(String deviceId, String moduleId)

Create url for requesting module data
getUrlModule(String hostName, String deviceId, String moduleId)

Create url for requesting module data
getUrlModuleMethod(String deviceId, String moduleId)

Create url for requesting device method for module
getUrlModuleMethod(String hostName, String deviceId, String moduleId)

Create url for requesting device method for module
getUrlModuleTwin(String deviceId, String moduleId)

Create url for requesting module twin
getUrlModuleTwin(String hostName, String deviceId, String moduleId)

Create url for requesting module twin
getUrlModulesOnDevice(String deviceId)

Create url for requesting all modules data on a device
getUrlModulesOnDevice(String hostName, String deviceId)

Create url for requesting all modules data on a device
getUrlQuery(String jobType, String jobStatus)

Create url for querying
getUrlQuery(String hostName, String jobType, String jobStatus)

Create url for querying
getUrlTwin(String deviceId)

Create url for requesting device twin
getUrlTwin(String hostName, String deviceId)

Create url for requesting device twin
getUrlTwinQuery()

Create url for querying twin
getUrlTwinQuery(String hostName)

Create url for querying twin
getUserString()

Serialize user string
setSharedAccessKey(String sharedAccessKey)

Setter for sharedAccessKey
setSharedAccessKeyName(String sharedAccessKeyName)

Setter for sharedAccessKeyName
setSharedAccessSignature(String sharedAccessSignature)

Setter for sharedAccessSignature
toString()

Serialize connection string

Applies to