IndexDocumentsOptions.xml

<Type Name="IndexDocumentsOptions" FullName="Azure.Search.Documents.IndexDocumentsOptions">
  <TypeSignature Language="C#" Value="public class IndexDocumentsOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IndexDocumentsOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Search.Documents.IndexDocumentsOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class IndexDocumentsOptions" />
  <TypeSignature Language="F#" Value="type IndexDocumentsOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Search.Documents</AssemblyName>
    <AssemblyVersion>11.2.0.0</AssemblyVersion>
    <AssemblyVersion>11.2.1.0</AssemblyVersion>
    <AssemblyVersion>11.3.0.0</AssemblyVersion>
    <AssemblyVersion>11.4.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.1.0</AssemblyVersion>
    <AssemblyVersion>11.6.0.0</AssemblyVersion>
    <AssemblyVersion>11.7.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options for <see cref="M:Azure.Search.Documents.SearchClient.IndexDocumentsAsync``1(Azure.Search.Documents.Models.IndexDocumentsBatch{``0},Azure.Search.Documents.IndexDocumentsOptions,System.Threading.CancellationToken)" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public IndexDocumentsOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.IndexDocumentsOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
        <AssemblyVersion>11.7.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThrowOnAnyError">
      <MemberSignature Language="C#" Value="public bool ThrowOnAnyError { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool ThrowOnAnyError" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" />
      <MemberSignature Language="VB.NET" Value="Public Property ThrowOnAnyError As Boolean" />
      <MemberSignature Language="F#" Value="member this.ThrowOnAnyError : bool with get, set" Usage="Azure.Search.Documents.IndexDocumentsOptions.ThrowOnAnyError" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
        <AssemblyVersion>11.7.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value indicating whether to throw an exception on
            any individual failure in the batch of document write operations.
            Set this to true if you're not inspecting the results of the Index
            Documents action.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>