DocumentResponse<TDocument> Classe

Referência

Definição

Namespace:: Microsoft.Azure.Documents.Client

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

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Representa a classe de modelo usada por métodos que retornam objetos únicos no serviço do 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)

Parâmetros de tipo

TDocument

o tipo de documento.

Herança: Object

ResourceResponseBase
DocumentResponse<TDocument>

Implementações: IDocumentResponse<TDocument> IResourceResponseBase

Exemplos

O exemplo a seguir extrai a propriedade CustomerName, as unidades de solicitação consumidas, a ID da atividade e o StatusCode de uma chamada 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

Comentários

A resposta da leitura específica do tipo do recurso Document (ReadDocumentAsync{TDocument}) retorna a resposta encapsulada em um objeto DocumentResponse. Isso contém os metadados dos cabeçalhos de resposta da chamada do Azure Cosmos DB, incluindo as unidades de solicitação (RequestCharge), a ID da atividade, as cotas/o uso de recursos e o objeto de documento tipado (TDocument).

Construtores

DocumentResponse<TDocument>()	Construtor exposto para fins de simulação para o serviço do Azure Cosmos DB.
DocumentResponse<TDocument>(TDocument)	Construtor exposto para fins de simulação para o serviço do Azure Cosmos DB.

Propriedades

ActivityId	Obtém a ID da atividade para a solicitação do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
CollectionQuota	Obtém a cota máxima para recursos de coleta em uma conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
CollectionSizeQuota	Obtém o tamanho máximo de uma coleção em quilobytes do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
CollectionSizeUsage	Obtém o tamanho atual de uma coleção em quilobytes do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
CollectionUsage	Obtém o número atual de recursos de coleção na conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
ContentLocation	O local pai do conteúdo, por exemplo, dbs/foo/colls/bar no serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
CurrentResourceQuotaUsage	Obtém o tamanho atual dessa entidade do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
DatabaseQuota	Obtém a cota máxima para recursos de banco de dados na conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
DatabaseUsage	Obtém o número atual de recursos de banco de dados na conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
Document	Obtém o documento retornado na resposta do serviço do Azure Cosmos DB.
DocumentQuota	Obtém o tamanho máximo de um documento dentro de uma coleção em quilobytes do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
DocumentUsage	Obtém o tamanho atual dos documentos dentro de uma coleção em quilobytes do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
IndexTransformationProgress	Obtém o progresso de uma transformação de índice, se uma estiver em andamento no serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
IsRUPerMinuteUsed	Obtém o sinalizador associado à resposta do serviço do Azure Cosmos DB se essa solicitação é atendida da capacidade de RUs (Unidades de Solicitação)/minuto ou não. (Herdado de ResourceResponseBase)
LazyIndexingProgress	Obtém o progresso da indexação lenta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
MaxResourceQuota	Obtém o limite de tamanho máximo para essa entidade do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
PermissionQuota	Obtém a cota máxima para recursos de permissão em uma conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
PermissionUsage	Obtém o número atual de recursos de permissão dentro da conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
RequestCharge	Obtém o encargo de solicitação para essa solicitação do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
RequestDiagnosticsString	Obtém as informações de diagnóstico da solicitação atual para o serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
RequestLatency	Obtém a latência de solicitação de ponta a ponta para a solicitação atual para o serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
ResponseHeaders	Obtém os cabeçalhos de resposta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
ResponseStream	Obtém o fluxo subjacente da resposta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
SessionToken	Obtém o token de sessão para uso em leituras de consistência de sessão do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
StatusCode	Obtém o código de status HTTP associado à resposta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
StoredProceduresQuota	Obtém a cota máxima de procedimentos armazenados para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
StoredProceduresUsage	Obtém o número atual de procedimentos armazenados para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
TriggersQuota	Obtém a cota máxima de gatilhos para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
TriggersUsage	Obtém o número atual de gatilhos para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
UserDefinedFunctionsQuota	Obtém a cota máxima de funções definidas pelo usuário para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
UserDefinedFunctionsUsage	Obtém o número atual de funções definidas pelo usuário para uma coleção do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
UserQuota	Obtém a cota máxima para recursos de usuário em uma conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)
UserUsage	Obtém o número atual de recursos de usuário na conta do serviço do Azure Cosmos DB. (Herdado de ResourceResponseBase)

Operadores

Implicit(DocumentResponse<TDocument> to TDocument)

Retorna o documento na resposta implicitamente do serviço do Azure Cosmos DB.

Aplica-se a

Compartilhar via