PartitionHealthStateFilter.xml

<Type Name="PartitionHealthStateFilter" FullName="System.Fabric.Health.PartitionHealthStateFilter">
  <TypeSignature Language="C#" Value="public sealed class PartitionHealthStateFilter" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PartitionHealthStateFilter extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.Health.PartitionHealthStateFilter" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class PartitionHealthStateFilter" />
  <TypeSignature Language="F#" Value="type PartitionHealthStateFilter = 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>
            Filter for <see cref="T:System.Fabric.Health.PartitionHealthState" /> objects.
            </summary>
    <remarks>The health state chunk queries can specify a list of partition filters to fine-grain
            select the partitions that should be included in the query result.
            Note that all the partitions are used to evaluate parents' aggregated health state, regardless of the filter passed in.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PartitionHealthStateFilter ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Health.PartitionHealthStateFilter.#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>
            Initializes a new instance of the <see cref="T:System.Fabric.Health.PartitionHealthStateFilter" /> class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HealthStateFilter">
      <MemberSignature Language="C#" Value="public System.Fabric.Health.HealthStateFilter HealthStateFilter { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Fabric.Health.HealthStateFilter HealthStateFilter" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Health.PartitionHealthStateFilter.HealthStateFilter" />
      <MemberSignature Language="VB.NET" Value="Public Property HealthStateFilter As HealthStateFilter" />
      <MemberSignature Language="F#" Value="member this.HealthStateFilter : System.Fabric.Health.HealthStateFilter with get, set" Usage="System.Fabric.Health.PartitionHealthStateFilter.HealthStateFilter" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Fabric.Health.HealthStateFilter</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets filter for the aggregated health state of the <see cref="T:System.Fabric.Health.PartitionHealthState" /> entries in the collection. 
            </summary>
        <value>The filter for the aggregated health state of the <see cref="T:System.Fabric.Health.PartitionHealthState" /> entries in the collection.</value>
        <remarks>The health state filter value comes from members or bitwise combination of members of <see cref="T:System.Fabric.Health.HealthStateFilter" />. 
            For a partition to match the filter, its aggregated health state must match the specified health state filter.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PartitionIdFilter">
      <MemberSignature Language="C#" Value="public Guid PartitionIdFilter { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid PartitionIdFilter" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Health.PartitionHealthStateFilter.PartitionIdFilter" />
      <MemberSignature Language="VB.NET" Value="Public Property PartitionIdFilter As Guid" />
      <MemberSignature Language="F#" Value="member this.PartitionIdFilter : Guid with get, set" Usage="System.Fabric.Health.PartitionHealthStateFilter.PartitionIdFilter" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Guid</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the partition id filter.
            </summary>
        <value>The partition id filter.</value>
        <remarks>If not specified, all partitions that match the parent filters (if any) and the specified health state filter match the filter.
            Otherwise, the filter only applies to the partition identified by the partition id. All the other filter members, like health state filter and replicas filter, are applied to this partition.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ReplicaFilters">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;System.Fabric.Health.ReplicaHealthStateFilter&gt; ReplicaFilters { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class System.Fabric.Health.ReplicaHealthStateFilter&gt; ReplicaFilters" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Health.PartitionHealthStateFilter.ReplicaFilters" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReplicaFilters As IList(Of ReplicaHealthStateFilter)" />
      <MemberSignature Language="F#" Value="member this.ReplicaFilters : System.Collections.Generic.IList&lt;System.Fabric.Health.ReplicaHealthStateFilter&gt;" Usage="System.Fabric.Health.PartitionHealthStateFilter.ReplicaFilters" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.Fabric.Health.ReplicaHealthStateFilter&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the list of <see cref="T:System.Fabric.Health.ReplicaHealthStateFilter" /> to be applied to the replica children health states.
            </summary>
        <value>The list of <see cref="T:System.Fabric.Health.ReplicaHealthStateFilter" /> to be applied to the replica children health states.</value>
        <remarks>All replica children that match the filter will be returned as children of the partition.
            If empty, the children are not returned by default.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Health.PartitionHealthStateFilter.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="partitionHealthStateFilter.ToString " />
      <MemberType>Method</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>
      <Parameters />
      <Docs>
        <summary>
            Returns a string representation of the filter.
            </summary>
        <returns>A string representation of the filter.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>