ResourceResponse Class

 

Updated: June 30, 2017

Represents the template class used by methods returning single objects in the Azure DocumentDB database service.

Namespace:   Microsoft.Azure.Documents.Client
Assembly:  Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

SystemObject
  Microsoft.Azure.Documents.ClientResourceResponseBase
    Microsoft.Azure.Documents.ClientResourceResponse

C#
C++
VB
F#
Copy
No code example is currently available or this language may not be supported.

Type Parameters

TResource

the resource type.

NameDescription
System_CAPS_pubmethodResourceResponse

Constructor exposed for mocking purposes for the Azure DocumentDB database service.

System_CAPS_pubmethodResourceResponse

Constructor exposed for mocking purposes for the Azure DocumentDB database service.

NameDescription
System_CAPS_pubproperty

Gets the activity ID for the request from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota for collection resources within an account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum size of a collection in kilobytes from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current size of a collection in kilobytes from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of collection resources within the account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

The content parent location, for example, dbs/foo/colls/bar in the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current size of this entity from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota for database resources within the account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of database resources within the account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum size of a documents within a collection in kilobytes from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current size of documents within a collection in kilobytes from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the progress of an index transformation, if one is underway from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the flag associated with the response from the Azure DocumentDB database service whether this request is served from Request Units(RUs)/minute capacity or not. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the progress of lazy indexing from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum size limit for this entity from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota for permission resources within an account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of permission resources within the account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the request charge for this request from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the resource returned in the response from the Azure DocumentDB database service.

System_CAPS_pubproperty

Gets the response headers from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the underlying stream of the response from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the session token for use in sesssion consistency reads from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the HTTP status code associated with the response from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota of stored procedures for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of stored procedures for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota of triggers for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of triggers for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota of user defined functions for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of user defined functions for a collection from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the maximum quota for user resources within an account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

System_CAPS_pubproperty

Gets the current number of user resources within the account from the Azure DocumentDB database service. (Inherited from ResourceResponseBase.)

NameDescription
System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_protmethodFinalize

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone

(Inherited from Object.)

System_CAPS_pubmethodToString

(Inherited from Object.)

NameDescription
System_CAPS_puboperatorSystem_CAPS_static

Returns the resource in the response implicitly from the Azure DocumentDB database service.

NameDescription
System_CAPS_pubmethodIsDefined

Determines if a certain property is defined or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsNull

Determines if a certain property is null or not. (Defined by TypeCheckFunctionsExtensions.)

System_CAPS_pubmethodIsPrimitive

Determines if a certain property is of premitive JSON type. (Defined by TypeCheckFunctionsExtensions.)

All responses from creates, reads, updates and deletes of Azure DocumentDB resources return the response wrapped in a ResourceResponse object. This contains the metadata from the response headers from the Azure DocumentDB call including the request units (RequestCharge), activity ID and quotas/usage of resources.

The following example extracts the request units consumed, activity ID and StatusCode from a CreateDocumentAsync call.

C#
Copy 

ResourceResponse<Document> response = await client.CreateDocumentAsync(collectionLink, document);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId); 
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: