-
Notifications
You must be signed in to change notification settings - Fork 256
/
MetricCommentFeedback.xml
126 lines (126 loc) · 7.48 KB
/
MetricCommentFeedback.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<Type Name="MetricCommentFeedback" FullName="Azure.AI.MetricsAdvisor.MetricCommentFeedback">
<TypeSignature Language="C#" Value="public class MetricCommentFeedback : Azure.AI.MetricsAdvisor.MetricFeedback" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MetricCommentFeedback extends Azure.AI.MetricsAdvisor.MetricFeedback" />
<TypeSignature Language="DocId" Value="T:Azure.AI.MetricsAdvisor.MetricCommentFeedback" />
<TypeSignature Language="VB.NET" Value="Public Class MetricCommentFeedback
Inherits MetricFeedback" />
<TypeSignature Language="F#" Value="type MetricCommentFeedback = class
 inherit MetricFeedback" />
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.AI.MetricsAdvisor.MetricFeedback</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The CommentFeedback. </summary>
<remarks>
In order to create comment feedback, you must pass this instance to the method
<see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.AddFeedbackAsync(Azure.AI.MetricsAdvisor.MetricFeedback,System.Threading.CancellationToken)" />.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MetricCommentFeedback (string metricId, Azure.AI.MetricsAdvisor.Models.DimensionKey dimensionKey, string comment);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string metricId, class Azure.AI.MetricsAdvisor.Models.DimensionKey dimensionKey, string comment) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.MetricsAdvisor.MetricCommentFeedback.#ctor(System.String,Azure.AI.MetricsAdvisor.Models.DimensionKey,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (metricId As String, dimensionKey As DimensionKey, comment As String)" />
<MemberSignature Language="F#" Value="new Azure.AI.MetricsAdvisor.MetricCommentFeedback : string * Azure.AI.MetricsAdvisor.Models.DimensionKey * string -> Azure.AI.MetricsAdvisor.MetricCommentFeedback" Usage="new Azure.AI.MetricsAdvisor.MetricCommentFeedback (metricId, dimensionKey, comment)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="metricId" Type="System.String" />
<Parameter Name="dimensionKey" Type="Azure.AI.MetricsAdvisor.Models.DimensionKey" />
<Parameter Name="comment" Type="System.String" />
</Parameters>
<Docs>
<param name="metricId">The identifier of the metric to which the <see cref="T:Azure.AI.MetricsAdvisor.MetricCommentFeedback" /> applies.</param>
<param name="dimensionKey">
A key that identifies a set of time series to which the <see cref="T:Azure.AI.MetricsAdvisor.MetricCommentFeedback" /> applies.
If all possible dimensions are set, this key uniquely identifies a single time series
for the specified <paramref name="metricId" />. If only a subset of dimensions are set, this
key uniquely identifies a group of time series.
</param>
<param name="comment">The comment content for the feedback.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.MetricsAdvisor.MetricCommentFeedback" /> class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="metricId" />, <paramref name="dimensionKey" />, or <paramref name="comment" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="metricId" /> or <paramref name="comment" /> is empty.</exception>
</Docs>
</Member>
<Member MemberName="Comment">
<MemberSignature Language="C#" Value="public string Comment { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Comment" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.MetricCommentFeedback.Comment" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Comment As String" />
<MemberSignature Language="F#" Value="member this.Comment : string" Usage="Azure.AI.MetricsAdvisor.MetricCommentFeedback.Comment" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The comment content for the feedback.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndsOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? EndsOn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> EndsOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.MetricCommentFeedback.EndsOn" />
<MemberSignature Language="VB.NET" Value="Public Property EndsOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.EndsOn : Nullable<DateTimeOffset> with get, set" Usage="Azure.AI.MetricsAdvisor.MetricCommentFeedback.EndsOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The end timestamp of feedback timerange. When this is equal to <see cref="P:Azure.AI.MetricsAdvisor.MetricCommentFeedback.StartsOn" /> it indicates a single timestamp.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartsOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? StartsOn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> StartsOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.MetricCommentFeedback.StartsOn" />
<MemberSignature Language="VB.NET" Value="Public Property StartsOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.StartsOn : Nullable<DateTimeOffset> with get, set" Usage="Azure.AI.MetricsAdvisor.MetricCommentFeedback.StartsOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The start timestamp of feedback time range.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>