xml/System.Fabric.Description/ApplicationMetricDescription.xml

<Type Name="ApplicationMetricDescription" FullName="System.Fabric.Description.ApplicationMetricDescription">
  <TypeSignature Language="C#" Value="public sealed class ApplicationMetricDescription" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ApplicationMetricDescription extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.Description.ApplicationMetricDescription" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class ApplicationMetricDescription" />
  <TypeSignature Language="F#" Value="type ApplicationMetricDescription = class" />
  <AssemblyInfo>
    <AssemblyName>System.Fabric</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Specifies the application capacity for one metric.
            </summary>
    <remarks>To be added.</remarks>
    <altmember cref="T:System.Fabric.Description.ApplicationUpdateDescription" />
    <altmember cref="T:System.Fabric.Description.ApplicationDescription" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ApplicationMetricDescription ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Description.ApplicationMetricDescription.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MaximumNodeCapacity">
      <MemberSignature Language="C#" Value="public long MaximumNodeCapacity { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 MaximumNodeCapacity" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ApplicationMetricDescription.MaximumNodeCapacity" />
      <MemberSignature Language="VB.NET" Value="Public Property MaximumNodeCapacity As Long" />
      <MemberSignature Language="F#" Value="member this.MaximumNodeCapacity : int64 with get, set" Usage="System.Fabric.Description.ApplicationMetricDescription.MaximumNodeCapacity" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the maximum node capacity for Service Fabric application.
            </summary>
        <value>
          <para>
            Specifies the Maximum Load for an instance of this Application on a single Node.
            Even if Capacity of the node is greater than this value, Service Fabric will limit the
            total load of services within the Application on each node to this value.
            </para>
          <para>If set to zero, capacity for this metric is unlimited on each node.</para>
          <para>
            When creating a new application with application capacity defined, the product of <see cref="P:System.Fabric.Description.ApplicationDescription.MaximumNodes" />
            and this value must always be smaller than or equal to <see cref="P:System.Fabric.Description.ApplicationMetricDescription.TotalApplicationCapacity" />.
            </para>
          <para>
            When updating existing application with application capacity, the product of <see cref="P:System.Fabric.Description.ApplicationUpdateDescription.MaximumNodes" />
            and this value must always be smaller than or equal to <see cref="P:System.Fabric.Description.ApplicationMetricDescription.TotalApplicationCapacity" />.
            </para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ApplicationMetricDescription.Name" />
      <MemberSignature Language="VB.NET" Value="Public Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="System.Fabric.Description.ApplicationMetricDescription.Name" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the name of the metric.
            </summary>
        <value>
            The name of the metric.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NodeReservationCapacity">
      <MemberSignature Language="C#" Value="public long NodeReservationCapacity { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 NodeReservationCapacity" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ApplicationMetricDescription.NodeReservationCapacity" />
      <MemberSignature Language="VB.NET" Value="Public Property NodeReservationCapacity As Long" />
      <MemberSignature Language="F#" Value="member this.NodeReservationCapacity : int64 with get, set" Usage="System.Fabric.Description.ApplicationMetricDescription.NodeReservationCapacity" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the node reservation capacity for Service Fabric application.
            </summary>
        <value>
          <para>
            Specifies the amount of Metric Load which is reserved on nodes which have instances of this Application.
            If <see cref="P:System.Fabric.Description.ApplicationDescription.MinimumNodes" /> is specified, then
            the product of these values will be the Capacity reserved in the cluster for the Application.
            </para>
          <para>
            If set to zero, no capacity is reserved for this metric.
            </para>
          <para>
            When setting application capacity (<see cref="T:System.Fabric.Description.ApplicationDescription" />) or when updating
            application capacity ((<see cref="T:System.Fabric.Description.ApplicationUpdateDescription" />) this value must be smaller than
            or equal to <see cref="P:System.Fabric.Description.ApplicationMetricDescription.MaximumNodeCapacity" /> for each metric.
            </para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TotalApplicationCapacity">
      <MemberSignature Language="C#" Value="public long TotalApplicationCapacity { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 TotalApplicationCapacity" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ApplicationMetricDescription.TotalApplicationCapacity" />
      <MemberSignature Language="VB.NET" Value="Public Property TotalApplicationCapacity As Long" />
      <MemberSignature Language="F#" Value="member this.TotalApplicationCapacity : int64 with get, set" Usage="System.Fabric.Description.ApplicationMetricDescription.TotalApplicationCapacity" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the total metric capacity for Service Fabric application.
            </summary>
        <value>
          <para>
            Specifies the total metric capacity for this Application in the Cluster.
            Service Fabric will try to limit the sum of loads of services within the Application to this value.
            </para>
          <para>
            When creating a new application with application capacity defined, the product of <see cref="P:System.Fabric.Description.ApplicationDescription.MaximumNodes" />
            and <see cref="P:System.Fabric.Description.ApplicationMetricDescription.MaximumNodeCapacity" /> must always be smaller than or equal to this value.
            </para>
          <para>
            When creating a new application with application capacity defined, the product of <see cref="P:System.Fabric.Description.ApplicationUpdateDescription.MaximumNodes" />
            and <see cref="P:System.Fabric.Description.ApplicationMetricDescription.MaximumNodeCapacity" /> must always be smaller than or equal to this value.
            </para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>