CosmosBulkItemResponse Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.58.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosBulkItemResponse

public final class CosmosBulkItemResponse

Response of a CosmosItemOperation request when processed using Bulk by calling executeBulkOperations(Flux<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions).

Method Summary

Modifier and Type	Method and Description
T	getItem(Class<T> type) Gets the item associated with the current result.
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.
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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getItem

public T getItem(Class type)

Gets the item associated with the current result.

Parameters:

type - class type for which deserialization is needed.

Returns:

item associated with the current result.

getActivityId

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.

getCosmosDiagnostics

public CosmosDiagnostics getCosmosDiagnostics()

Gets the cosmos diagnostic for this operation.

Returns:

the CosmosDiagnosticsCosmosDiagnostics

getDuration

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.

getETag

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

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.

getResponseHeaders

public Map getResponseHeaders()

Gets the headers associated with the response.

Returns:

the response headers.

getRetryAfterDuration

public Duration getRetryAfterDuration()

Gets retry after.

Returns:

the retry after

getSessionToken

public String getSessionToken()

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

Returns:

the session token.

getStatusCode

public int getStatusCode()

Gets the HTTP status code associated with the current result.

Returns:

the status code.

getSubStatusCode

public int getSubStatusCode()

Gets sub status code associated with the current result.

Returns:

the sub status code

isSuccessStatusCode

public boolean isSuccessStatusCode()

Gets a value indicating whether the current operation completed successfully.

Returns:

true if the current operation completed successfully; false otherwise.