RequestTimeoutAttribute.xml

<Type Name="RequestTimeoutAttribute" FullName="Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute">
  <TypeSignature Language="C#" Value="public sealed class RequestTimeoutAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RequestTimeoutAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class RequestTimeoutAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type RequestTimeoutAttribute = class&#xA;    inherit Attribute" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.AspNetCore.Http</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(2)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Metadata that provides endpoint-specific request timeouts.
            </summary>
    <remarks>
            The default policy will be ignored with this attribute applied.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RequestTimeoutAttribute (int milliseconds);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 milliseconds) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.#ctor(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (milliseconds As Integer)" />
      <MemberSignature Language="F#" Value="new Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute : int -&gt; Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute" Usage="new Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute milliseconds" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="milliseconds" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="milliseconds">The duration, in milliseconds, of the timeout for this endpoint.</param>
        <summary>
            Creates a new instance of <see cref="T:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute" /> using the specified timeout.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RequestTimeoutAttribute (string policyName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string policyName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (policyName As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute : string -&gt; Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute" Usage="new Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute policyName" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(1)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="policyName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="policyName">The name of the policy which needs to be applied (case-insensitive).</param>
        <summary>
            Creates a new instance of <see cref="T:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute" /> using the specified policy.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PolicyName">
      <MemberSignature Language="C#" Value="public string? PolicyName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string PolicyName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.PolicyName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property PolicyName As String" />
      <MemberSignature Language="F#" Value="member this.PolicyName : string" Usage="Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.PolicyName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The name of the policy which needs to be applied.
            This value is case-insensitive.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Timeout">
      <MemberSignature Language="C#" Value="public TimeSpan? Timeout { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; Timeout" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.Timeout" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Timeout As Nullable(Of TimeSpan)" />
      <MemberSignature Language="F#" Value="member this.Timeout : Nullable&lt;TimeSpan&gt;" Usage="Microsoft.AspNetCore.Http.Timeouts.RequestTimeoutAttribute.Timeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The timeout to apply for this endpoint.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>