com.azure.cosmos.models

Class CosmosItemIdentity

java.lang.Object

com.azure.cosmos.models.CosmosItemIdentity

public final class CosmosItemIdentity
extends Object

Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItem

Constructor Summary

Constructors

Constructor and Description
CosmosItemIdentity(PartitionKey partitionKey, String id) Instantiates an instance of the CosmosItemIdentity class

Method Summary

Modifier and Type	Method and Description
String	getId() Gets the id value uniquely identifying this item within the scope of a logical partition
PartitionKey	getPartitionKey() Gets the partition key

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosItemIdentity

public CosmosItemIdentity(PartitionKey partitionKey,
                          String id)

Instantiates an instance of the CosmosItemIdentity class

Parameters:

partitionKey - the partition key - must not be null

id - the item id value - must be unique within the scope of a logical partition, must not be null or empty

Method Detail

getPartitionKey

public PartitionKey getPartitionKey()

Gets the partition key

Returns:

the partition key - must not be null

getId

public String getId()

Gets the id value uniquely identifying this item within the scope of a logical partition

Returns:

the id value uniquely identifying this item within the scope of a logical partition - must not be null or empty