| Modifier and Type | Method and Description |
|---|---|
void |
ConfigurationsClient.applyConfigurationContentOnDevice(String deviceId,
ConfigurationContent content)
Apply the provided configuration content to the provided device
|
Configuration |
ConfigurationsClient.create(Configuration configuration)
Create a new configuration using the given Configuration object
Return with the response configuration object from IotHub
|
void |
ConfigurationsClient.delete(Configuration configuration)
Send remove configuration request and verify response
|
void |
ConfigurationsClient.delete(String configurationId)
Send remove configuration request and verify response
|
List<Configuration> |
ConfigurationsClient.get(int maxCount)
Get list of Configuration
|
Configuration |
ConfigurationsClient.get(String configurationId)
Get configuration by configuration Id from IotHub
|
Configuration |
ConfigurationsClient.replace(Configuration configuration)
Update configuration not forced
|
| 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 |
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 |
IotHubUnauthorizedException
Create unauthorized exception
|
| Modifier and Type | Method and Description |
|---|---|
static IotHubException |
IotHubExceptionManager.mapException(int responseStatus,
String description)
Return a new exception instance that best matches the given HTTP status code and description
|
| Modifier and Type | Method and Description |
|---|---|
static void |
IotHubExceptionManager.httpResponseVerification(HttpResponse httpResponse)
Verify Http response using response status
|
| Modifier and Type | Method and Description |
|---|---|
ScheduledJob |
ScheduledJobsClient.cancel(String jobId)
Cancel a current jod on the IoTHub
|
ScheduledJob |
ScheduledJobsClient.get(String jobId)
Get the current job on the iotHub.
|
JobQueryResponse |
ScheduledJobsClient.query(ScheduledJobType jobType,
ScheduledJobStatus jobStatus)
Query from your IoT Hub's set of scheduled jobs by job type and job status.
|
JobQueryResponse |
ScheduledJobsClient.query(ScheduledJobType jobType,
ScheduledJobStatus jobStatus,
QueryPageOptions options)
Query from your IoT Hub's set of scheduled jobs by job type and job status.
|
JobQueryResponse |
ScheduledJobsClient.query(String query)
Query from your IoT Hub's set of scheduled jobs.
|
JobQueryResponse |
ScheduledJobsClient.query(String query,
QueryPageOptions options)
Query from your IoT Hub's set of scheduled jobs.
|
ScheduledJob |
ScheduledJobsClient.scheduleDirectMethod(String jobId,
String queryCondition,
String methodName,
Date startTimeUtc)
Creates a new ScheduledJob to invoke method on one or multiple devices
|
ScheduledJob |
ScheduledJobsClient.scheduleDirectMethod(String jobId,
String queryCondition,
String methodName,
Date startTimeUtc,
DirectMethodsJobOptions options)
Creates a new ScheduledJob to invoke method on one or multiple devices
|
ScheduledJob |
ScheduledJobsClient.scheduleUpdateTwin(String jobId,
String queryCondition,
Twin updateTwin,
Date startTimeUtc,
long maxExecutionTimeInSeconds)
Creates a new ScheduledJob to update twin tags and desired properties on one or multiple devices
|
| Modifier and Type | Method and Description |
|---|---|
void |
MessagingClient.open()
Open this client so that it can begin sending cloud to device and/or cloud to module messages.
|
void |
MessagingClient.open(int timeoutMilliseconds)
Open this client so that it can begin sending cloud to device and/or cloud to module messages.
|
void |
MessagingClient.send(String deviceId,
Message message)
Send a cloud to device message to the device with the provided device id.
|
void |
MessagingClient.send(String deviceId,
Message message,
int timeoutMilliseconds)
Send a cloud to device message to the device with the provided device id.
|
void |
MessagingClient.send(String deviceId,
String moduleId,
Message message)
Send a cloud to device message to the module with the provided module id on the device with the provided device Id.
|
void |
MessagingClient.send(String deviceId,
String moduleId,
Message message,
int timeoutMilliseconds)
Send a cloud to device message to the module with the provided module id on the device with the provided device Id.
|
void |
MessageFeedbackProcessorClient.start()
Open this client so that it can begin processing message feedback.
|
void |
FileUploadNotificationProcessorClient.start()
Open this client so that it can begin processing file upload notifications.
|
void |
MessageFeedbackProcessorClient.start(int timeoutMilliseconds)
Open this client so that it can begin processing message feedback.
|
void |
FileUploadNotificationProcessorClient.start(int timeoutMilliseconds)
Open this client so that it can begin processing file upload notifications.
|
| Constructor and Description |
|---|
ErrorContext(IotHubException exception) |
| Modifier and Type | Method and Description |
|---|---|
DirectMethodResponse |
DirectMethodsClient.invoke(String deviceId,
String methodName)
Directly invokes a method on the device and return its result.
|
DirectMethodResponse |
DirectMethodsClient.invoke(String deviceId,
String methodName,
DirectMethodRequestOptions options)
Directly invokes a method on the device and return its result.
|
DirectMethodResponse |
DirectMethodsClient.invoke(String deviceId,
String moduleId,
String methodName)
Directly invokes a method on the module and return its result.
|
DirectMethodResponse |
DirectMethodsClient.invoke(String deviceId,
String moduleId,
String methodName,
DirectMethodRequestOptions options)
Directly invokes a method on the module and return its result.
|
| Modifier and Type | Method and Description |
|---|---|
Twin |
TwinQueryResponse.next()
Return the next Twin from the query.
|
String |
RawQueryResponse.next()
Return the next json object from the query.
|
ScheduledJob |
JobQueryResponse.next()
Return the next job from the query.
|
Twin |
TwinQueryResponse.next(QueryPageOptions pageOptions)
Return the next Twin from the query.
|
String |
RawQueryResponse.next(QueryPageOptions pageOptions)
Return the next json object from the query.
|
ScheduledJob |
JobQueryResponse.next(QueryPageOptions pageOptions)
Return the next job from the query.
|
JobQueryResponse |
QueryClient.queryJobs(ScheduledJobType jobType,
ScheduledJobStatus jobStatus)
Query from your IoT Hub's set of scheduled jobs by job type and job status.
|
JobQueryResponse |
QueryClient.queryJobs(ScheduledJobType jobType,
ScheduledJobStatus jobStatus,
QueryPageOptions options)
Query from your IoT Hub's set of scheduled jobs by job type and job status.
|
JobQueryResponse |
QueryClient.queryJobs(String query)
Query from your IoT Hub's set of scheduled jobs.
|
JobQueryResponse |
QueryClient.queryJobs(String query,
QueryPageOptions options)
Query from your IoT Hub's set of scheduled jobs.
|
RawQueryResponse |
QueryClient.queryRaw(String query)
Query miscellaneous data from your IoT Hub.
|
RawQueryResponse |
QueryClient.queryRaw(String query,
QueryPageOptions options)
Query miscellaneous data from your IoT Hub.
|
TwinQueryResponse |
QueryClient.queryTwins(String query)
Query from your IoT Hub's set of Twins.
|
TwinQueryResponse |
QueryClient.queryTwins(String query,
QueryPageOptions options)
Query from your IoT Hub's set of Twins.
|
| Modifier and Type | Method and Description |
|---|---|
Device |
RegistryClient.addDevice(Device device)
Add device using the given Device object
Return with the response device object from IotHub
|
Module |
RegistryClient.addModule(Module module)
Add module using the given Module object
Return with the response module object from IotHub
|
RegistryJob |
RegistryClient.exportDevices(RegistryJob exportDevicesParameters)
Create a bulk export job.
|
RegistryJob |
RegistryClient.exportDevices(String exportBlobContainerUri,
boolean excludeKeys)
Create a bulk export job.
|
Device |
RegistryClient.getDevice(String deviceId)
Get device data by device Id from IotHub
|
RegistryJob |
RegistryClient.getJob(String jobId)
Get the properties of an existing job.
|
Module |
RegistryClient.getModule(String deviceId,
String moduleId)
Get module data by device Id and module Id from IotHub
|
List<Module> |
RegistryClient.getModulesOnDevice(String deviceId)
Get modules data by device Id from IotHub
|
RegistryStatistics |
RegistryClient.getStatistics()
Get device statistics
|
RegistryJob |
RegistryClient.importDevices(RegistryJob importDevicesParameters)
Create a bulk import job.
|
RegistryJob |
RegistryClient.importDevices(String importBlobContainerUri,
String outputBlobContainerUri)
Create a bulk import job.
|
void |
RegistryClient.removeDevice(Device device)
Remove device
|
void |
RegistryClient.removeDevice(String deviceId)
Remove device
|
void |
RegistryClient.removeModule(Module module)
Remove module
|
void |
RegistryClient.removeModule(String deviceId,
String moduleId)
Remove module
|
Device |
RegistryClient.updateDevice(Device device)
Update device not forced
|
Module |
RegistryClient.updateModule(Module module)
Update module not forced
|
| Constructor and Description |
|---|
ProtonJExceptionParser(IotHubException iotHubException) |
| Modifier and Type | Method and Description |
|---|---|
HttpResponse |
HttpRequest.send()
Executes the HTTPS request.
|
| Modifier and Type | Method and Description |
|---|---|
Twin |
TwinClient.get(String deviceId)
This method retrieves device twin for the specified device.
|
Twin |
TwinClient.get(String deviceId,
String moduleId)
This method retrieves device twin for the specified device.
|
Twin |
TwinClient.patch(Twin twin)
This method patches the twin for the specified device.
|
Twin |
TwinClient.patch(Twin twin,
String ifMatch)
This method patches the twin for the specified device.
|
TwinQueryResponse |
TwinClient.query(String query)
Query from your IoT Hub's set of Twins.
|
TwinQueryResponse |
TwinClient.query(String query,
QueryPageOptions options)
Query from your IoT Hub's set of Twins.
|
Twin |
TwinClient.replace(Twin twin)
Replace the full twin for a given device or module with the provided twin.
|
Twin |
TwinClient.replace(Twin twin,
String ifMatch)
Replace the full twin for a given device or module with the provided twin.
|
Copyright © 2024. All rights reserved.