xml/System.ClientModel.Primitives/ClientLoggingOptions.xml

<Type Name="ClientLoggingOptions" FullName="System.ClientModel.Primitives.ClientLoggingOptions">
  <TypeSignature Language="C#" Value="public class ClientLoggingOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientLoggingOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ClientLoggingOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class ClientLoggingOptions" />
  <TypeSignature Language="F#" Value="type ClientLoggingOptions = class" />
  <AssemblyInfo>
    <AssemblyName>System.ClientModel</AssemblyName>
    <AssemblyVersion>1.3.0.0</AssemblyVersion>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Exposes client options for logging within a <see cref="T:System.ClientModel.Primitives.ClientPipeline" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientLoggingOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientLoggingOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AllowedHeaderNames">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; AllowedHeaderNames { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; AllowedHeaderNames" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.AllowedHeaderNames" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property AllowedHeaderNames As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.AllowedHeaderNames : System.Collections.Generic.IList&lt;string&gt;" Usage="System.ClientModel.Primitives.ClientLoggingOptions.AllowedHeaderNames" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a list of header names that are not redacted during logging.
            </summary>
        <value>Defaults to a list of common header names that do not
            typically hold sensitive information.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AllowedQueryParameters">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; AllowedQueryParameters { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; AllowedQueryParameters" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.AllowedQueryParameters" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property AllowedQueryParameters As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.AllowedQueryParameters : System.Collections.Generic.IList&lt;string&gt;" Usage="System.ClientModel.Primitives.ClientLoggingOptions.AllowedQueryParameters" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a list of query parameter names that are not redacted during logging.
            </summary>
        <value>Defaults to a list of common query parameters that do not
            typically hold sensitive information.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AssertNotFrozen">
      <MemberSignature Language="C#" Value="protected void AssertNotFrozen ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AssertNotFrozen() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientLoggingOptions.AssertNotFrozen" />
      <MemberSignature Language="VB.NET" Value="Protected Sub AssertNotFrozen ()" />
      <MemberSignature Language="F#" Value="member this.AssertNotFrozen : unit -&gt; unit" Usage="clientLoggingOptions.AssertNotFrozen " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Assert that <see cref="M:System.ClientModel.Primitives.ClientLoggingOptions.Freeze" /> has not been called on this
            <see cref="T:System.ClientModel.Primitives.ClientLoggingOptions" /> instance.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">Thrown when an attempt is
            made to change the state of this <see cref="T:System.ClientModel.Primitives.ClientLoggingOptions" /> instance
            after <see cref="M:System.ClientModel.Primitives.ClientLoggingOptions.Freeze" /> has been called.</exception>
      </Docs>
    </Member>
    <Member MemberName="EnableLogging">
      <MemberSignature Language="C#" Value="public bool? EnableLogging { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; EnableLogging" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.EnableLogging" />
      <MemberSignature Language="VB.NET" Value="Public Property EnableLogging As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.EnableLogging : Nullable&lt;bool&gt; with get, set" Usage="System.ClientModel.Primitives.ClientLoggingOptions.EnableLogging" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets value indicating if logging should be enabled in this client pipeline.
            </summary>
        <value>Defaults to <c>null</c>. If <c>null</c>, this value will be treated as <c>true</c>.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EnableMessageContentLogging">
      <MemberSignature Language="C#" Value="public bool? EnableMessageContentLogging { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; EnableMessageContentLogging" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.EnableMessageContentLogging" />
      <MemberSignature Language="VB.NET" Value="Public Property EnableMessageContentLogging As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.EnableMessageContentLogging : Nullable&lt;bool&gt; with get, set" Usage="System.ClientModel.Primitives.ClientLoggingOptions.EnableMessageContentLogging" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets value indicating if request and response content should be logged.
            </summary>
        <value>Defaults to <c>null</c>. If <c>null</c>, this value will be treated as <c>false</c>.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EnableMessageLogging">
      <MemberSignature Language="C#" Value="public bool? EnableMessageLogging { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; EnableMessageLogging" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.EnableMessageLogging" />
      <MemberSignature Language="VB.NET" Value="Public Property EnableMessageLogging As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.EnableMessageLogging : Nullable&lt;bool&gt; with get, set" Usage="System.ClientModel.Primitives.ClientLoggingOptions.EnableMessageLogging" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets value indicating if request and response uri and header information should be logged.
            </summary>
        <value>Defaults to <c>null</c>. If <c>null</c>, the value
            of <see cref="P:System.ClientModel.Primitives.ClientLoggingOptions.EnableLogging" /> will be used instead.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Freeze">
      <MemberSignature Language="C#" Value="public virtual void Freeze ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Freeze() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientLoggingOptions.Freeze" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Freeze ()" />
      <MemberSignature Language="F#" Value="abstract member Freeze : unit -&gt; unit&#xA;override this.Freeze : unit -&gt; unit" Usage="clientLoggingOptions.Freeze " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Freeze this instance of <see cref="T:System.ClientModel.Primitives.ClientLoggingOptions" />.  After this method
            has been called, any attempt to set properties on the instance or call
            methods that would change its state will throw <see cref="T:System.InvalidOperationException" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LoggerFactory">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.Logging.ILoggerFactory? LoggerFactory { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Extensions.Logging.ILoggerFactory LoggerFactory" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.LoggerFactory" />
      <MemberSignature Language="VB.NET" Value="Public Property LoggerFactory As ILoggerFactory" />
      <MemberSignature Language="F#" Value="member this.LoggerFactory : Microsoft.Extensions.Logging.ILoggerFactory with get, set" Usage="System.ClientModel.Primitives.ClientLoggingOptions.LoggerFactory" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.Logging.ILoggerFactory</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the implementation of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> to use to
            create <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances for logging.
            </summary>
        <value>Defaults to <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory" />.</value>
        <remarks>If an ILoggerFactory is not provided, logs will be written to Event Source
            instead. If an ILoggerFactory is provided, logs will be written to ILogger only and not
            Event Source.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MessageContentSizeLimit">
      <MemberSignature Language="C#" Value="public int? MessageContentSizeLimit { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MessageContentSizeLimit" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientLoggingOptions.MessageContentSizeLimit" />
      <MemberSignature Language="VB.NET" Value="Public Property MessageContentSizeLimit As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MessageContentSizeLimit : Nullable&lt;int&gt; with get, set" Usage="System.ClientModel.Primitives.ClientLoggingOptions.MessageContentSizeLimit" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets value indicating maximum size of content to log in bytes.
            </summary>
        <value>Defaults to <c>null</c>. If <c>null</c>, this value will be treated as </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>