CosmosSyncItem (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.data.cosmos.sync.CosmosSyncItem

public class CosmosSyncItem
extends Object

The Cosmos synchronous item.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CosmosSyncItemResponse`	`delete(CosmosItemRequestOptions options)`	Delete cosmos sync item response.
`String`	`id()`	Id string.
`Object`	`partitionKey()`	Partition key object.
`CosmosSyncItemResponse`	`read(CosmosItemRequestOptions options)`	Read cosmos sync item response.
`CosmosSyncItemResponse`	`replace(Object item, CosmosItemRequestOptions options)`	Replace cosmos sync item response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - id
```
public String id()
```
    Id string.
    
    Returns:
    
    the string
  - partitionKey
```
public Object partitionKey()
```
    Partition key object.
    
    Returns:
    
    the object
  - read
```
public CosmosSyncItemResponse read(CosmosItemRequestOptions options)
                            throws CosmosClientException
```
    Read cosmos sync item response.
    
    Parameters:
    
    options - the options
    
    Returns:
    
    the cosmos sync item response
    
    Throws:
    
    CosmosClientException - the cosmos client exception
  - replace
```
public CosmosSyncItemResponse replace(Object item,
                                      CosmosItemRequestOptions options)
                               throws CosmosClientException
```
    Replace cosmos sync item response.
    
    Parameters:
    
    item - the item
    
    options - the options
    
    Returns:
    
    the cosmos sync item response
    
    Throws:
    
    CosmosClientException - the cosmos client exception
  - delete
```
public CosmosSyncItemResponse delete(CosmosItemRequestOptions options)
                              throws CosmosClientException
```
    Delete cosmos sync item response.
    
    Parameters:
    
    options - the options
    
    Returns:
    
    the cosmos sync item response
    
    Throws:
    
    CosmosClientException - the cosmos client exception