com.azure.cosmos

Class CosmosBulkItemResponse

java.lang.Object

com.azure.cosmos.CosmosBulkItemResponse

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

Response of a CosmosItemOperation request when processed using Bulk by calling CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions).

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Gets the activity ID that identifies the server request made to execute this operation.
CosmosDiagnostics	getCosmosDiagnostics() Gets the cosmos diagnostic for this operation.
Duration	getDuration() Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
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.
double	getRequestCharge() Gets the request charge as request units (RU) consumed by the current operation.
Map<String,String>	getResponseHeaders() Gets the headers associated with the response.
Duration	getRetryAfterDuration() Gets retry after.
String	getSessionToken() Gets the token used for managing client's consistency requirements.
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

getActivityId

@Beta(value=V4_9_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 this operation.

Returns:

the activity ID that identifies the server request made to execute this operation.

getETag

@Beta(value=V4_9_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_9_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_9_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_9_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_9_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_9_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_9_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.

getCosmosDiagnostics

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosDiagnostics getCosmosDiagnostics()

Gets the cosmos diagnostic for this operation.

Returns:

the CosmosDiagnosticsCosmosDiagnostics

getSessionToken

@Beta(value=V4_9_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_9_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.

getDuration

@Beta(value=V4_9_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.