com.azure.cosmos

Class TransactionalBatchOperationResult

java.lang.Object

com.azure.cosmos.TransactionalBatchOperationResult

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

Represents a result for a specific operation that was part of a TransactionalBatch request.

Method Summary

Modifier and Type	Method and Description
String	getETag() Gets the entity tag associated with the current item.
<T> T	getItem(Class<T> type) Gets the item associated with the current result.
CosmosItemOperation	getOperation() Gets the original operation for this result.
double	getRequestCharge() Gets the request charge as request units (RU) consumed by the current operation.
Duration	getRetryAfterDuration() Gets retry after.
int	getStatusCode() Gets the HTTP status code associated with the current result.
int	getSubStatusCode() Gets sub status code associated with the current result.
boolean	isSuccessStatusCode() Gets a value indicating whether the current operation completed successfully.

Methods inherited from class java.lang.Object

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

Method Detail

getETag

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

Gets the entity tag associated with the current item. ETags are used for concurrency checking when updating resources.

Returns:

Entity tag associated with the current item.

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 current 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.

getItem

@Beta(value=V4_7_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public <T> T getItem(Class<T> type)

Gets the item associated with the current result.

Type Parameters:

T - the type parameter

Parameters:

type - class type for which deserialization is needed.

Returns:

item associated with the current result.

getRetryAfterDuration

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

Gets retry after.

Returns:

the retry after

getSubStatusCode

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

Gets sub status code associated with the current result.

Returns:

the sub status code

isSuccessStatusCode

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

Gets a value indicating whether the current operation completed successfully.

Returns:

true if the current operation completed successfully; false otherwise.

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 current result.

Returns:

the status code.

getOperation

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

Gets the original operation for this result.

Returns:

the CosmosItemOperation.