Skip to content

(feat): Implement Modules client #12673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
azabbasi merged 18 commits into from
Jun 10, 2020
Merged

(feat): Implement Modules client #12673

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9b79574
Implement Modules client
azabbasi Jun 9, 2020
54ce8ed
Update API Design.md
azabbasi Jun 9, 2020
03a0a15
Fix all warnings and make sure solution builds
azabbasi Jun 10, 2020
fe3fffb
Format files
azabbasi Jun 10, 2020
d59e7d7
remove unnecessary code
azabbasi Jun 10, 2020
7cce057
cr comments
azabbasi Jun 10, 2020
ad24b72
reference http response type
azabbasi Jun 10, 2020
2108d2a
update async pagable comments
azabbasi Jun 10, 2020
743404b
update module client summary
azabbasi Jun 10, 2020
10a089f
add link to the summary
azabbasi Jun 10, 2020
6b19d7c
Update Readme to pass code analysys
azabbasi Jun 10, 2020
c6a9f1a
Update README.md
azabbasi Jun 10, 2020
86312b1
Export APIs
azabbasi Jun 10, 2020
8fa846b
make query string constant
azabbasi Jun 10, 2020
b904adc
Update API design md file to reference implementation.
azabbasi Jun 10, 2020
7d9f736
xml comments for protector constructor
azabbasi Jun 10, 2020
c38b517
Update xml comments.
azabbasi Jun 10, 2020
628e9ff
fix typo
azabbasi Jun 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
reference http response type
  • Loading branch information
