LoadMetric.xml

<Type Name="LoadMetric" FullName="System.Fabric.LoadMetric">
  <TypeSignature Language="C#" Value="public sealed class LoadMetric" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed beforefieldinit LoadMetric extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.LoadMetric" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class LoadMetric" />
  <TypeSignature Language="F#" Value="type LoadMetric = 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 />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Serializable]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Serializable&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
      <para>Represents the name of a metric and a runtime value as a name-value pair that is reported to Service Fabric. The metric loads are used by Service Fabric to ensure that the cluster is evenly used and that nodes do not exceed their capacities for given metrics. <see cref="T:System.Fabric.LoadMetric" /> reports are provided to Service Fabric via <see cref="M:System.Fabric.IServicePartition.ReportLoad(System.Collections.Generic.IEnumerable{System.Fabric.LoadMetric})" />.</para>
    </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public LoadMetric (string name, int value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, int32 value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.LoadMetric.#ctor(System.String,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (name As String, value As Integer)" />
      <MemberSignature Language="F#" Value="new System.Fabric.LoadMetric : string * int -&gt; System.Fabric.LoadMetric" Usage="new System.Fabric.LoadMetric (name, value)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="value" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="name">
          <para>The name of the metric. This string must match the names of the metrics that are specified in the <see cref="P:System.Fabric.Description.ServiceDescription.Metrics" /> collection, or they will be ignored.</para>
        </param>
        <param name="value">
          <para>The current value of the metric as an integer.</para>
        </param>
        <summary>
          <para>Creates and initializes a <see cref="T:System.Fabric.LoadMetric" /> object with the specified name and load value.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.LoadMetric.Name" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Fabric.LoadMetric.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>
          <para>Indicates the name of the metric that the service plans to report. </para>
        </summary>
        <value>
          <para>Returns <see cref="T:System.String" />.</para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Value">
      <MemberSignature Language="C#" Value="public int Value { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Value" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.LoadMetric.Value" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As Integer" />
      <MemberSignature Language="F#" Value="member this.Value : int" Usage="System.Fabric.LoadMetric.Value" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Indicates the current load of the metric.</para>
        </summary>
        <value>
          <para>Returns <see cref="T:System.Int32" />.</para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>