SearchIndexerIndexProjectionSelector.xml

<Type Name="SearchIndexerIndexProjectionSelector" FullName="Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector">
  <TypeSignature Language="C#" Value="public class SearchIndexerIndexProjectionSelector" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchIndexerIndexProjectionSelector extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector" />
  <TypeSignature Language="VB.NET" Value="Public Class SearchIndexerIndexProjectionSelector" />
  <TypeSignature Language="F#" Value="type SearchIndexerIndexProjectionSelector = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Search.Documents</AssemblyName>
    <AssemblyVersion>11.5.0.0</AssemblyVersion>
    <AssemblyVersion>11.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> Description for what data to store in the designated search index. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SearchIndexerIndexProjectionSelector (string targetIndexName, string parentKeyFieldName, string sourceContext, System.Collections.Generic.IEnumerable&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt; mappings);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string targetIndexName, string parentKeyFieldName, string sourceContext, class System.Collections.Generic.IEnumerable`1&lt;class Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt; mappings) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.#ctor(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (targetIndexName As String, parentKeyFieldName As String, sourceContext As String, mappings As IEnumerable(Of InputFieldMappingEntry))" />
      <MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector : string * string * string * seq&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt; -&gt; Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector" Usage="new Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector (targetIndexName, parentKeyFieldName, sourceContext, mappings)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="targetIndexName" Type="System.String" />
        <Parameter Name="parentKeyFieldName" Type="System.String" />
        <Parameter Name="sourceContext" Type="System.String" />
        <Parameter Name="mappings" Type="System.Collections.Generic.IEnumerable&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt;" />
      </Parameters>
      <Docs>
        <param name="targetIndexName"> Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. </param>
        <param name="parentKeyFieldName"> Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. </param>
        <param name="sourceContext"> Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. </param>
        <param name="mappings"> Mappings for the projection, or which source should be mapped to which field in the target index. </param>
        <summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector" />. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="targetIndexName" />, <paramref name="parentKeyFieldName" />, <paramref name="sourceContext" /> or <paramref name="mappings" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="Mappings">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt; Mappings { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt; Mappings" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.Mappings" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Mappings As IList(Of InputFieldMappingEntry)" />
      <MemberSignature Language="F#" Value="member this.Mappings : System.Collections.Generic.IList&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt;" Usage="Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.Mappings" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Mappings for the projection, or which source should be mapped to which field in the target index. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ParentKeyFieldName">
      <MemberSignature Language="C#" Value="public string ParentKeyFieldName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ParentKeyFieldName" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.ParentKeyFieldName" />
      <MemberSignature Language="VB.NET" Value="Public Property ParentKeyFieldName As String" />
      <MemberSignature Language="F#" Value="member this.ParentKeyFieldName : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.ParentKeyFieldName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SourceContext">
      <MemberSignature Language="C#" Value="public string SourceContext { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SourceContext" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.SourceContext" />
      <MemberSignature Language="VB.NET" Value="Public Property SourceContext As String" />
      <MemberSignature Language="F#" Value="member this.SourceContext : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.SourceContext" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TargetIndexName">
      <MemberSignature Language="C#" Value="public string TargetIndexName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TargetIndexName" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.TargetIndexName" />
      <MemberSignature Language="VB.NET" Value="Public Property TargetIndexName As String" />
      <MemberSignature Language="F#" Value="member this.TargetIndexName : string with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchIndexerIndexProjectionSelector.TargetIndexName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>