Skip to content
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

[TSI] Add code snippets for hierarchies and types #20697

Merged
merged 1 commit into from
Apr 27, 2021
Merged

[TSI] Add code snippets for hierarchies and types #20697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
103 changes: 102 additions & 1 deletion sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/src/HierarchiesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
Expand Down Expand Up @@ -40,6 +40,16 @@ internal HierarchiesClient(TimeSeriesHierarchiesRestClient hierarchiesRestClient
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The pageable list <see cref="AsyncPageable{TimeSeriesHierarchy}"/> of Time Series hierarchies with the http response.</returns>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleGetAllHierarchies">
/// // Get all Time Series hierarchies in the environment
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// AsyncPageable&lt;TimeSeriesHierarchy&gt; getAllHierarchies = client.Hierarchies.GetAsync();
/// await foreach (TimeSeriesHierarchy hierarchy in getAllHierarchies)
/// {
/// Console.WriteLine($&quot;Retrieved Time Series Insights hierarchy with Id: &apos;{hierarchy.Id}&apos; and Name: &apos;{hierarchy.Name}&apos;.&quot;);
/// }
/// </code>
/// </example>
public virtual AsyncPageable<TimeSeriesHierarchy> GetAsync(
CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -274,6 +284,33 @@ public virtual Response<TimeSeriesHierarchyOperationResult[]> GetByName(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesHierarchyIds"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleGetHierarchiesById">
/// var tsiHierarchyIds = new List&lt;string&gt;
/// {
/// &quot;sampleHierarchyId&quot;
/// };
///
/// Response&lt;TimeSeriesHierarchyOperationResult[]&gt; getHierarchiesByIdsResult = await client
/// .Hierarchies
/// .GetByIdAsync(tsiHierarchyIds)
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of hieararchy or error objects corresponding by position to the input parameter array in the request.
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// // If the error object is set to null, this means the operation was a success.
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// for (int i = 0; i &lt; getHierarchiesByIdsResult.Value.Length; i++)
/// {
/// if (getHierarchiesByIdsResult.Value[i].Error == null)
/// {
/// Console.WriteLine($&quot;Retrieved Time Series hieararchy with Id: &apos;{getHierarchiesByIdsResult.Value[i].Hierarchy.Id}&apos;.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Failed to retrieve a Time Series hieararchy due to &apos;{getHierarchiesByIdsResult.Value[i].Error.Message}&apos;.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesHierarchyOperationResult[]>> GetByIdAsync(
IEnumerable<string> timeSeriesHierarchyIds,
CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -377,6 +414,42 @@ public virtual Response<TimeSeriesHierarchyOperationResult[]> GetById(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesHierarchies"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleCreateHierarchies">
/// var tsiHierarchyName = &quot;sampleHierarchy&quot;;
/// var tsiInstanceField1 = &quot;hierarchyLevel1&quot;;
/// var hierarchySource = new TimeSeriesHierarchySource();
/// hierarchySource.InstanceFieldNames.Add(tsiInstanceField1);
///
/// var tsiHierarchy = new TimeSeriesHierarchy(tsiHierarchyName, hierarchySource);
/// tsiHierarchy.Id = &quot;sampleHierarchyId&quot;;
///
/// var timeSeriesHierarchies = new List&lt;TimeSeriesHierarchy&gt;
/// {
/// tsiHierarchy
/// };
///
/// // Create Time Series hierarchies
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// Response&lt;TimeSeriesHierarchyOperationResult[]&gt; createHierarchiesResult = await client
/// .Hierarchies
/// .CreateOrReplaceAsync(timeSeriesHierarchies)
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of error objects corresponding by position to the input parameter array in the request.
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// // If the error object is set to null, this means the operation was a success.
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// for (int i = 0; i &lt; createHierarchiesResult.Value.Length; i++)
/// {
/// if (createHierarchiesResult.Value[i].Error == null)
/// {
/// Console.WriteLine($&quot;Created Time Series hierarchy successfully.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Failed to create a Time Series hierarchy: {createHierarchiesResult.Value[i].Error.Message}.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesHierarchyOperationResult[]>> CreateOrReplaceAsync(
IEnumerable<TimeSeriesHierarchy> timeSeriesHierarchies,
CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -579,6 +652,34 @@ public virtual Response<TimeSeriesOperationError[]> DeleteByName(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesHierarchyIds"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleDeleteHierarchiesById">
/// // Delete Time Series hierarchies with Ids
bikamani marked this conversation as resolved.
Show resolved Hide resolved
/// var tsiHierarchyIdsToDelete = new List&lt;string&gt;
/// {
/// &quot;sampleHiearchyId&quot;
/// };
///
/// Response&lt;TimeSeriesOperationError[]&gt; deleteHierarchiesResponse = await client
/// .Hierarchies
/// .DeleteByIdAsync(tsiHierarchyIdsToDelete)
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of error objects corresponding by position to the input parameter
/// // array in the request. If the error object is set to null, this means the operation was a success.
/// foreach (TimeSeriesOperationError result in deleteHierarchiesResponse.Value)
/// {
/// if (result != null)
/// {
/// Console.WriteLine($&quot;Failed to delete a Time Series Insights hierarchy: {result.Message}.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Deleted a Time Series Insights hierarchy successfully.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesOperationError[]>> DeleteByIdAsync(
IEnumerable<string> timeSeriesHierarchyIds,
CancellationToken cancellationToken = default)
Expand Down
110 changes: 109 additions & 1 deletion sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/src/TypesClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
Expand Down Expand Up @@ -40,6 +40,17 @@ internal TypesClient(TimeSeriesTypesRestClient typesRestClient, ClientDiagnostic
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The pageable list <see cref="AsyncPageable{TimeSeriesType}"/> of Time Series types with the http response.</returns>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleGetAllTypes">
/// // Get all Time Series types in the environment
/// AsyncPageable&lt;TimeSeriesType&gt; getAllTypesResponse = client.Types.GetTypesAsync();
///
/// await foreach (TimeSeriesType tsiType in getAllTypesResponse)
/// {
/// Console.WriteLine($&quot;Retrieved Time Series Insights type with Id: &apos;{tsiType?.Id}&apos; and Name: &apos;{tsiType?.Name}&apos;&quot;);
/// }
/// </code>
/// </example>
public virtual AsyncPageable<TimeSeriesType> GetTypesAsync(
CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -274,6 +285,32 @@ public virtual Response<TimeSeriesTypeOperationResult[]> GetByName(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesTypeIds"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleGetTypeById">
/// // Code snippet below shows getting a default Type using Id
/// // The default type Id can be obtained programmatically by using the ModelSettings client.
///
/// TimeSeriesModelSettings modelSettings = await client.ModelSettings.GetAsync().ConfigureAwait(false);
/// Response&lt;TimeSeriesTypeOperationResult[]&gt; getTypeByIdResults = await client
/// .Types
/// .GetByIdAsync(new string[] { modelSettings.DefaultTypeId })
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of type or error objects corresponding by position to the input parameter array in the request.
/// // If the error object is set to null, this means the operation was a success.
/// for (int i = 0; i &lt; getTypeByIdResults.Value.Length; i++)
/// {
/// if (getTypeByIdResults.Value[i].Error == null)
/// {
/// Console.WriteLine($&quot;Retrieved Time Series type with Id: &apos;{getTypeByIdResults.Value[i].TimeSeriesType.Id}&apos;.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Failed to retrieve a Time Series type due to &apos;{getTypeByIdResults.Value[i].Error.Message}&apos;.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesTypeOperationResult[]>> GetByIdAsync(
IEnumerable<string> timeSeriesTypeIds,
CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -377,6 +414,52 @@ public virtual Response<TimeSeriesTypeOperationResult[]> GetById(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesTypes"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleCreateType">
/// // Create an aggregate type
/// var timeSeriesTypes = new List&lt;TimeSeriesType&gt;();
///
/// var countExpression = new TimeSeriesExpression(&quot;count()&quot;);
/// var aggregateVariable = new AggregateVariable(countExpression);
/// var variables = new Dictionary&lt;string, TimeSeriesVariable&gt;();
/// var variableName = &quot;aggregateVariable&quot;;
/// variables.Add(variableName, aggregateVariable);
///
/// var timeSeriesTypesProperties = new Dictionary&lt;string, string&gt;
/// {
/// { &quot;Type1&quot;, &quot;Type1Id&quot;},
/// { &quot;Type2&quot;, &quot;Type2Id&quot;}
/// };
///
/// foreach (KeyValuePair&lt;string, string&gt; property in timeSeriesTypesProperties)
/// {
/// var type = new TimeSeriesType(property.Key, variables)
/// {
/// Id = property.Value
/// };
/// timeSeriesTypes.Add(type);
/// }
///
/// Response&lt;TimeSeriesTypeOperationResult[]&gt; createTypesResult = await client
/// .Types
/// .CreateOrReplaceAsync(timeSeriesTypes)
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of error objects corresponding by position to the input parameter array in the request.
/// // If the error object is set to null, this means the operation was a success.
/// for (int i = 0; i &lt; createTypesResult.Value.Length; i++)
/// {
/// if (createTypesResult.Value[i].Error == null)
/// {
/// Console.WriteLine($&quot;Created Time Series type successfully.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Failed to create a Time Series Insights type: {createTypesResult.Value[i].Error.Message}.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesTypeOperationResult[]>> CreateOrReplaceAsync(
IEnumerable<TimeSeriesType> timeSeriesTypes,
CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -579,6 +662,31 @@ public virtual Response<TimeSeriesOperationError[]> DeleteByName(
/// <exception cref="ArgumentException">
/// The exception is thrown when <paramref name="timeSeriesTypeIds"/> is empty.
/// </exception>
/// <example>
/// <code snippet="Snippet:TimeSeriesInsightsSampleDeleteTypeById">
/// // Delete Time Series types with Ids
///
/// var typesIdsToDelete = new List&lt;string&gt; { &quot;Type1Id&quot;, &quot; Type2Id&quot; };
/// Response&lt;TimeSeriesOperationError[]&gt; deleteTypesResponse = await client
/// .Types
/// .DeleteByIdAsync(typesIdsToDelete)
/// .ConfigureAwait(false);
///
/// // The response of calling the API contains a list of error objects corresponding by position to the input parameter
/// // array in the request. If the error object is set to null, this means the operation was a success.
/// foreach (var result in deleteTypesResponse.Value)
/// {
/// if (result != null)
/// {
/// Console.WriteLine($&quot;Failed to delete a Time Series Insights type: {result.Message}.&quot;);
/// }
/// else
/// {
/// Console.WriteLine($&quot;Deleted a Time Series Insights type successfully.&quot;);
/// }
/// }
/// </code>
/// </example>
public virtual async Task<Response<TimeSeriesOperationError[]>> DeleteByIdAsync(
IEnumerable<string> timeSeriesTypeIds,
CancellationToken cancellationToken = default)
Expand Down