CosmosStoredProcedureResponse Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.63.4

• java.lang.Object
• • com.azure.cosmos.models.CosmosResponse<T>
  • • com.azure.cosmos.models.CosmosStoredProcedureResponse

public class CosmosStoredProcedureResponse
extends CosmosResponse<CosmosStoredProcedureProperties>

The type Cosmos stored procedure response.

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Gets the Activity ID for the request.
CosmosStoredProcedureProperties	getProperties() Gets the stored procedure properties
double	getRequestCharge() Gets the number of normalized requests charged.
String	getResponseAsString() Gets the response of the stored procedure as a string.
String	getScriptLog() Gets the output from stored procedure console.log() statements.
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 CosmosResponse

getActivityId getCurrentResourceQuotaUsage getDiagnostics getDuration getMaxResourceQuota getProperties getRequestCharge getResponseHeaders getSessionToken getStatusCode

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.

Overrides:

CosmosStoredProcedureResponse.getActivityId()

Returns:

the activity id.

getProperties

public CosmosStoredProcedureProperties getProperties()

Gets the stored procedure properties

Overrides:

CosmosStoredProcedureResponse.getProperties()

Returns:

the stored procedure properties or null

getRequestCharge

public double getRequestCharge()

Gets the number of normalized requests charged.

Overrides:

CosmosStoredProcedureResponse.getRequestCharge()

Returns:

the request charge.

getResponseAsString

public String getResponseAsString()

Gets the response of the stored procedure as a string.

Returns:

the response as a string.

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 used for managing client's consistency requirements.

Overrides:

CosmosStoredProcedureResponse.getSessionToken()

Returns:

the session token.

getStatusCode

public int getStatusCode()

Gets the HTTP status code associated with the response.

Overrides:

CosmosStoredProcedureResponse.getStatusCode()

Returns:

the status code.