DocumentTranslationClientOptions.xml

<Type Name="DocumentTranslationClientOptions" FullName="Azure.AI.Translation.Document.DocumentTranslationClientOptions">
  <TypeSignature Language="C#" Value="public class DocumentTranslationClientOptions : Azure.Core.ClientOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DocumentTranslationClientOptions extends Azure.Core.ClientOptions" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class DocumentTranslationClientOptions&#xA;Inherits ClientOptions" />
  <TypeSignature Language="F#" Value="type DocumentTranslationClientOptions = class&#xA;    inherit ClientOptions" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.Translation.Document</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Core.ClientOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options that allow to configure the management of the request sent to the service.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DocumentTranslationClientOptions (Azure.AI.Translation.Document.DocumentTranslationClientOptions.ServiceVersion version = Azure.AI.Translation.Document.DocumentTranslationClientOptions+ServiceVersion.V1_0);" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Azure.AI.Translation.Document.DocumentTranslationClientOptions/ServiceVersion version) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClientOptions.#ctor(Azure.AI.Translation.Document.DocumentTranslationClientOptions.ServiceVersion)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional version As DocumentTranslationClientOptions.ServiceVersion = Azure.AI.Translation.Document.DocumentTranslationClientOptions+ServiceVersion.V1_0)" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.DocumentTranslationClientOptions : Azure.AI.Translation.Document.DocumentTranslationClientOptions.ServiceVersion -&gt; Azure.AI.Translation.Document.DocumentTranslationClientOptions" Usage="new Azure.AI.Translation.Document.DocumentTranslationClientOptions version" />
      <MemberSignature Language="C#" Value="public DocumentTranslationClientOptions (Azure.AI.Translation.Document.DocumentTranslationClientOptions.ServiceVersion version = Azure.AI.Translation.Document.DocumentTranslationClientOptions+ServiceVersion.V2024_05_01);" FrameworkAlternate="azure-dotnet-preview" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional version As DocumentTranslationClientOptions.ServiceVersion = Azure.AI.Translation.Document.DocumentTranslationClientOptions+ServiceVersion.V2024_05_01)" FrameworkAlternate="azure-dotnet-preview" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.Translation.Document</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="version" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions+ServiceVersion" />
      </Parameters>
      <Docs>
        <param name="version">
            The <see cref="T:Azure.AI.Translation.Document.DocumentTranslationClientOptions.ServiceVersion" /> of the service API used when making requests.
            </param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.Translation.Document.DocumentTranslationClientOptions" /> class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Audience">
      <MemberSignature Language="C#" Value="public Azure.AI.Translation.Document.DocumentTranslationAudience? Audience { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Azure.AI.Translation.Document.DocumentTranslationAudience&gt; Audience" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.Translation.Document.DocumentTranslationClientOptions.Audience" />
      <MemberSignature Language="VB.NET" Value="Public Property Audience As Nullable(Of DocumentTranslationAudience)" />
      <MemberSignature Language="F#" Value="member this.Audience : Nullable&lt;Azure.AI.Translation.Document.DocumentTranslationAudience&gt; with get, set" Usage="Azure.AI.Translation.Document.DocumentTranslationClientOptions.Audience" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.Translation.Document</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Azure.AI.Translation.Document.DocumentTranslationAudience&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
            </summary>
        <value>If <c>null</c>, <see cref="P:Azure.AI.Translation.Document.DocumentTranslationAudience.AzurePublicCloud" /> will be assumed.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>