DocumentResponse<TDocument> Classe

Référence

Définition

Espace de noms:: Microsoft.Azure.Documents.Client

Assemblys:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Paquets:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Représente la classe de modèle utilisée par les méthodes retournant des objets uniques dans le service Azure Cosmos DB.

public sealed class DocumentResponse<TDocument> : Microsoft.Azure.Documents.Client.ResourceResponseBase, Microsoft.Azure.Documents.Client.IDocumentResponse<TDocument>

type DocumentResponse<'Document> = class
    inherit ResourceResponseBase
    interface IDocumentResponse<'Document>
    interface IResourceResponseBase

Public NotInheritable Class DocumentResponse(Of TDocument)
Inherits ResourceResponseBase
Implements IDocumentResponse(Of TDocument)

Paramètres de type

TDocument

type de document.

Héritage: Object

ResourceResponseBase
DocumentResponse<TDocument>

Implémente: IDocumentResponse<TDocument> IResourceResponseBase

Exemples

L’exemple suivant extrait la propriété CustomerName, les unités de requête consommées, l’ID d’activité et StatusCode d’un appel ReadDocumentAsync{Customer}.

DocumentResponse<Customer> response = await client.ReadDocumentAsync<Customer>(documentLink);
Console.WriteLine(response.Document.CustomerName);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId); 
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201

Remarques

La réponse de la lecture spécifique au type de la ressource Document(ReadDocumentAsync{TDocument}) retourne la réponse encapsulée dans un objet DocumentResponse. Il contient les métadonnées des en-têtes de réponse de l’appel Azure Cosmos DB, y compris les unités de requête (RequestCharge), l’ID d’activité, les quotas/utilisation des ressources et l’objet de document typé (TDocument).

Constructeurs

DocumentResponse<TDocument>()	Constructeur exposé à des fins de simulation pour le service Azure Cosmos DB.
DocumentResponse<TDocument>(TDocument)	Constructeur exposé à des fins de simulation pour le service Azure Cosmos DB.

Propriétés

ActivityId	Obtient l’ID d’activité de la demande à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
CollectionQuota	Obtient le quota maximal pour les ressources de collection au sein d’un compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
CollectionSizeQuota	Obtient la taille maximale d’une collection en kilo-octets à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
CollectionSizeUsage	Obtient la taille actuelle d’une collection en kilo-octets à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
CollectionUsage	Obtient le nombre actuel de ressources de collection dans le compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
ContentLocation	L’emplacement parent du contenu, par exemple, dbs/foo/colls/bar dans le service Azure Cosmos DB. (Hérité de ResourceResponseBase)
CurrentResourceQuotaUsage	Obtient la taille actuelle de cette entité à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
DatabaseQuota	Obtient le quota maximal pour les ressources de base de données au sein du compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
DatabaseUsage	Obtient le nombre actuel de ressources de base de données dans le compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
Document	Obtient le document retourné dans la réponse du service Azure Cosmos DB.
DocumentQuota	Obtient la taille maximale d’un document au sein d’une collection en kilo-octets à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
DocumentUsage	Obtient la taille actuelle des documents au sein d’une collection en kilo-octets à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
IndexTransformationProgress	Obtient la progression d’une transformation d’index, si elle est en cours à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
IsRUPerMinuteUsed	Obtient l’indicateur associé à la réponse du service Azure Cosmos DB, que cette requête soit traitée à partir d’unités de requête(RU)/capacité de minute ou non. (Hérité de ResourceResponseBase)
LazyIndexingProgress	Obtient la progression de l’indexation différée à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
MaxResourceQuota	Obtient la limite de taille maximale pour cette entité à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
PermissionQuota	Obtient le quota maximal pour les ressources d’autorisation au sein d’un compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
PermissionUsage	Obtient le nombre actuel de ressources d’autorisation dans le compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
RequestCharge	Obtient les frais de demande pour cette demande à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
RequestDiagnosticsString	Obtient les informations diagnostics pour la requête actuelle au service Azure Cosmos DB. (Hérité de ResourceResponseBase)
RequestLatency	Obtient la latence de la requête de bout en bout pour la requête actuelle au service Azure Cosmos DB. (Hérité de ResourceResponseBase)
ResponseHeaders	Obtient les en-têtes de réponse du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
ResponseStream	Obtient le flux sous-jacent de la réponse à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
SessionToken	Obtient le jeton de session à utiliser dans les lectures de cohérence de sesssion à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
StatusCode	Obtient le code status HTTP associé à la réponse du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
StoredProceduresQuota	Obtient le quota maximal de procédures stockées pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
StoredProceduresUsage	Obtient le nombre actuel de procédures stockées pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
TriggersQuota	Obtient le quota maximal de déclencheurs pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
TriggersUsage	Obtient le nombre actuel de déclencheurs pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
UserDefinedFunctionsQuota	Obtient le quota maximal de fonctions définies par l’utilisateur pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
UserDefinedFunctionsUsage	Obtient le nombre actuel de fonctions définies par l’utilisateur pour une collection à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
UserQuota	Obtient le quota maximal pour les ressources utilisateur au sein d’un compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)
UserUsage	Obtient le nombre actuel de ressources utilisateur dans le compte à partir du service Azure Cosmos DB. (Hérité de ResourceResponseBase)

Opérateurs

Implicit(DocumentResponse<TDocument> to TDocument)

Retourne implicitement le document dans la réponse à partir du service Azure Cosmos DB.

S’applique à

Partager via