xml/System.Fabric.Description/ServiceGroupMemberDescription.xml

<Type Name="ServiceGroupMemberDescription" FullName="System.Fabric.Description.ServiceGroupMemberDescription">
  <TypeSignature Language="C#" Value="public sealed class ServiceGroupMemberDescription" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ServiceGroupMemberDescription extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.Description.ServiceGroupMemberDescription" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class ServiceGroupMemberDescription" />
  <TypeSignature Language="F#" Value="type ServiceGroupMemberDescription = 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>
      <para>Describes a service that belongs to a service group.  </para>
    </summary>
    <remarks>
      <para>A <see cref="T:System.Fabric.Description.ServiceGroupMemberDescription" /> contains a subset of a normal stateless or stateful service 
            description. These fields are relevant to the service inside the group. Other fields that are present in a normal service description, such as 
            partitioning information, become properties of the service group via its <see cref="T:System.Fabric.Description.ServiceGroupDescription" />.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ServiceGroupMemberDescription ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Description.ServiceGroupMemberDescription.#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>
          <para>Creates an empty <see cref="T:System.Fabric.Description.ServiceGroupMemberDescription" /> object.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ServiceGroupMemberDescription (string serviceTypeName, Uri serviceName, byte[] initializationData);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string serviceTypeName, class System.Uri serviceName, unsigned int8[] initializationData) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Description.ServiceGroupMemberDescription.#ctor(System.String,System.Uri,System.Byte[])" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (serviceTypeName As String, serviceName As Uri, initializationData As Byte())" />
      <MemberSignature Language="F#" Value="new System.Fabric.Description.ServiceGroupMemberDescription : string * Uri * byte[] -&gt; System.Fabric.Description.ServiceGroupMemberDescription" Usage="new System.Fabric.Description.ServiceGroupMemberDescription (serviceTypeName, serviceName, initializationData)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="serviceTypeName" Type="System.String" />
        <Parameter Name="serviceName" Type="System.Uri" />
        <Parameter Name="initializationData" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="serviceTypeName">
          <para>The service type name of the service group member.</para>
        </param>
        <param name="serviceName">
          <para>The fully qualified name to set for the member. For example, if the group name is fabric:/G1 and the member is M1, then the full name 
            to specify is fabric:/G1#M1.</para>
        </param>
        <param name="initializationData">
          <para>The byte[] that is provided as the initialization data to the member’s factory.</para>
        </param>
        <summary>
          <para>Creates a <see cref="T:System.Fabric.Description.ServiceGroupMemberDescription" /> object and initializes it with the specified parameters.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="InitializationData">
      <MemberSignature Language="C#" Value="public byte[] InitializationData { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] InitializationData" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ServiceGroupMemberDescription.InitializationData" />
      <MemberSignature Language="VB.NET" Value="Public Property InitializationData As Byte()" />
      <MemberSignature Language="F#" Value="member this.InitializationData : byte[] with get, set" Usage="System.Fabric.Description.ServiceGroupMemberDescription.InitializationData" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Gets or sets the initialization data for this service group member.</para>
        </summary>
        <value>
          <para>the initialization data for this service group member.</para>
        </value>
        <remarks>
          <para>This information is passed by the service group factory to the service factories that correspond to the object when it is created 
            as initialization data for instances of this service group member, similar to how initialization data is passed when normal stateless or 
            stateful service instances are created.</para>
        </remarks>
        <altmember cref="M:System.Fabric.IStatelessServiceFactory.CreateInstance(System.String,System.Uri,System.Byte[],System.Guid,System.Int64)" />
        <altmember cref="M:System.Fabric.IStatefulServiceFactory.CreateReplica(System.String,System.Uri,System.Byte[],System.Guid,System.Int64)" />
        <altmember cref="P:System.Fabric.Description.ServiceDescription.InitializationData" />
      </Docs>
    </Member>
    <Member MemberName="Metrics">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;System.Fabric.Description.ServiceLoadMetricDescription&gt; Metrics { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class System.Fabric.Description.ServiceLoadMetricDescription&gt; Metrics" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ServiceGroupMemberDescription.Metrics" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Metrics As IList(Of ServiceLoadMetricDescription)" />
      <MemberSignature Language="F#" Value="member this.Metrics : System.Collections.Generic.IList&lt;System.Fabric.Description.ServiceLoadMetricDescription&gt;" Usage="System.Fabric.Description.ServiceGroupMemberDescription.Metrics" />
      <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.Description.ServiceLoadMetricDescription&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Gets or sets the collection of <see cref="T:System.Fabric.Description.ServiceLoadMetricDescription" /> objects for this service. The metrics 
            collection contains the <see cref="T:System.Fabric.Description.ServiceLoadMetricDescription" /> objects that are relevant to this service.</para>
        </summary>
        <value>
          <para>Returns <see cref="T:System.Collections.Generic.IList`1" /> of type <see cref="T:System.Fabric.Description.ServiceLoadMetricDescription" />.</para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ServiceName">
      <MemberSignature Language="C#" Value="public Uri ServiceName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Uri ServiceName" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ServiceGroupMemberDescription.ServiceName" />
      <MemberSignature Language="VB.NET" Value="Public Property ServiceName As Uri" />
      <MemberSignature Language="F#" Value="member this.ServiceName : Uri with get, set" Usage="System.Fabric.Description.ServiceGroupMemberDescription.ServiceName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Uri</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Gets or sets the name of the service within the service group.</para>
        </summary>
        <value>
          <para>The <see cref="T:System.Uri" /> representing the service name.</para>
        </value>
        <remarks>
          <para>Services are independently named inside the service group. This name is used as a portion of the stable fabric name to resolve 
            the service. For example, if the service group’s name is "fabric:/groupA" and the service name provided here is "svc1", then a client 
            should resolve the name “fabric:/groupA#svc1” to resolve this service.</para>
        </remarks>
        <altmember cref="T:System.Fabric.Description.ServiceDescription" />
      </Docs>
    </Member>
    <Member MemberName="ServiceTypeName">
      <MemberSignature Language="C#" Value="public string ServiceTypeName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ServiceTypeName" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.ServiceGroupMemberDescription.ServiceTypeName" />
      <MemberSignature Language="VB.NET" Value="Public Property ServiceTypeName As String" />
      <MemberSignature Language="F#" Value="member this.ServiceTypeName : string with get, set" Usage="System.Fabric.Description.ServiceGroupMemberDescription.ServiceTypeName" />
      <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>Gets or sets the service type of this service group member.</para>
        </summary>
        <value>
          <para>The service type name.</para>
        </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>