xml/System.ClientModel.Primitives/PipelineMessage.xml (384 lines of code) (raw):

<Type Name="PipelineMessage" FullName="System.ClientModel.Primitives.PipelineMessage"> <TypeSignature Language="C#" Value="public class PipelineMessage : IDisposable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PipelineMessage extends System.Object implements class System.IDisposable" /> <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelineMessage" /> <TypeSignature Language="VB.NET" Value="Public Class PipelineMessage&#xA;Implements IDisposable" /> <TypeSignature Language="F#" Value="type PipelineMessage = 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 message that can be sent from a <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> holds the request sent to the cloud service, and <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> holds the response received from the service. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected internal PipelineMessage (System.ClientModel.Primitives.PipelineRequest request);" /> <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(class System.ClientModel.Primitives.PipelineRequest request) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.#ctor(System.ClientModel.Primitives.PipelineRequest)" /> <MemberSignature Language="VB.NET" Value="Protected Friend Sub New (request As PipelineRequest)" /> <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.PipelineMessage : System.ClientModel.Primitives.PipelineRequest -&gt; System.ClientModel.Primitives.PipelineMessage" Usage="new System.ClientModel.Primitives.PipelineMessage request" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="request" Type="System.ClientModel.Primitives.PipelineRequest" /> </Parameters> <Docs> <param name="request">The <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> to set on this instance's <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> property.</param> <summary> Creates an instance of <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> with <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> set to the provided <paramref name="request" />. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Apply"> <MemberSignature Language="C#" Value="public void Apply (System.ClientModel.Primitives.RequestOptions? options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Apply(class System.ClientModel.Primitives.RequestOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Apply(System.ClientModel.Primitives.RequestOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub Apply (options As RequestOptions)" /> <MemberSignature Language="F#" Value="member this.Apply : System.ClientModel.Primitives.RequestOptions -&gt; unit" Usage="pipelineMessage.Apply options" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="options" Type="System.ClientModel.Primitives.RequestOptions" /> </Parameters> <Docs> <param name="options">The <see cref="T:System.ClientModel.Primitives.RequestOptions" /> to apply to this <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. If <c>null</c> is passed, no changes will be made to this message instance.</param> <summary> Apply the options from the provided <see cref="T:System.ClientModel.Primitives.RequestOptions" /> to this <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. </summary> <remarks> This method is intended to be called after the creation of the <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> and its <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> is complete, and prior to the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. </remarks> </Docs> </Member> <Member MemberName="BufferResponse"> <MemberSignature Language="C#" Value="public bool BufferResponse { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool BufferResponse" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.BufferResponse" /> <MemberSignature Language="VB.NET" Value="Public Property BufferResponse As Boolean" /> <MemberSignature Language="F#" Value="member this.BufferResponse : bool with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.BufferResponse" /> <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 value indicating whether the response should be buffered in-memory by the pipeline. Defaults to true. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CancellationToken"> <MemberSignature Language="C#" Value="public System.Threading.CancellationToken CancellationToken { get; protected internal set; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.CancellationToken CancellationToken" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.CancellationToken" /> <MemberSignature Language="VB.NET" Value="Public Property CancellationToken As CancellationToken" /> <MemberSignature Language="F#" Value="member this.CancellationToken : System.Threading.CancellationToken with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.CancellationToken" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.CancellationToken</ReturnType> </ReturnValue> <Docs> <summary> Gets or sets the <see cref="P:System.ClientModel.Primitives.PipelineMessage.CancellationToken" /> used for the duration of the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Dispose"> <MemberSignature Language="C#" Value="public void Dispose ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Dispose" /> <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" /> <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="pipelineMessage.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="Dispose"> <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Dispose(System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" /> <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="pipelineMessage.Dispose disposing" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="disposing" Type="System.Boolean" /> </Parameters> <Docs> <param name="disposing"> <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources. </param> <summary> Releases the unmanaged resources used by the <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> and optionally disposes of the managed resources. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ExtractResponse"> <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponse? ExtractResponse ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ClientModel.Primitives.PipelineResponse ExtractResponse() cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.ExtractResponse" /> <MemberSignature Language="VB.NET" Value="Public Function ExtractResponse () As PipelineResponse" /> <MemberSignature Language="F#" Value="member this.ExtractResponse : unit -&gt; System.ClientModel.Primitives.PipelineResponse" Usage="pipelineMessage.ExtractResponse " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.ClientModel.Primitives.PipelineResponse</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Returns the value of the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> property and transfers dispose ownership of the response to the caller. After calling this method, the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> property will be <code>null</code> and the caller will be responsible for disposing the returned value, which may hold a live network stream. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="NetworkTimeout"> <MemberSignature Language="C#" Value="public TimeSpan? NetworkTimeout { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; NetworkTimeout" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.NetworkTimeout" /> <MemberSignature Language="VB.NET" Value="Public Property NetworkTimeout As Nullable(Of TimeSpan)" /> <MemberSignature Language="F#" Value="member this.NetworkTimeout : Nullable&lt;TimeSpan&gt; with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.NetworkTimeout" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType> </ReturnValue> <Docs> <summary> Gets or sets the network timeout value for this message. If <c>null</c>, the value set on the client's options will be used. Defaults to <c>null</c>. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Request"> <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineRequest Request { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineRequest Request" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.Request" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Request As PipelineRequest" /> <MemberSignature Language="F#" Value="member this.Request : System.ClientModel.Primitives.PipelineRequest" Usage="System.ClientModel.Primitives.PipelineMessage.Request" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.ClientModel.Primitives.PipelineRequest</ReturnType> </ReturnValue> <Docs> <summary> Gets the <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> to send to the service during the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Response"> <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponse? Response { get; protected internal set; }" /> <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineResponse Response" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.Response" /> <MemberSignature Language="VB.NET" Value="Public Property Response As PipelineResponse" /> <MemberSignature Language="F#" Value="member this.Response : System.ClientModel.Primitives.PipelineResponse with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.Response" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.ClientModel.Primitives.PipelineResponse</ReturnType> </ReturnValue> <Docs> <summary> Gets the <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from the service during the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ResponseClassifier"> <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier" /> <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.ResponseClassifier" /> <MemberSignature Language="VB.NET" Value="Public Property ResponseClassifier As PipelineMessageClassifier" /> <MemberSignature Language="F#" Value="member this.ResponseClassifier : System.ClientModel.Primitives.PipelineMessageClassifier with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.ResponseClassifier" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.ClientModel.Primitives.PipelineMessageClassifier</ReturnType> </ReturnValue> <Docs> <summary> Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> used by the <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> to determine whether the response received from the service is considered an error and populate the <see cref="P:System.ClientModel.Primitives.PipelineResponse.IsError" /> on <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" />. This property is intended to be set in a client's service method to a a <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> that classifies responses as success responses based on the service API's published success codes. Setting this value outside the service method will override the client-specified classifier and may result in undesired behavior. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SetProperty"> <MemberSignature Language="C#" Value="public void SetProperty (Type key, object? value);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(class System.Type key, object value) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.SetProperty(System.Type,System.Object)" /> <MemberSignature Language="VB.NET" Value="Public Sub SetProperty (key As Type, value As Object)" /> <MemberSignature Language="F#" Value="member this.SetProperty : Type * obj -&gt; unit" Usage="pipelineMessage.SetProperty (key, value)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="key" Type="System.Type" /> <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> <param name="key">The key for the property in the message's property bag.</param> <param name="value">The value of the property.</param> <summary> Set a property in the property bag for this <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. Message properties are used to govern the behavior of specific policies in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. Please refer to documentation for a specific <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to understand what properties it supports. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="TryGetProperty"> <MemberSignature Language="C#" Value="public bool TryGetProperty (Type key, out object? value);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetProperty(class System.Type key, [out] object&amp; value) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.TryGetProperty(System.Type,System.Object@)" /> <MemberSignature Language="VB.NET" Value="Public Function TryGetProperty (key As Type, ByRef value As Object) As Boolean" /> <MemberSignature Language="F#" Value="member this.TryGetProperty : Type * obj -&gt; bool" Usage="pipelineMessage.TryGetProperty (key, value)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="key" Type="System.Type" /> <Parameter Name="value" Type="System.Object" RefType="out" /> </Parameters> <Docs> <param name="key">The key for the property in the message's property bag.</param> <param name="value">The value of the property.</param> <summary> Attempts to get a property from the property bag for this <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. Message properties are used to govern the behavior of specific policies in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. Please refer to documentation for a specific <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to understand what properties it supports. </summary> <returns> <c>true</c> if property exists; otherwise <c>false</c>.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>