StoredProcedureResponse Class

Package:

com.microsoft.azure.documentdb

Maven Artifact:

com.microsoft.azure:azure-documentdb:2.4.7

• java.lang.Object
• • com.microsoft.azure.documentdb.StoredProcedureResponse

public final class StoredProcedureResponse

Represents the response returned from a stored procedure in the Azure Cosmos DB database service. Wraps the response body and headers.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActivityId() Gets the Activity ID of the request.
ClientSideRequestStatistics	getClientSideRequestStatistics() Gets the client side request statistics for execution of stored procedure.
java.lang.String	getCurrentResourceQuotaUsage() Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)
java.lang.String	getMaxResourceQuota() Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
double	getRequestCharge() Gets the number of normalized requests charged.
Attachment	getResponseAsAttachment() Gets the response of a stored procedure, serialized into an attachment.
Document	getResponseAsDocument() Gets the response of a stored procedure, serialized into a document.
java.lang.String	getResponseAsString() Gets the response of a stored procedure as a string.
java.util.Map<java.lang.String,java.lang.String>	getResponseHeaders() Gets the headers associated with the response.
java.lang.String	getScriptLog() Gets the output from stored procedure console.log() statements.
java.lang.String	getSessionToken() Gets the token for use with session consistency requests.
int	getStatusCode() Gets the request completion status code.

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

getActivityId

public String getActivityId()

Gets the Activity ID of the request.

Returns:

the activity id.

getClientSideRequestStatistics

public ClientSideRequestStatistics getClientSideRequestStatistics()

Gets the client side request statistics for execution of stored procedure.

Returns:

The client side request statics for execution of stored procedure.

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.

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.

getRequestCharge

public double getRequestCharge()

Gets the number of normalized requests charged.

Returns:

the request charge.

getResponseAsAttachment

public Attachment getResponseAsAttachment()

Gets the response of a stored procedure, serialized into an attachment.

Returns:

the response as an attachment.

getResponseAsDocument

public Document getResponseAsDocument()

Gets the response of a stored procedure, serialized into a document.

Returns:

the response as a document.

getResponseAsString

public String getResponseAsString()

Gets the response of a stored procedure as a string.

Returns:

the response as a string.

getResponseHeaders

public Map getResponseHeaders()

Gets the headers associated with the response.

Returns:

the response headers.

getScriptLog

public String getScriptLog()

Gets the output from stored procedure console.log() statements.

Returns:

the output string from the stored procedure console.log() statements.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency requests.

Returns:

the session token.

getStatusCode

public int getStatusCode()

Gets the request completion status code.

Returns:

the status code.