GetMetricSeriesDataOptions.xml

<Type Name="GetMetricSeriesDataOptions" FullName="Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions">
  <TypeSignature Language="C#" Value="public class GetMetricSeriesDataOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit GetMetricSeriesDataOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class GetMetricSeriesDataOptions" />
  <TypeSignature Language="F#" Value="type GetMetricSeriesDataOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The set of options that can be specified when calling <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetMetricSeriesData(System.String,Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions,System.Threading.CancellationToken)" />
            or <see cref="M:Azure.AI.MetricsAdvisor.MetricsAdvisorClient.GetMetricSeriesDataAsync(System.String,Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions,System.Threading.CancellationToken)" /> to configure the behavior of the request.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public GetMetricSeriesDataOptions (DateTimeOffset startsOn, DateTimeOffset endsOn);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.DateTimeOffset startsOn, valuetype System.DateTimeOffset endsOn) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.#ctor(System.DateTimeOffset,System.DateTimeOffset)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (startsOn As DateTimeOffset, endsOn As DateTimeOffset)" />
      <MemberSignature Language="F#" Value="new Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions : DateTimeOffset * DateTimeOffset -&gt; Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions" Usage="new Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions (startsOn, endsOn)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="startsOn" Type="System.DateTimeOffset" />
        <Parameter Name="endsOn" Type="System.DateTimeOffset" />
      </Parameters>
      <Docs>
        <param name="startsOn">Filters the result. Only data points ingested from this point in time, in UTC, will be returned.</param>
        <param name="endsOn">Filters the result. Only data points ingested up to this point in time, in UTC, will be returned.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions" /> class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EndsOn">
      <MemberSignature Language="C#" Value="public DateTimeOffset EndsOn { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset EndsOn" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.EndsOn" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndsOn As DateTimeOffset" />
      <MemberSignature Language="F#" Value="member this.EndsOn : DateTimeOffset" Usage="Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.EndsOn" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTimeOffset</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Filters the result. Only data points ingested up to this point in time, in UTC, will be returned.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SeriesKeys">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Azure.AI.MetricsAdvisor.Models.DimensionKey&gt; SeriesKeys { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Azure.AI.MetricsAdvisor.Models.DimensionKey&gt; SeriesKeys" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.SeriesKeys" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SeriesKeys As IList(Of DimensionKey)" />
      <MemberSignature Language="F#" Value="member this.SeriesKeys : System.Collections.Generic.IList&lt;Azure.AI.MetricsAdvisor.Models.DimensionKey&gt;" Usage="Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.SeriesKeys" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Azure.AI.MetricsAdvisor.Models.DimensionKey&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Filters the result by time series. Each element in this list represents a single time series, and only
            anomalies detected in one of these series will be returned. For every element, all possible dimensions
            must be set.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StartsOn">
      <MemberSignature Language="C#" Value="public DateTimeOffset StartsOn { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset StartsOn" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.StartsOn" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartsOn As DateTimeOffset" />
      <MemberSignature Language="F#" Value="member this.StartsOn : DateTimeOffset" Usage="Azure.AI.MetricsAdvisor.GetMetricSeriesDataOptions.StartsOn" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.MetricsAdvisor</AssemblyName>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTimeOffset</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Filters the result. Only data points ingested from this point in time, in UTC, will be returned.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>