feat (TSI instances): Time Series Insights Instances client library implementation (Azure#19209)

Author: Basel Rustum

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/api/Azure.Iot.TimeSeriesInsights.netstandard2.0.cs

@@ -0,0 +1,94 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using System.Text.Json;
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// This class definition overrides serialization implementation in order to turn a raw response
+    /// from Time Series Insights into a InstancesBatchResponse object.
+    /// </summary>
+    [CodeGenModel("InstancesBatchResponse")]
+    public partial class InstancesBatchResponse
+    {
+        // The purpose of overriding this method is to protect against an InvalidOperationException
+        // that is being thrown by the generated code. More specifically, the exception is being thrown
+        // when trying to deserialize the "delete" property. A coveration has started with the Time Series
+        // Insights team on take a closer look on the thrown exception.
+
+        internal static InstancesBatchResponse DeserializeInstancesBatchResponse(JsonElement element)
+        {
+            Optional<IReadOnlyList<InstancesOperationResult>> @get = default;
+            Optional<IReadOnlyList<InstancesOperationResult>> put = default;
+            Optional<IReadOnlyList<InstancesOperationResult>> update = default;
+            Optional<IReadOnlyList<InstancesOperationError>> delete = default;
+            foreach (JsonProperty property in element.EnumerateObject())
+            {
+                if (property.NameEquals("get"))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        property.ThrowNonNullablePropertyIsNull();
+                        continue;
+                    }
+                    List<InstancesOperationResult> array = new List<InstancesOperationResult>();
+                    foreach (JsonElement item in property.Value.EnumerateArray())
+                    {
+                        array.Add(InstancesOperationResult.DeserializeInstancesOperationResult(item));
+                    }
+                    @get = array;
+                    continue;
+                }
+                if (property.NameEquals("put"))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        property.ThrowNonNullablePropertyIsNull();
+                        continue;
+                    }
+                    List<InstancesOperationResult> array = new List<InstancesOperationResult>();
+                    foreach (JsonElement item in property.Value.EnumerateArray())
+                    {
+                        array.Add(InstancesOperationResult.DeserializeInstancesOperationResult(item));
+                    }
+                    put = array;
+                    continue;
+                }
+                if (property.NameEquals("update"))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        property.ThrowNonNullablePropertyIsNull();
+                        continue;
+                    }
+                    List<InstancesOperationResult> array = new List<InstancesOperationResult>();
+                    foreach (JsonElement item in property.Value.EnumerateArray())
+                    {
+                        array.Add(InstancesOperationResult.DeserializeInstancesOperationResult(item));
+                    }
+                    update = array;
+                    continue;
+                }
+                if (property.NameEquals("delete"))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        property.ThrowNonNullablePropertyIsNull();
+                        continue;
+                    }
+                    List<InstancesOperationError> array = new List<InstancesOperationError>();
+                    foreach (JsonElement item in property.Value.EnumerateArray())
+                    {
+                        array.Add(item.ValueKind != JsonValueKind.Null ? InstancesOperationError.DeserializeInstancesOperationError(item) : null);
+                    }
+                    delete = array;
+                    continue;
+                }
+            }
+            return new InstancesBatchResponse(Optional.ToList(@get), Optional.ToList(put), Optional.ToList(update), Optional.ToList(delete));
+        }
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesBatchResponse.Serialization.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// A particular API error with an error code and a message.
+    /// </summary>
+    [CodeGenModel("TsiErrorBody")]
+    public partial class InstancesOperationError
+    {
+        // This class declaration changes the class name; do not remove.
+        // The class name change is to make it clearer to the user that this type represents
+        // an instances operation error.
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesOperationError.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// Error details for Time Series Insights instances operations.
+    /// </summary>
+    [CodeGenModel("TsiErrorDetails")]
+    public partial class InstancesOperationErrorDetails
+    {
+        // This class declaration changes the class name; do not remove.
+        // The class name change is to make it clearer to the user that this type represents
+        // error details for an instances operation.
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesOperationErrorDetails.cs

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// Result of an operation on a particular time series instance. Instance object is set when operation
+    /// is successful and error object is set when operation is unsuccessful.
+    /// </summary>
+    [CodeGenModel("InstanceOrError")]
+    public partial class InstancesOperationResult
+    {
+        // This class declaration changes the class name; do not remove.
+        // The class name change is to make it clearer to the user that this type represents
+        // an instances operation result.
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesOperationResult.cs

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Text.Json;
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// This class definition overrides serialization implementation in order to turn Time
+    /// Series Ids from a strongly typed object to an list of objects that the service can understand.
+    /// </summary>
+    public partial class InstancesRequestBatchGetOrDelete : IUtf8JsonSerializable
+    {
+        // This class declaration overrides the logic that serializes the object. More specifically, to
+        // serialize "timeSeriesIds". Since TimeSeriesIds changed from a list of objects to a strongly
+        // typed object, serialization is handled differently.
+
+        // The use of fully qualified name for IUtf8JsonSerializable is a work around until this
+        // issue is fixed: https://github.com/Azure/autorest.csharp/issues/793
+        void global::Azure.Core.IUtf8JsonSerializable.Write(Utf8JsonWriter writer)
+        {
+            writer.WriteStartObject();
+            if (Optional.IsCollectionDefined(TimeSeriesIds))
+            {
+                writer.WritePropertyName("timeSeriesIds");
+                writer.WriteStartArray();
+                foreach (TimeSeriesId item in TimeSeriesIds)
+                {
+                    writer.WriteStartArray();
+                    foreach (var item0 in item.ToArray())
+                    {
+                        writer.WriteObjectValue(item0);
+                    }
+                    writer.WriteEndArray();
+                }
+                writer.WriteEndArray();
+            }
+            if (Optional.IsCollectionDefined(Names))
+            {
+                writer.WritePropertyName("names");
+                writer.WriteStartArray();
+                foreach (var item in Names)
+                {
+                    writer.WriteStringValue(item);
+                }
+                writer.WriteEndArray();
+            }
+            writer.WriteEndObject();
+        }
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesRequestBatchGetOrDelete.Serialization.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// Request to get or delete instances by time series Ids or time series names.
+    /// Exactly one of &quot;timeSeriesIds&quot; or &quot;names&quot; must be set.
+    /// </summary>
+    [CodeGenModel("InstancesRequestBatchGetOrDelete")]
+    public partial class InstancesRequestBatchGetOrDelete
+    {
+        // Autorest does not support changing type for properties. In order to turn TimeSeriesId
+        // from a list of objects to a strongly typed object, TimeSeriesId has been renamed to
+        // TimeSeriesIdInternal and a new property, TimeSeriesId, has been created with the proper type.
+
+        [CodeGenMember("TimeSeriesIds")]
+        private IList<IList<object>> TimeSeriesIdsInternal { get; }
+
+        /// <summary>
+        /// The list of Time Series Ids used to make the request.
+        /// </summary>
+        public IList<TimeSeriesId> TimeSeriesIds { get; }
+
+        /// <summary>
+        /// Initializes a new instance of InstancesRequestBatchGetOrDelete.
+        /// </summary>
+        public InstancesRequestBatchGetOrDelete()
+        {
+            TimeSeriesIds = new ChangeTrackingList<TimeSeriesId>();
+            Names = new ChangeTrackingList<string>();
+        }
+    }
+}

sdk/timeseriesinsights/Azure.Iot.TimeSeriesInsights/src/Customized/Models/InstancesRequestBatchGetOrDelete.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core;
+
+namespace Azure.Iot.TimeSeriesInsights
+{
+    /// <summary>
+    /// Suggested search string to be used for further search for time series instances.
+    /// </summary>
+    [CodeGenModel("InstancesSearchStringSuggestion")]
+    public partial class SearchSuggestion
+    {
+        // This declaration is to simplify the class name; do not remove.
+    }
+}