@azabbasi
azabbasi committed Jun 10, 2020
commit ad24b7217031a910b7ed6709dc595e3c75b9b36a
42 changes: 21 additions & 21 deletions sdk/iot/Azure.Iot.Hub.Service/src/DevicesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ internal DevicesClient(RegistryManagerRestClient registryManagerClient, TwinRest
/// <param name="deviceIdentity">the device identity to create.</param>
/// <param name="precondition">The condition on which to perform this operation. To create a device identity, this value must be equal to <see cref="IfMatchPrecondition.Unconditional"/>.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The created device identity.</returns>
/// <returns>The created device identity and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<DeviceIdentity>> CreateOrUpdateIdentityAsync(
DeviceIdentity deviceIdentity,
IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch,
Expand All @@ -61,7 +61,7 @@ public virtual Task<Response<DeviceIdentity>> CreateOrUpdateIdentityAsync(
/// <param name="deviceIdentity">the device identity to create.</param>
/// <param name="precondition">The condition on which to perform this operation. To create a device identity, this value must be equal to <see cref="IfMatchPrecondition.Unconditional"/>.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The created device identity.</returns>
/// <returns>The created device identity and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<DeviceIdentity> CreateOrUpdateIdentity(
DeviceIdentity deviceIdentity,
IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch,
Expand All @@ -77,7 +77,7 @@ public virtual Response<DeviceIdentity> CreateOrUpdateIdentity(
/// </summary>
/// <param name="deviceId">The unique identifier of the device identity to get.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The retrieved device identity.</returns>
/// <returns>The retrieved device identity and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<DeviceIdentity>> GetIdentityAsync(string deviceId, CancellationToken cancellationToken = default)
{
return _registryManagerClient.GetDeviceAsync(deviceId, cancellationToken);
Expand All @@ -88,7 +88,7 @@ public virtual Task<Response<DeviceIdentity>> GetIdentityAsync(string deviceId,
/// </summary>
/// <param name="deviceId">The unique identifier of the device identity to get.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The retrieved device identity.</returns>
/// <returns>The retrieved device identity and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<DeviceIdentity> GetIdentity(string deviceId, CancellationToken cancellationToken = default)
{
return _registryManagerClient.GetDevice(deviceId, cancellationToken);
Expand All @@ -100,7 +100,7 @@ public virtual Response<DeviceIdentity> GetIdentity(string deviceId, Cancellatio
/// <param name="deviceIdentity">the device identity to delete. If no ETag is present on the device, then the condition must be equal to <see cref="IfMatchPrecondition.Unconditional"/> or equal to <see cref="IfMatchPrecondition.UnconditionalIfMatch"/>.</param>
/// <param name="precondition">The condition on which to delete the device.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The http response.</returns>
/// <returns>The http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response> DeleteIdentityAsync(
DeviceIdentity deviceIdentity,
IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch,
Expand All @@ -117,7 +117,7 @@ public virtual Task<Response> DeleteIdentityAsync(
/// <param name="deviceIdentity">the device identity to delete. If no ETag is present on the device, then the condition must be equal to <see cref="IfMatchPrecondition.Unconditional"/> or equal to <see cref="IfMatchPrecondition.UnconditionalIfMatch"/>.</param>
/// <param name="precondition">The condition on which to delete the device.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The http response.</returns>
/// <returns>The http response <see cref="Response{T}"/>.</returns>
public virtual Response DeleteIdentity(
DeviceIdentity deviceIdentity,
IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch,
Expand All @@ -134,7 +134,7 @@ public virtual Response DeleteIdentity(
/// <param name="devices">The pairs of devices their twins that will be created. For fields such as deviceId
/// where device and twin have a definition, the device value will override the twin value.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<BulkRegistryOperationResponse>> CreateIdentitiesWithTwinAsync(IDictionary<DeviceIdentity, TwinData> devices, CancellationToken cancellationToken = default)
{
IEnumerable<ExportImportDevice> registryOperations = devices
Expand Down Expand Up @@ -163,7 +163,7 @@ public virtual Task<Response<BulkRegistryOperationResponse>> CreateIdentitiesWit
/// <param name="devices">The pairs of devices their twins that will be created. For fields such as deviceId
/// where device and twin have a definition, the device value will override the twin value.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<BulkRegistryOperationResponse> CreateIdentitiesWithTwin(IDictionary<DeviceIdentity, TwinData> devices, CancellationToken cancellationToken = default)
{
IEnumerable<ExportImportDevice> registryOperations = devices
Expand Down Expand Up @@ -191,7 +191,7 @@ public virtual Response<BulkRegistryOperationResponse> CreateIdentitiesWithTwin(
/// </summary>
/// <param name="deviceIdentities">The devices identities to create.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<BulkRegistryOperationResponse>> CreateIdentitiesAsync(IEnumerable<DeviceIdentity> deviceIdentities, CancellationToken cancellationToken = default)
{
IEnumerable<ExportImportDevice> registryOperations = deviceIdentities
Expand All @@ -217,7 +217,7 @@ public virtual Task<Response<BulkRegistryOperationResponse>> CreateIdentitiesAsy
/// </summary>
/// <param name="deviceIdentities">The device identities to create.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<BulkRegistryOperationResponse> CreateIdentities(IEnumerable<DeviceIdentity> deviceIdentities, CancellationToken cancellationToken = default)
{
IEnumerable<ExportImportDevice> registryOperations = deviceIdentities
Expand All @@ -244,7 +244,7 @@ public virtual Response<BulkRegistryOperationResponse> CreateIdentities(IEnumera
/// <param name="deviceIdentities">The devices to update.</param>
/// <param name="precondition">The condition on which to update each device identity.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<BulkRegistryOperationResponse>> UpdateIdentiesAsync(
IEnumerable<DeviceIdentity> deviceIdentities,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand Down Expand Up @@ -275,7 +275,7 @@ public virtual Task<Response<BulkRegistryOperationResponse>> UpdateIdentiesAsync
/// <param name="deviceIdentities">The devices to update.</param>
/// <param name="precondition">The condition on which to update each device identity.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<BulkRegistryOperationResponse> UpdateIdenties(
IEnumerable<DeviceIdentity> deviceIdentities,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand Down Expand Up @@ -306,7 +306,7 @@ public virtual Response<BulkRegistryOperationResponse> UpdateIdenties(
/// <param name="deviceIdentities">The devices to delete.</param>
/// <param name="precondition">The condition on which to delete each device identity.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk deletion.</returns>
/// <returns>The result of the bulk deletion and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<BulkRegistryOperationResponse>> DeleteIdentitiesAsync(
IEnumerable<DeviceIdentity> deviceIdentities,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand All @@ -331,7 +331,7 @@ public virtual Task<Response<BulkRegistryOperationResponse>> DeleteIdentitiesAsy
/// <param name="deviceIdentities">The devices to delete.</param>
/// <param name="precondition">The condition on which to delete each device identity.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk deletion.</returns>
/// <returns>The result of the bulk deletion and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<BulkRegistryOperationResponse> DeleteIdentities(
IEnumerable<DeviceIdentity> deviceIdentities,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand Down Expand Up @@ -439,7 +439,7 @@ Page<TwinData> NextPageFunc(string nextLink, int? pageSizeHint)
/// </summary>
/// <param name="deviceId">The unique identifier of the device identity to get the twin of.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The device's twin, including reported properties and desired properties.</returns>
/// <returns>The device's twin, including reported properties and desired properties and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<TwinData>> GetTwinAsync(string deviceId, CancellationToken cancellationToken = default)
{
return _twinClient.GetDeviceTwinAsync(deviceId, cancellationToken);
Expand All @@ -462,7 +462,7 @@ public virtual Response<TwinData> GetTwin(string deviceId, CancellationToken can
/// <param name="twinUpdate">The properties to update. Any existing properties not referenced by this patch will be unaffected by this patch.</param>
/// <param name="precondition">The condition for which this operation will execute.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The new representation of the device twin.</returns>
/// <returns>The new representation of the device twin and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<TwinData>> UpdateTwinAsync(TwinData twinUpdate, IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(twinUpdate, nameof(twinUpdate));
Expand All @@ -476,7 +476,7 @@ public virtual Task<Response<TwinData>> UpdateTwinAsync(TwinData twinUpdate, IfM
/// <param name="twinUpdate">The properties to update. Any existing properties not referenced by this patch will be unaffected by this patch.</param>
/// <param name="precondition">The condition for which this operation will execute.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The new representation of the device twin.</returns>
/// <returns>The new representation of the device twin and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<TwinData> UpdateTwin(TwinData twinUpdate, IfMatchPrecondition precondition = IfMatchPrecondition.IfMatch, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(twinUpdate, nameof(twinUpdate));
Expand All @@ -490,7 +490,7 @@ public virtual Response<TwinData> UpdateTwin(TwinData twinUpdate, IfMatchPrecond
/// <param name="twinUpdates">The new twins to replace the twins on existing devices.</param>
/// <param name="precondition">The condition on which to update each device twin.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<BulkRegistryOperationResponse>> UpdateTwinsAsync(
IEnumerable<TwinData> twinUpdates,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand All @@ -515,7 +515,7 @@ public virtual Task<Response<BulkRegistryOperationResponse>> UpdateTwinsAsync(
/// <param name="twinUpdates">The new twins to replace the twins on existing devices.</param>
/// <param name="precondition">The condition on which to update each device twin.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the bulk operation.</returns>
/// <returns>The result of the bulk operation and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<BulkRegistryOperationResponse> UpdateTwins(
IEnumerable<TwinData> twinUpdates,
BulkIfMatchPrecondition precondition = BulkIfMatchPrecondition.IfMatch,
Expand All @@ -542,7 +542,7 @@ public virtual Response<BulkRegistryOperationResponse> UpdateTwins(
/// <param name="deviceId">The unique identifier of the device identity to invoke the method on.</param>
/// <param name="directMethodRequest">The details of the method to invoke.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the method invocation.</returns>
/// <returns>The result of the method invocation and the http response <see cref="Response{T}"/>.</returns>
public virtual Task<Response<CloudToDeviceMethodResponse>> InvokeMethodAsync(string deviceId, CloudToDeviceMethodRequest directMethodRequest, CancellationToken cancellationToken = default)
{
return _deviceMethodClient.InvokeDeviceMethodAsync(deviceId, directMethodRequest, cancellationToken);
Expand All @@ -554,7 +554,7 @@ public virtual Task<Response<CloudToDeviceMethodResponse>> InvokeMethodAsync(str
/// <param name="deviceId">The unique identifier of the device identity to invoke the method on.</param>
/// <param name="directMethodRequest">The details of the method to invoke.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The result of the method invocation.</returns>
/// <returns>The result of the method invocation and the http response <see cref="Response{T}"/>.</returns>
public virtual Response<CloudToDeviceMethodResponse> InvokeMethod(string deviceId, CloudToDeviceMethodRequest directMethodRequest, CancellationToken cancellationToken = default)
{
return _deviceMethodClient.InvokeDeviceMethod(deviceId, directMethodRequest, cancellationToken);
Expand Down
Loading