IotHubConnectionString Class

Definition

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

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

Inherited Members

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

getUrlConfiguration(String configurationId)

Create url for requesting configuration data

getUrlConfigurationsList(Integer maxCount)

Create url for requesting configuration data

getUrlCreateExportImportJob()

Create url for processing a bulk import/export job

getUrlDevice(String deviceId)

Create url for requesting device data

getUrlDeviceList(Integer maxCount)

Create url for requesting device list

getUrlDeviceStatistics()

Create url for requesting device statistics

getUrlImportExportJob(String jobId)
getUrlJobs(String jobId)

Create url for requesting jobs

getUrlJobsCancel(String jobId)

Create url for cancelling jobs

getUrlMethod(String deviceId)

Create url for requesting device method

getUrlModule(String deviceId, String moduleId)

Create url for requesting module data

getUrlModuleMethod(String deviceId, String moduleId)

Create url for requesting device method for module

getUrlModuleTwin(String deviceId, String moduleId)

Create url for requesting module twin

getUrlModulesOnDevice(String deviceId)

Create url for requesting all modules data on a device

getUrlQuery(String jobType, String jobStatus)

Create url for querying

getUrlTwin(String deviceId)

Create url for requesting device twin

getUrlTwinQuery()

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