HybridCountAndFacetMode.xml

<Type Name="HybridCountAndFacetMode" FullName="Azure.Search.Documents.Models.HybridCountAndFacetMode">
  <TypeSignature Language="C#" Value="public readonly struct HybridCountAndFacetMode : IEquatable&lt;Azure.Search.Documents.Models.HybridCountAndFacetMode&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit HybridCountAndFacetMode extends System.ValueType implements class System.IEquatable`1&lt;valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode&gt;" />
  <TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Models.HybridCountAndFacetMode" />
  <TypeSignature Language="VB.NET" Value="Public Structure HybridCountAndFacetMode&#xA;Implements IEquatable(Of HybridCountAndFacetMode)" />
  <TypeSignature Language="F#" Value="type HybridCountAndFacetMode = struct" />
  <AssemblyInfo>
    <AssemblyName>Azure.Search.Documents</AssemblyName>
    <AssemblyVersion>11.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IEquatable&lt;Azure.Search.Documents.Models.HybridCountAndFacetMode&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary> Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. The default value is 'countAllResults'. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public HybridCountAndFacetMode (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (value As String)" />
      <MemberSignature Language="F#" Value="new Azure.Search.Documents.Models.HybridCountAndFacetMode : string -&gt; Azure.Search.Documents.Models.HybridCountAndFacetMode" Usage="new Azure.Search.Documents.Models.HybridCountAndFacetMode value" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Models.HybridCountAndFacetMode" />. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="CountAllResults">
      <MemberSignature Language="C#" Value="public static Azure.Search.Documents.Models.HybridCountAndFacetMode CountAllResults { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode CountAllResults" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.HybridCountAndFacetMode.CountAllResults" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CountAllResults As HybridCountAndFacetMode" />
      <MemberSignature Language="F#" Value="static member CountAllResults : Azure.Search.Documents.Models.HybridCountAndFacetMode" Usage="Azure.Search.Documents.Models.HybridCountAndFacetMode.CountAllResults" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Models.HybridCountAndFacetMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CountRetrievableResults">
      <MemberSignature Language="C#" Value="public static Azure.Search.Documents.Models.HybridCountAndFacetMode CountRetrievableResults { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode CountRetrievableResults" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.HybridCountAndFacetMode.CountRetrievableResults" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CountRetrievableResults As HybridCountAndFacetMode" />
      <MemberSignature Language="F#" Value="static member CountRetrievableResults : Azure.Search.Documents.Models.HybridCountAndFacetMode" Usage="Azure.Search.Documents.Models.HybridCountAndFacetMode.CountRetrievableResults" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Models.HybridCountAndFacetMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Azure.Search.Documents.Models.HybridCountAndFacetMode other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.Equals(Azure.Search.Documents.Models.HybridCountAndFacetMode)" />
      <MemberSignature Language="VB.NET" Value="Public Function Equals (other As HybridCountAndFacetMode) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : Azure.Search.Documents.Models.HybridCountAndFacetMode -&gt; bool" Usage="hybridCountAndFacetMode.Equals other" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Azure.Search.Documents.Models.HybridCountAndFacetMode" />
      </Parameters>
      <Docs>
        <param name="other">An object to compare with this object.</param>
        <summary>Indicates whether the current object is equal to another object of the same type.</summary>
        <returns>
          <see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="hybridCountAndFacetMode.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The object to compare with the current instance.</param>
        <summary>Indicates whether this instance and a specified object are equal.</summary>
        <returns>
          <see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="hybridCountAndFacetMode.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the hash code for this instance.</summary>
        <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (Azure.Search.Documents.Models.HybridCountAndFacetMode left, Azure.Search.Documents.Models.HybridCountAndFacetMode right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode left, valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.op_Equality(Azure.Search.Documents.Models.HybridCountAndFacetMode,Azure.Search.Documents.Models.HybridCountAndFacetMode)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As HybridCountAndFacetMode, right As HybridCountAndFacetMode) As Boolean" />
      <MemberSignature Language="F#" Value="static member ( = ) : Azure.Search.Documents.Models.HybridCountAndFacetMode * Azure.Search.Documents.Models.HybridCountAndFacetMode -&gt; bool" Usage="left = right" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.Search.Documents.Models.HybridCountAndFacetMode" />
        <Parameter Name="right" Type="Azure.Search.Documents.Models.HybridCountAndFacetMode" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.Search.Documents.Models.HybridCountAndFacetMode" /> values are the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static implicit operator Azure.Search.Documents.Models.HybridCountAndFacetMode (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode op_Implicit(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.op_Implicit(System.String)~Azure.Search.Documents.Models.HybridCountAndFacetMode" />
      <MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (value As String) As HybridCountAndFacetMode" />
      <MemberSignature Language="F#" Value="static member op_Implicit : string -&gt; Azure.Search.Documents.Models.HybridCountAndFacetMode" Usage="Azure.Search.Documents.Models.HybridCountAndFacetMode.op_Implicit value" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Models.HybridCountAndFacetMode</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Converts a string to a <see cref="T:Azure.Search.Documents.Models.HybridCountAndFacetMode" />. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (Azure.Search.Documents.Models.HybridCountAndFacetMode left, Azure.Search.Documents.Models.HybridCountAndFacetMode right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode left, valuetype Azure.Search.Documents.Models.HybridCountAndFacetMode right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.HybridCountAndFacetMode.op_Inequality(Azure.Search.Documents.Models.HybridCountAndFacetMode,Azure.Search.Documents.Models.HybridCountAndFacetMode)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As HybridCountAndFacetMode, right As HybridCountAndFacetMode) As Boolean" />
      <MemberSignature Language="F#" Value="static member op_Inequality : Azure.Search.Documents.Models.HybridCountAndFacetMode * Azure.Search.Documents.Models.HybridCountAndFacetMode -&gt; bool" Usage="Azure.Search.Documents.Models.HybridCountAndFacetMode.op_Inequality (left, right)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.Search.Documents.Models.HybridCountAndFacetMode" />
        <Parameter Name="right" Type="Azure.Search.Documents.Models.HybridCountAndFacetMode" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.Search.Documents.Models.HybridCountAndFacetMode" /> values are not the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</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:Azure.Search.Documents.Models.HybridCountAndFacetMode.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="hybridCountAndFacetMode.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the fully qualified type name of this instance.</summary>
        <returns>The fully qualified type name.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>