xml/Microsoft.Azure.Cosmos/Headers.xml (557 lines of code) (raw):
<Type Name="Headers" FullName="Microsoft.Azure.Cosmos.Headers">
<TypeSignature Language="C#" Value="public class Headers : System.Collections.IEnumerable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Headers extends System.Object implements class System.Collections.IEnumerable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Headers" />
<TypeSignature Language="VB.NET" Value="Public Class Headers
Implements IEnumerable" />
<TypeSignature Language="F#" Value="type Headers = class
 interface IEnumerable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
<AssemblyVersion>3.45.0.0</AssemblyVersion>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Header implementation used for Request and Responses
</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.Cosmos.RequestMessage" />
<altmember cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Headers ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new instance of <see cref="T:Microsoft.Azure.Cosmos.Headers" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityId">
<MemberSignature Language="C#" Value="public virtual string ActivityId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ActivityId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.ActivityId" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ActivityId As String" />
<MemberSignature Language="F#" Value="member this.ActivityId : string" Usage="Microsoft.Azure.Cosmos.Headers.ActivityId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the activity ID for the request from the Azure Cosmos DB service.
</summary>
<value>
The activity ID for the request.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public virtual void Add (string headerName, System.Collections.Generic.IEnumerable<string> values);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(string headerName, class System.Collections.Generic.IEnumerable`1<string> values) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.Add(System.String,System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Add (headerName As String, values As IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="abstract member Add : string * seq<string> -> unit
override this.Add : string * seq<string> -> unit" Usage="headers.Add (headerName, values)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
<Parameter Name="values" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<param name="values">List of values to be added as a comma-separated list.</param>
<summary>
Adds a header to the Header collection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public virtual void Add (string headerName, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(string headerName, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.Add(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Add (headerName As String, value As String)" />
<MemberSignature Language="F#" Value="abstract member Add : string * string -> unit
override this.Add : string * string -> unit" Usage="headers.Add (headerName, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<param name="value">Header value.</param>
<summary>
Adds a header to the Header collection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllKeys">
<MemberSignature Language="C#" Value="public virtual string[] AllKeys ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string[] AllKeys() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.AllKeys" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AllKeys () As String()" />
<MemberSignature Language="F#" Value="abstract member AllKeys : unit -> string[]
override this.AllKeys : unit -> string[]" Usage="headers.AllKeys " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Obtains a list of all header names.
</summary>
<returns>An array with all the header names.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentLength">
<MemberSignature Language="C#" Value="public virtual string ContentLength { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentLength" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.ContentLength" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property ContentLength As String" />
<MemberSignature Language="F#" Value="member this.ContentLength : string with get, set" Usage="Microsoft.Azure.Cosmos.Headers.ContentLength" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Content Length for the current content in the <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public virtual string ContentType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ContentType As String" />
<MemberSignature Language="F#" Value="member this.ContentType : string" Usage="Microsoft.Azure.Cosmos.Headers.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Content Type for the current content in the <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContinuationToken">
<MemberSignature Language="C#" Value="public virtual string ContinuationToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContinuationToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.ContinuationToken" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ContinuationToken As String" />
<MemberSignature Language="F#" Value="member this.ContinuationToken : string" Usage="Microsoft.Azure.Cosmos.Headers.ContinuationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Continuation Token in the current <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public virtual string ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.ETag" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ETag As String" />
<MemberSignature Language="F#" Value="member this.ETag : string" Usage="Microsoft.Azure.Cosmos.Headers.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity tag associated with the resource from the Azure Cosmos DB service.
</summary>
<value>
The entity tag associated with the resource.
</value>
<remarks>
ETags are used for concurrency checking when updating resources.
</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual string Get (string headerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string Get(string headerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.Get(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Get (headerName As String) As String" />
<MemberSignature Language="F#" Value="abstract member Get : string -> string
override this.Get : string -> string" Usage="headers.Get headerName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<summary>
Gets the value of a particular header.
</summary>
<returns>The header value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
<MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IEnumerator<string> GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerator`1<string> GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Public Iterator Overridable Function GetEnumerator () As IEnumerator(Of String)" />
<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -> System.Collections.Generic.IEnumerator<string>
override this.GetEnumerator : unit -> System.Collections.Generic.IEnumerator<string>" Usage="headers.GetEnumerator " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Microsoft.Azure.Cosmos.Headers+<GetEnumerator>d__105))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IteratorStateMachine(typeof(Microsoft.Azure.Cosmos.Headers+<GetEnumerator>d__105))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerator<System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Enumerates all the HTTP headers names in the <see cref="T:Microsoft.Azure.Cosmos.Headers" />.
</summary>
<returns>An enumerator for all headers.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHeaderValue<T>">
<MemberSignature Language="C#" Value="public virtual T GetHeaderValue<T> (string headerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!T GetHeaderValue<T>(string headerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.GetHeaderValue``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetHeaderValue(Of T) (headerName As String) As T" />
<MemberSignature Language="F#" Value="abstract member GetHeaderValue : string -> 'T
override this.GetHeaderValue : string -> 'T" Usage="headers.GetHeaderValue headerName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">Type of the header value.</typeparam>
<param name="headerName">Header name.</param>
<summary>
Gets a header value with a particular type.
</summary>
<returns>The header value parsed for a particular type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetValueOrDefault">
<MemberSignature Language="C#" Value="public virtual string GetValueOrDefault (string headerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetValueOrDefault(string headerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.GetValueOrDefault(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetValueOrDefault (headerName As String) As String" />
<MemberSignature Language="F#" Value="abstract member GetValueOrDefault : string -> string
override this.GetValueOrDefault : string -> string" Usage="headers.GetValueOrDefault headerName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header Name</param>
<summary>
Returns the header value or the default(string)
</summary>
<returns>Returns the header value or the default(string).</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public virtual string this[string headerName] { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Item(string)" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.Item(System.String)" />
<MemberSignature Language="VB.NET" Value="Default Public Overridable Property Item(headerName As String) As String" />
<MemberSignature Language="F#" Value="member this.Item(string) : string with get, set" Usage="Microsoft.Azure.Cosmos.Headers.Item" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header name to look for.</param>
<summary>
Gets the value of a particular header.
</summary>
<value>The header value.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Location">
<MemberSignature Language="C#" Value="public virtual string Location { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Location" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.Location" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Location As String" />
<MemberSignature Language="F#" Value="member this.Location : string" Usage="Microsoft.Azure.Cosmos.Headers.Location" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Location for the current content in the <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public virtual void Remove (string headerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(string headerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.Remove(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Remove (headerName As String)" />
<MemberSignature Language="F#" Value="abstract member Remove : string -> unit
override this.Remove : string -> unit" Usage="headers.Remove headerName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<summary>
Removes a header from the header collection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestCharge">
<MemberSignature Language="C#" Value="public virtual double RequestCharge { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 RequestCharge" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.RequestCharge" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property RequestCharge As Double" />
<MemberSignature Language="F#" Value="member this.RequestCharge : double" Usage="Microsoft.Azure.Cosmos.Headers.RequestCharge" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the request charge for this request from the Azure Cosmos DB service.
</summary>
<value>
The request charge measured in request units.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Session">
<MemberSignature Language="C#" Value="public virtual string Session { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Session" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Headers.Session" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Session As String" />
<MemberSignature Language="F#" Value="member this.Session : string" Usage="Microsoft.Azure.Cosmos.Headers.Session" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Session Token for the current <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" />.
</summary>
<value>To be added.</value>
<remarks>
Session Token is used along with Session Consistency.
</remarks>
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public virtual void Set (string headerName, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Set(string headerName, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.Set(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Set (headerName As String, value As String)" />
<MemberSignature Language="F#" Value="abstract member Set : string * string -> unit
override this.Set : string * string -> unit" Usage="headers.Set (headerName, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<param name="value">Header value.</param>
<summary>
Adds or updates a header in the Header collection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
<MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.System#Collections#IEnumerable#GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator" />
<MemberSignature Language="F#" Value="abstract member System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator
override this.System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator" Usage="headers.System.Collections.IEnumerable.GetEnumerator " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Enumerates all the HTTP headers names in the <see cref="T:Microsoft.Azure.Cosmos.Headers" />.
</summary>
<returns>An enumerator for all headers.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetValue">
<MemberSignature Language="C#" Value="public virtual bool TryGetValue (string headerName, out string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryGetValue(string headerName, [out] string& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Headers.TryGetValue(System.String,System.String@)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function TryGetValue (headerName As String, ByRef value As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGetValue : string * string -> bool
override this.TryGetValue : string * string -> bool" Usage="headers.TryGetValue (headerName, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.47.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="headerName" Type="System.String" />
<Parameter Name="value" Type="System.String" RefType="out" />
</Parameters>
<Docs>
<param name="headerName">Header name.</param>
<param name="value">Header value.</param>
<summary>
Tries to get the value for a particular header.
</summary>
<returns>True or false if the header name existed in the header collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>