xml/System.ClientModel.Primitives/PipelineRequest.xml

<Type Name="PipelineRequest" FullName="System.ClientModel.Primitives.PipelineRequest">
  <TypeSignature Language="C#" Value="public abstract class PipelineRequest : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipelineRequest extends System.Object implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelineRequest" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class PipelineRequest&#xA;Implements IDisposable" />
  <TypeSignature Language="F#" Value="type PipelineRequest = 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 request to be sent to a cloud service.
            The type of a <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> is specific to the type of the
            <see cref="T:System.ClientModel.Primitives.PipelineTransport" /> used by the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />
            that sends the request.  Because of this,
            <see cref="M:System.ClientModel.Primitives.ClientPipeline.CreateMessage" /> is used to create an instance of
            <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> for a given pipeline.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected PipelineRequest ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineRequest.#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="Content">
      <MemberSignature Language="C#" Value="public System.ClientModel.BinaryContent? Content { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.BinaryContent Content" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.Content" />
      <MemberSignature Language="VB.NET" Value="Public Property Content As BinaryContent" />
      <MemberSignature Language="F#" Value="member this.Content : System.ClientModel.BinaryContent with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.Content" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.BinaryContent</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the contents of the HTTP request.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ContentCore">
      <MemberSignature Language="C#" Value="protected abstract System.ClientModel.BinaryContent? ContentCore { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.BinaryContent ContentCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.ContentCore" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Property ContentCore As BinaryContent" />
      <MemberSignature Language="F#" Value="member this.ContentCore : System.ClientModel.BinaryContent with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.ContentCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.BinaryContent</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of the request's
            <see cref="P:System.ClientModel.Primitives.PipelineRequest.Content" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</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.PipelineRequest.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit" Usage="pipelineRequest.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.PipelineRequestHeaders Headers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineRequestHeaders Headers" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.Headers" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Headers As PipelineRequestHeaders" />
      <MemberSignature Language="F#" Value="member this.Headers : System.ClientModel.Primitives.PipelineRequestHeaders" Usage="System.ClientModel.Primitives.PipelineRequest.Headers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineRequestHeaders</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the collection of HTTP request 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.PipelineRequestHeaders HeadersCore { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineRequestHeaders HeadersCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.HeadersCore" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride ReadOnly Property HeadersCore As PipelineRequestHeaders" />
      <MemberSignature Language="F#" Value="member this.HeadersCore : System.ClientModel.Primitives.PipelineRequestHeaders" Usage="System.ClientModel.Primitives.PipelineRequest.HeadersCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineRequestHeaders</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of the request's
            <see cref="P:System.ClientModel.Primitives.PipelineRequest.Headers" /> collection.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Method">
      <MemberSignature Language="C#" Value="public string Method { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Method" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.Method" />
      <MemberSignature Language="VB.NET" Value="Public Property Method As String" />
      <MemberSignature Language="F#" Value="member this.Method : string with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.Method" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the HTTP method used by the HTTP request.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MethodCore">
      <MemberSignature Language="C#" Value="protected abstract string MethodCore { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string MethodCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.MethodCore" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Property MethodCore As String" />
      <MemberSignature Language="F#" Value="member this.MethodCore : string with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.MethodCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of the request's
            <see cref="P:System.ClientModel.Primitives.PipelineRequest.Method" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Uri">
      <MemberSignature Language="C#" Value="public Uri? Uri { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Uri Uri" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.Uri" />
      <MemberSignature Language="VB.NET" Value="Public Property Uri As Uri" />
      <MemberSignature Language="F#" Value="member this.Uri : Uri with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.Uri" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Uri</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="T:System.Uri" /> used for the HTTP request.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UriCore">
      <MemberSignature Language="C#" Value="protected abstract Uri? UriCore { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Uri UriCore" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineRequest.UriCore" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Property UriCore As Uri" />
      <MemberSignature Language="F#" Value="member this.UriCore : Uri with get, set" Usage="System.ClientModel.Primitives.PipelineRequest.UriCore" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Uri</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the derived-type's value of the request's <see cref="P:System.ClientModel.Primitives.PipelineRequest.Uri" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>