com.microsoft.azure.cosmos

Class CosmosItem

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmos.CosmosItem

public class CosmosItem
extends Resource

Constructor Summary

Constructors

Constructor and Description
CosmosItem() Initialize a item object.
CosmosItem(String jsonString) Initialize a CosmosItem object from json string.
CosmosItem(String jsonString, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Initialize an CosmosItem object from json string.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<CosmosItemResponse>	delete(CosmosItemRequestOptions options) Deletes the item.
reactor.core.publisher.Mono<CosmosItemResponse>	delete(Object partitionKey) Deletes the item.
<T> T	getObject(Class<?> klass)
reactor.core.publisher.Mono<CosmosItemResponse>	read(CosmosItemRequestOptions requestOptions) Reads an item.
reactor.core.publisher.Mono<CosmosItemResponse>	read(Object partitionKey) Reads an item.
reactor.core.publisher.Mono<CosmosItemResponse>	replace(Object item, CosmosItemRequestOptions requestOptions) Replaces an item with the passed in item.
reactor.core.publisher.Mono<CosmosItemResponse>	replace(Object item, Object partitionKey) Replaces an item with the passed in item.

Methods inherited from class com.microsoft.azure.cosmosdb.Resource

getETag, getId, getResourceId, getSelfLink, getTimestamp, setId, setResourceId

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getList, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosItem

public CosmosItem()

Initialize a item object.

CosmosItem

public CosmosItem(String jsonString)

Initialize a CosmosItem object from json string.

Parameters:

jsonString - the json string that represents the document object.

CosmosItem

public CosmosItem(String jsonString,
                  com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Initialize an CosmosItem object from json string.

Parameters:

jsonString - the json string that represents the item object.

objectMapper - the custom object mapper

Method Detail

read

public reactor.core.publisher.Mono<CosmosItemResponse> read(Object partitionKey)

Reads an item. After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos item response with the read item In case of failure the Mono will error.

Returns:

an Mono containing the cosmos item response with the read item or an error

read

public reactor.core.publisher.Mono<CosmosItemResponse> read(CosmosItemRequestOptions requestOptions)

Reads an item. After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos item response with the read item In case of failure the Mono will error.

Parameters:

requestOptions - the request comosItemRequestOptions

Returns:

an Mono containing the cosmos item response with the read item or an error

replace

public reactor.core.publisher.Mono<CosmosItemResponse> replace(Object item,
                                                               Object partitionKey)

Replaces an item with the passed in item. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos item response with the replaced item. In case of failure the Mono will error.

Parameters:

item - the item to replace (containing the document id).

partitionKey - the partition key

Returns:

an Mono containing the cosmos item resource response with the replaced item or an error.

replace

public reactor.core.publisher.Mono<CosmosItemResponse> replace(Object item,
                                                               CosmosItemRequestOptions requestOptions)

Replaces an item with the passed in item. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos item response with the replaced item. In case of failure the Mono will error.

Parameters:

item - the item to replace (containing the document id).

requestOptions - the request comosItemRequestOptions

Returns:

an Mono containing the cosmos item resource response with the replaced item or an error.

delete

public reactor.core.publisher.Mono<CosmosItemResponse> delete(Object partitionKey)

Deletes the item. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos item response with the replaced item. In case of failure the Mono will error.

Parameters:

partitionKey -

Returns:

an Mono containing the cosmos item resource response.

delete

public reactor.core.publisher.Mono<CosmosItemResponse> delete(CosmosItemRequestOptions options)

Deletes the item. After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos item response with the replaced item. In case of failure the Mono will error.

Parameters:

options - the request options

Returns:

an Mono containing the cosmos item resource response.

getObject

public <T> T getObject(Class<?> klass)
                throws IOException

Throws:

IOException