com.azure.cosmos

Class TransactionalBatchResponse

java.lang.Object

com.azure.cosmos.TransactionalBatchResponse

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public class TransactionalBatchResponse
extends Object

Response of a TransactionalBatch request.

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Gets the activity ID that identifies the server request made to execute the batch.
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	getErrorMessage() Gets the reason for the failure of the batch request, if any, or null.
double	getRequestCharge() Gets the request charge as request units (RU) consumed by the batch operation.
Map<String,String>	getResponseHeaders() Gets the headers associated with the response.
int	getResponseLength() Get the length of the response of a batch operation change it in the down path.
List<TransactionalBatchOperationResult>	getResults() Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path.
Duration	getRetryAfterDuration() Gets the amount of time to wait before retrying this or any other request due to throttling.
String	getSessionToken() Gets the token used for managing client's consistency requirements.
int	getStatusCode() Gets the HTTP status code associated with the response.
int	getSubStatusCode() Gets the HTTP sub status code associated with the response.
boolean	isSuccessStatusCode() Returns a value indicating whether the batch was successfully processed.
int	size() Gets the number of operation results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDiagnostics

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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.

size

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int size()

Gets the number of operation results.

Returns:

the number of operations results in this response.

isSuccessStatusCode

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public boolean isSuccessStatusCode()

Returns a value indicating whether the batch was successfully processed.

Returns:

a value indicating whether the batch was successfully processed.

getActivityId

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getActivityId()

Gets the activity ID that identifies the server request made to execute the batch.

Returns:

the activity ID that identifies the server request made to execute the batch.

getErrorMessage

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getErrorMessage()

Gets the reason for the failure of the batch request, if any, or null.

Returns:

the reason for the failure of the batch request, if any, or null.

getRequestCharge

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public double getRequestCharge()

Gets the request charge as request units (RU) consumed by the batch 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.

getStatusCode

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getStatusCode()

Gets the HTTP status code associated with the response.

Returns:

the status code.

getSessionToken

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getSessionToken()

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

Returns:

the session token.

getResponseHeaders

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Map<String,String> getResponseHeaders()

Gets the headers associated with the response.

Returns:

the response headers.

getRetryAfterDuration

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Duration getRetryAfterDuration()

Gets the amount of time to wait before retrying this or any other request due to throttling.

Returns:

the amount of time to wait before retrying this or any other request due to throttling.

getSubStatusCode

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getSubStatusCode()

Gets the HTTP sub status code associated with the response.

Returns:

the sub status code.

getResults

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public List<TransactionalBatchOperationResult> getResults()

Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path.

Returns:

Results of operations in a batch.

getResponseLength

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public int getResponseLength()

Get the length of the response of a batch operation change it in the down path.

Returns:

length of the response.

getDuration

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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.