Modifier and Type | Method and Description |
---|---|
Configuration |
RegistryManager.addConfiguration(Configuration configuration)
Add configuration using the given Configuration object
Return with the response configuration object from IotHub
|
Device |
RegistryManager.addDevice(Device device)
Add device using the given Device object
Return with the response device object from IotHub
|
CompletableFuture<Device> |
RegistryManager.addDeviceAsync(Device device)
Async wrapper for add() operation
|
Module |
RegistryManager.addModule(Module module)
Add module using the given Module object
Return with the response module object from IotHub
|
void |
RegistryManager.applyConfigurationContentOnDevice(String deviceId,
ConfigurationContent content)
Apply the provided configuration content to the provided device
|
JobProperties |
RegistryManager.exportDevices(JobProperties exportDevicesParameters)
Create a bulk export job.
|
JobProperties |
RegistryManager.exportDevices(String exportBlobContainerUri,
Boolean excludeKeys)
Create a bulk export job.
|
CompletableFuture<JobProperties> |
RegistryManager.exportDevicesAsync(JobProperties exportDevicesParameters)
Async wrapper for exportDevices() operation
|
CompletableFuture<JobProperties> |
RegistryManager.exportDevicesAsync(String exportBlobContainerUri,
Boolean excludeKeys)
Async wrapper for exportDevices() operation
|
Configuration |
RegistryManager.getConfiguration(String configurationId)
Get configuration by configuration Id from IotHub
|
List<Configuration> |
RegistryManager.getConfigurations(Integer maxCount)
Get list of Configuration
|
Device |
RegistryManager.getDevice(String deviceId)
Get device data by device Id from IotHub
|
CompletableFuture<Device> |
RegistryManager.getDeviceAsync(String deviceId)
Async wrapper for getDevice() operation
|
ArrayList<Device> |
RegistryManager.getDevices(Integer maxCount)
Deprecated.
as of release 1.12.0. Please use
DeviceTwin.queryTwin(String sqlQuery, Integer pageSize)
to query for all devices. |
CompletableFuture<ArrayList<Device>> |
RegistryManager.getDevicesAsync(Integer maxCount)
Deprecated.
as of release 1.12.0. Please use
DeviceTwin.queryTwin(String sqlQuery, Integer pageSize)
to query for all devices. |
JobProperties |
RegistryManager.getJob(String jobId)
Get the properties of an existing job.
|
CompletableFuture<JobProperties> |
RegistryManager.getJobAsync(String jobId)
Async wrapper for getJob() operation
|
Module |
RegistryManager.getModule(String deviceId,
String moduleId)
Get module data by device Id and module Id from IotHub
|
List<Module> |
RegistryManager.getModulesOnDevice(String deviceId)
Get modules data by device Id from IotHub
|
RegistryStatistics |
RegistryManager.getStatistics()
Get device statistics
|
CompletableFuture<RegistryStatistics> |
RegistryManager.getStatisticsAsync()
Async wrapper for getStatistics() operation
|
JobProperties |
RegistryManager.importDevices(JobProperties importDevicesParameters)
Create a bulk import job.
|
JobProperties |
RegistryManager.importDevices(String importBlobContainerUri,
String outputBlobContainerUri)
Create a bulk import job.
|
CompletableFuture<JobProperties> |
RegistryManager.importDevicesAsync(JobProperties importParameters)
Async wrapper for importDevices() operation
|
CompletableFuture<JobProperties> |
RegistryManager.importDevicesAsync(String importBlobContainerUri,
String outputBlobContainerUri)
Async wrapper for importDevices() operation
|
void |
RegistryManager.removeConfiguration(Configuration config)
Send remove configuration request and verify response
|
void |
RegistryManager.removeConfiguration(String configurationId)
Send remove configuration request and verify response
|
void |
RegistryManager.removeDevice(Device device)
Remove device
|
void |
RegistryManager.removeDevice(String deviceId)
Remove device
|
CompletableFuture<Boolean> |
RegistryManager.removeDeviceAsync(String deviceId)
Async wrapper for removeDevice() operation
|
void |
RegistryManager.removeModule(Module module)
Remove module
|
void |
RegistryManager.removeModule(String deviceId,
String moduleId)
Remove module
|
void |
ServiceClient.send(String deviceId,
Message message)
Send a one-way message to the specified device
|
void |
ServiceClient.send(String deviceId,
String moduleId,
Message message)
Send a one-way message to the specified module
|
Configuration |
RegistryManager.updateConfiguration(Configuration configuration)
Update configuration not forced
|
Configuration |
RegistryManager.updateConfiguration(Configuration configuration,
Boolean forceUpdate)
Update configuration with forceUpdate input parameter
|
Device |
RegistryManager.updateDevice(Device device)
Update device not forced
|
Device |
RegistryManager.updateDevice(Device device,
Boolean forceUpdate)
Update device with forceUpdate input parameter
|
CompletableFuture<Device> |
RegistryManager.updateDeviceAsync(Device device)
Async wrapper for updateDevice() operation
|
CompletableFuture<Device> |
RegistryManager.updateDeviceAsync(Device device,
Boolean forceUpdate)
Async wrapper for forced updateDevice() operation
|
Module |
RegistryManager.updateModule(Module module)
Update module not forced
|
Module |
RegistryManager.updateModule(Module module,
Boolean forceUpdate)
Update module with forceUpdate input parameter
|
Modifier and Type | Method and Description |
---|---|
JobResult |
Job.cancel()
Cancel a current jod on the IoTHub
|
JobResult |
Job.get()
Get the current job status on the iotHub.
|
DeviceTwinDevice |
DeviceTwin.getNextDeviceTwin(Query deviceTwinQuery)
Returns the next device twin document
|
void |
DeviceTwin.getTwin(DeviceTwinDevice device)
This method retrieves device twin for the specified device.
|
boolean |
Query.hasNext()
Returns the availability of next element in the query response
|
boolean |
RawTwinQuery.hasNext(Query query)
Returns the availability of next element in response.
|
boolean |
DeviceTwin.hasNextDeviceTwin(Query deviceTwinQuery)
Returns the availability of next twin element upon query.
|
MethodResult |
DeviceMethod.invoke(String deviceId,
String methodName,
Long responseTimeoutInSeconds,
Long connectTimeoutInSeconds,
Object payload)
Directly invokes a method on the device and return its result.
|
MethodResult |
DeviceMethod.invoke(String deviceId,
String moduleId,
String methodName,
Long responseTimeoutInSeconds,
Long connectTimeoutInSeconds,
Object payload)
Directly invokes a method on the module and return its result.
|
protected QueryCollectionResponse<String> |
QueryCollection.next()
Returns the next QueryCollectionResponse object.
|
Object |
Query.next()
provides the next element in query response
|
String |
RawTwinQuery.next(Query query)
Returns the next json element available in response
|
QueryCollectionResponse<DeviceTwinDevice> |
DeviceTwin.next(QueryCollection deviceTwinQueryCollection)
Returns the next DeviceTwinDevice collection for the given query alongside the continuation token needed for querying the next page.
|
QueryCollectionResponse<DeviceTwinDevice> |
DeviceTwin.next(QueryCollection deviceTwinQueryCollection,
QueryOptions options)
Returns the next DeviceTwinDevice collection for the given query alongside the continuation token needed for querying the next page.
|
protected QueryCollectionResponse<String> |
QueryCollection.next(QueryOptions options)
Returns the next QueryCollectionResponse object.
|
Query |
RawTwinQuery.query(String sqlQuery)
Creates a query object for this query using default page size
|
Query |
RawTwinQuery.query(String sqlQuery,
Integer pageSize)
Creates a query object for this query
|
Query |
DeviceTwin.queryTwin(String sqlQuery)
Sql style query for twin
|
Query |
DeviceTwin.queryTwin(String sqlQuery,
Integer pageSize)
Sql style query for twin
|
static HttpResponse |
DeviceOperations.request(IotHubConnectionString iotHubConnectionString,
URL url,
HttpMethod method,
byte[] payload,
String requestId,
long timeoutInMs)
Send a http request to the IoTHub using the Twin/Method standard, and return its response.
|
Job |
DeviceMethod.scheduleDeviceMethod(String queryCondition,
String methodName,
Long responseTimeoutInSeconds,
Long connectTimeoutInSeconds,
Object payload,
Date startTimeUtc,
long maxExecutionTimeInSeconds)
Creates a new Job to invoke method on one or multiple devices
|
Job |
DeviceTwin.scheduleUpdateTwin(String queryCondition,
DeviceTwinDevice updateTwin,
Date startTimeUtc,
long maxExecutionTimeInSeconds)
Creates a new Job to update twin tags and desired properties on one or multiple devices
|
QueryResponse |
Query.sendQueryRequest(IotHubConnectionString iotHubConnectionString,
URL url,
HttpMethod method,
Long timeoutInMs)
Sends request for the query to the IotHub
|
void |
DeviceTwin.updateTwin(DeviceTwinDevice device)
This method updates device twin for the specified device.
|
Modifier and Type | Class and Description |
---|---|
class |
IotHubBadFormatException
Create bad message format exception
|
class |
IotHubBadGatewayException
Create bad gateway exception (device sent malformed response)
|
class |
IotHubConflictException
409 Conflict
Likely caused by trying to create a resource that already exists
|
class |
IotHubDeviceMaximumQueueDepthExceededException
Create iot hub device maximum queue depth exceeded exception
|
class |
IotHubDeviceNotFoundException
Create iot hub not found exception
|
class |
IotHubGatewayTimeoutException
Create gateway timeout exception (device does not answer in time)
|
class |
IotHubInternalServerErrorException
Create internal server error exception
|
class |
IotHubInvalidOperationException
Create iot hub invalid operation exception
|
class |
IotHubMessageTooLargeException
Create iot hub Message too large exception
|
class |
IotHubNotFoundException
Create iot hub not found exception
|
class |
IotHubNotSupportedException
Create iot hub not found exception
|
class |
IotHubPreconditionFailedException
Create precondition failed exception
|
class |
IotHubServerBusyException
Create server busy exception
|
class |
IotHubTooManyDevicesException
Create too many devices exception
|
class |
IotHubTooManyRequestsException
Create too many requests exception
|
class |
IotHubUnathorizedException
Create unauthorized exception
|
Modifier and Type | Method and Description |
---|---|
static void |
IotHubExceptionManager.httpResponseVerification(HttpResponse httpResponse)
Verify Http response using response status
|
Modifier and Type | Method and Description |
---|---|
JobResult |
JobClient.cancelJob(String jobId)
Cancel a current jod on the IoTHub
|
JobResult |
JobClient.getJob(String jobId)
Get the current job on the iotHub.
|
JobResult |
JobClient.getNextJob(Query query)
returns the next job result in response.
|
boolean |
JobClient.hasNextJob(Query query)
returns the availability of next job result in response.
|
Query |
JobClient.queryDeviceJob(String sqlQuery)
Query for device Job limited by default page size of 100 for response
|
Query |
JobClient.queryDeviceJob(String sqlQuery,
Integer pageSize)
Query for device Job
|
Query |
JobClient.queryJobResponse(JobType jobType,
JobStatus jobStatus)
Query the iot hub for a jobs response.
|
Query |
JobClient.queryJobResponse(JobType jobType,
JobStatus jobStatus,
Integer pageSize)
Query the iot hub for a jobs response.
|
JobResult |
JobClient.scheduleDeviceMethod(String jobId,
String queryCondition,
String methodName,
Long responseTimeoutInSeconds,
Long connectTimeoutInSeconds,
Object payload,
Date startTimeUtc,
long maxExecutionTimeInSeconds)
Creates a new Job to invoke method on one or multiple devices
|
JobResult |
JobClient.scheduleUpdateTwin(String jobId,
String queryCondition,
DeviceTwinDevice updateTwin,
Date startTimeUtc,
long maxExecutionTimeInSeconds)
Creates a new Job to update twin tags and desired properties on one or multiple devices
|
Modifier and Type | Method and Description |
---|---|
IotHubException |
AmqpResponseVerification.getException() |
Modifier and Type | Method and Description |
---|---|
void |
AmqpSend.send(String deviceId,
String moduleId,
Message message)
Create binary message
Initialize and start Proton reactor
Send the created message
|
void |
AmqpSendHandler.verifySendSucceeded() |
Copyright © 2020. All rights reserved.