xml/System.ClientModel.Primitives/PipelineResponse.xml

<Type Name="PipelineResponse" FullName="System.ClientModel.Primitives.PipelineResponse">
  <TypeSignature Language="C#" Value="public abstract class PipelineResponse : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipelineResponse extends System.Object implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelineResponse" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class PipelineResponse&#xA;Implements IDisposable" />
  <TypeSignature Language="F#" Value="type PipelineResponse = class&#xA;    interface IDisposable" />
  <AssemblyInfo>
    <AssemblyName>System.ClientModel</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>1.2.0.0</AssemblyVersion>
    <AssemblyVersion>1.2.1.0</AssemblyVersion>
    <AssemblyVersion>1.3.0.0</AssemblyVersion>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>
            Represents an HTTP response received from a cloud service.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected PipelineResponse ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineResponse.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected 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="BufferContent">
      <MemberSignature Language="C#" Value="public abstract BinaryData BufferContent (System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.BinaryData BufferContent(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineResponse.BufferContent(System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function BufferContent (Optional cancellationToken As CancellationToken = Nothing) As BinaryData" />
      <MemberSignature Language="F#" Value="abstract member BufferContent : System.Threading.CancellationToken -&gt; BinaryData" Usage="pipelineResponse.BufferContent cancellationToken" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.BinaryData</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to
            use while buffering the content.</param>
        <summary>
            Transfer the contents of the response network stream from
            <see cref="P:System.ClientModel.Primitives.PipelineResponse.ContentStream" /> to a buffered cache on this
            <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> instance.
            </summary>
        <returns>The buffered content.</returns>
        <remarks>
            This method will read the full content from the response content
            network stream into memory. Please be sure the contents will fit into
            memory before calling this method.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="BufferContentAsync">
      <MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask&lt;BinaryData&gt; BufferContentAsync (System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class System.BinaryData&gt; BufferContentAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineResponse.BufferContentAsync(System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function BufferContentAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of BinaryData)" />
      <MemberSignature Language="F#" Value="abstract member BufferContentAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;BinaryData&gt;" Usage="pipelineResponse.BufferContentAsync cancellationToken" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.ValueTask&lt;System.BinaryData&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to
            use while buffering the content.</param>
        <summary>
            Transfer the contents of the response network stream from
            <see cref="P:System.ClientModel.Primitives.PipelineResponse.ContentStream" /> to a buffered cache on this
            <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> instance.
            </summary>
        <returns>The buffered content.</returns>
        <remarks>
            This method will read the full content from the response content
            network stream into memory. Please be sure the contents will fit into
            memory before calling this method.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Content">
      <MemberSignature Language="C#" Value="public abstract BinaryData Content { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.BinaryData Content" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.Content" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Content As BinaryData" />
      <MemberSignature Language="F#" Value="member this.Content : BinaryData" Usage="System.ClientModel.Primitives.PipelineResponse.Content" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.BinaryData</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the contents of the HTTP response.
            </summary>
        <value>To be added.</value>
        <remarks>
          <see cref="P:System.ClientModel.Primitives.PipelineResponse.Content" /> holds the in-memory contents of the HTTP response
            when <see cref="P:System.ClientModel.Primitives.PipelineMessage.BufferResponse" /> is <c>true</c> on
            the message sent via <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />.
            If this <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> instance was obtained from the
            return value of a client's service method, please refer to the
            documentation for the service method to understand whether this property
            can be accessed without throwing an exception. If this instance is
            accessed from a <see cref="T:System.ClientModel.Primitives.PipelinePolicy" />, please check the value of
            <see cref="P:System.ClientModel.Primitives.PipelineMessage.BufferResponse" /> to determine whether to
            obtain the response content from <see cref="P:System.ClientModel.Primitives.PipelineResponse.Content" /> or
            <see cref="P:System.ClientModel.Primitives.PipelineResponse.ContentStream" />.
            </remarks>
        <exception cref="T:System.InvalidOperationException">Thrown if the response is
            not buffered.</exception>
      </Docs>
    </Member>
    <Member MemberName="ContentStream">
      <MemberSignature Language="C#" Value="public abstract System.IO.Stream? ContentStream { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.IO.Stream ContentStream" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.ContentStream" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Property ContentStream As Stream" />
      <MemberSignature Language="F#" Value="member this.ContentStream : System.IO.Stream with get, set" Usage="System.ClientModel.Primitives.PipelineResponse.ContentStream" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Stream</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the contents of the HTTP response.
            </summary>
        <value>To be added.</value>
        <remarks>
          <see cref="P:System.ClientModel.Primitives.PipelineResponse.ContentStream" /> may be a stream that contains the buffered
            contents transferred from the network stream that originally held the
            contents of the service response; or it may be the live network stream
            itself, depending on the value of
            <see cref="P:System.ClientModel.Primitives.PipelineMessage.BufferResponse" /> on the message sent via
            <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. Please refer to the
            documentation for a client's service method if needed to understand
            whether this <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> instance must be disposed
            to close the network stream.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public abstract void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineResponse.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit" Usage="pipelineResponse.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Headers">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponseHeaders Headers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineResponseHeaders Headers" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.Headers" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Headers As PipelineResponseHeaders" />
      <MemberSignature Language="F#" Value="member this.Headers : System.ClientModel.Primitives.PipelineResponseHeaders" Usage="System.ClientModel.Primitives.PipelineResponse.Headers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineResponseHeaders</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the collection of HTTP response headers.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HeadersCore">
      <MemberSignature Language="C#" Value="protected abstract System.ClientModel.Primitives.PipelineResponseHeaders HeadersCore { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineResponseHeaders HeadersCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.HeadersCore" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride ReadOnly Property HeadersCore As PipelineResponseHeaders" />
      <MemberSignature Language="F#" Value="member this.HeadersCore : System.ClientModel.Primitives.PipelineResponseHeaders" Usage="System.ClientModel.Primitives.PipelineResponse.HeadersCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineResponseHeaders</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of the response's
            <see cref="P:System.ClientModel.Primitives.PipelineResponse.Headers" /> collection.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsError">
      <MemberSignature Language="C#" Value="public virtual bool IsError { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsError" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.IsError" />
      <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property IsError As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsError : bool" Usage="System.ClientModel.Primitives.PipelineResponse.IsError" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Indicates whether the status code of the returned response is considered
            an error code.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsErrorCore">
      <MemberSignature Language="C#" Value="protected internal virtual bool IsErrorCore { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsErrorCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.IsErrorCore" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Overridable Property IsErrorCore As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsErrorCore : bool with get, set" Usage="System.ClientModel.Primitives.PipelineResponse.IsErrorCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of <see cref="P:System.ClientModel.Primitives.PipelineResponse.IsError" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ReasonPhrase">
      <MemberSignature Language="C#" Value="public abstract string ReasonPhrase { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ReasonPhrase" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.ReasonPhrase" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property ReasonPhrase As String" />
      <MemberSignature Language="F#" Value="member this.ReasonPhrase : string" Usage="System.ClientModel.Primitives.PipelineResponse.ReasonPhrase" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the reason phrase that accompanies the status code on the HTTP
            response.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Status">
      <MemberSignature Language="C#" Value="public abstract int Status { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Status" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineResponse.Status" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Status As Integer" />
      <MemberSignature Language="F#" Value="member this.Status : int" Usage="System.ClientModel.Primitives.PipelineResponse.Status" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the status code of the HTTP response.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>