CosmosResponse<T> Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.63.4
  • java.lang.Object
    • com.azure.cosmos.models.CosmosResponse<T>

Type Parameters

T

the type of resource

public class CosmosResponse

The cosmos response

Method Summary

Modifier and Type Method and Description
String getActivityId()

Gets the Activity ID for the request.
String getCurrentResourceQuotaUsage()

Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)
CosmosDiagnostics getDiagnostics()

Gets the diagnostics information for the current request to Azure Cosmos DB service.
Duration getDuration()

Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
String getMaxResourceQuota()

Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
T getProperties()

Gets properties.
double getRequestCharge()

Gets the request charge as request units (RU) consumed by the operation.
Map<String,String> getResponseHeaders()

Gets the headers associated with the response.
String getSessionToken()

Gets the token used for managing client's consistency requirements.
int getStatusCode()

Gets the HTTP status code associated with the response.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getActivityId

public String getActivityId()

Gets the Activity ID for the request.

Returns:

the activity getId.

getCurrentResourceQuotaUsage

public String getCurrentResourceQuotaUsage()

Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)

Returns:

the current resource quota usage.

getDiagnostics

public CosmosDiagnostics getDiagnostics()

Gets the diagnostics information for the current request to Azure Cosmos DB service.

Returns:

diagnostics information for the current request to Azure Cosmos DB service.

getDuration

public Duration getDuration()

Gets the end-to-end request latency for the current request to Azure Cosmos DB service.

Returns:

end-to-end request latency for the current request to Azure Cosmos DB service.

getMaxResourceQuota

public String getMaxResourceQuota()

Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).

For CosmosContainer, users will need to set setQuotaInfoEnabled(boolean quotaInfoEnabled) to true to get the quota information.

Returns:

the max resource quota.

getProperties

public T getProperties()

Gets properties.

Returns:

the properties

getRequestCharge

public double getRequestCharge()

Gets the request charge as request units (RU) consumed by the operation.

For more information about the RU and factors that can impact the effective charges please visit Request Units in Azure Cosmos DB

Returns:

the request charge.

getResponseHeaders

public Map getResponseHeaders()

Gets the headers associated with the response.

Returns:

the response headers.

getSessionToken

public String getSessionToken()

Gets the token used for managing client's consistency requirements.

Returns:

the session token.

getStatusCode

public int getStatusCode()

Gets the HTTP status code associated with the response.

Returns:

the status code.

Applies to