ResourceResponse<T> Class

Package:

com.microsoft.azure.documentdb

Maven Artifact:

com.microsoft.azure:azure-documentdb:2.4.7

• java.lang.Object
• • com.microsoft.azure.documentdb.ResourceResponse<T>

Type Parameters

T

the resource type of the resource response.

public final class ResourceResponse

Represents the service response to a request made from DocumentClient in the Azure Cosmos DB database service. Contains both the resource and the response headers.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
java.lang.String	getActivityId() Gets the Activity ID for the request.
ClientSideRequestStatistics	getClientSideRequestStatistics() Gets the request statistics for the current request to Azure Cosmos DB service.
long	getCollectionQuota() Max Quota.
long	getCollectionSizeQuota() Max Quota.
long	getCollectionSizeUsage() Current Usage.
long	getCollectionUsage() Current Usage.
java.lang.String	getCurrentResourceQuotaUsage() Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)
long	getDatabaseQuota() Max Quota.
long	getDatabaseUsage() Current Usage.
long	getDocumentCountQuota() Max document count quota.
long	getDocumentCountUsage() Current document count usage.
long	getDocumentQuota() Max Quota.
long	getDocumentUsage() Current Usage.
long	getIndexTransformationProgress() Gets the progress of an index transformation, if one is underway.
long	getLazyIndexingProgress() Gets the progress of lazy indexing.
java.lang.String	getMaxResourceQuota() Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
long	getPermissionQuota() Max Quota.
long	getPermissionUsage() Current Usage.
boolean	getRUPerMinuteUsed() Gets the flag associated with the response from the Azure Cosmos DB database service whether this request is served from Request Units(RUs)/minute capacity or not.
double	getRequestCharge() Gets the number of index paths (terms) generated by the operation.
java.lang.String	getRequestDiagnosticsString() Gets the diagnostics information for the current request to Azure Cosmos DB service.
org.joda.time.Period	getRequestLatency() Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
T	getResource() Gets the resource for the request.
java.util.Map<java.lang.String,java.lang.String>	getResponseHeaders() Gets the headers associated with the response.
java.lang.String	getSessionToken() Gets the token used for managing client's consistency requirements.
int	getStatusCode() Gets the HTTP status code associated with the response.
long	getStoredProceduresQuota() Max Quota.
long	getStoredProceduresUsage() Current Usage.
long	getTriggersQuota() Max Quota.
long	getTriggersUsage() Current Usage.
long	getUserDefinedFunctionsQuota() Max Quota.
long	getUserDefinedFunctionsUsage() Current Usage.
long	getUserQuota() Max Quota.
long	getUserUsage() Current Usage.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

close

public void close()

Deprecated.

getActivityId

public String getActivityId()

Gets the Activity ID for the request.

Returns:

the activity id.

getClientSideRequestStatistics

public ClientSideRequestStatistics getClientSideRequestStatistics()

Gets the request statistics for the current request to Azure Cosmos DB service.

Returns:

request statistics for the current request to Azure Cosmos DB service.

getCollectionQuota

public long getCollectionQuota()

Max Quota.

Returns:

the collection quota.

getCollectionSizeQuota

public long getCollectionSizeQuota()

Max Quota.

Returns:

the collection size quota.

getCollectionSizeUsage

public long getCollectionSizeUsage()

Current Usage.

Returns:

the collection size usage.

getCollectionUsage

public long getCollectionUsage()

Current Usage.

Returns:

the current collection usage.

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.

getDatabaseQuota

public long getDatabaseQuota()

Max Quota.

Returns:

the database quota.

getDatabaseUsage

public long getDatabaseUsage()

Current Usage.

Returns:

the current database usage.

getDocumentCountQuota

public long getDocumentCountQuota()

Max document count quota.

Returns:

the document count quota.

getDocumentCountUsage

public long getDocumentCountUsage()

Current document count usage.

Returns:

the document count usage.

getDocumentQuota

public long getDocumentQuota()

Max Quota.

Returns:

the document quota.

getDocumentUsage

public long getDocumentUsage()

Current Usage.

Returns:

the document usage.

getIndexTransformationProgress

public long getIndexTransformationProgress()

Gets the progress of an index transformation, if one is underway.

Returns:

the progress of an index transformation.

getLazyIndexingProgress

public long getLazyIndexingProgress()

Gets the progress of lazy indexing.

Returns:

the progress of lazy indexing.

getMaxResourceQuota

public String getMaxResourceQuota()

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

Returns:

the max resource quota.

getPermissionQuota

public long getPermissionQuota()

Max Quota.

Returns:

the permission quota.

getPermissionUsage

public long getPermissionUsage()

Current Usage.

Returns:

the current permission usage.

getRUPerMinuteUsed

public boolean getRUPerMinuteUsed()

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

Returns:

True if this request is served from RUs/minute capacity. Otherwise, false.

getRequestCharge

public double getRequestCharge()

Gets the number of index paths (terms) generated by the operation.

Returns:

the request charge.

getRequestDiagnosticsString

public String getRequestDiagnosticsString()

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.

getRequestLatency

public Period getRequestLatency()

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.

getResource

public T getResource()

Gets the resource for the request.

Returns:

the resource.

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.

getStoredProceduresQuota

public long getStoredProceduresQuota()

Max Quota.

Returns:

the stored procedures quota.

getStoredProceduresUsage

public long getStoredProceduresUsage()

Current Usage.

Returns:

the current stored procedures usage.

getTriggersQuota

public long getTriggersQuota()

Max Quota.

Returns:

the triggers quota.

getTriggersUsage

public long getTriggersUsage()

Current Usage.

Returns:

the current triggers usage.

getUserDefinedFunctionsQuota

public long getUserDefinedFunctionsQuota()

Max Quota.

Returns:

the user defined functions quota.

getUserDefinedFunctionsUsage

public long getUserDefinedFunctionsUsage()

Current Usage.

Returns:

the current user defined functions usage.

getUserQuota

public long getUserQuota()

Max Quota.

Returns:

the user quota.

getUserUsage

public long getUserUsage()

Current Usage.

Returns:

the current user usage.