CosmosItemIdentity Class

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

public final class CosmosItemIdentity

Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItem

Constructor Summary

Constructor Description
CosmosItemIdentity(PartitionKey partitionKey, String id)

Instantiates an instance of the CosmosItemIdentity class

Method Summary

Modifier and Type Method and Description
boolean equals(Object o)
String getId()

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

PartitionKey getPartitionKey()

Gets the partition key

int hashCode()

Methods inherited from java.lang.Object

Constructor Details

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 Details

equals

public boolean equals(Object o)

Overrides:

CosmosItemIdentity.equals(Object o)

Parameters:

o

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

getPartitionKey

public PartitionKey getPartitionKey()

Gets the partition key

Returns:

the partition key - must not be null

hashCode

public int hashCode()

Overrides:

CosmosItemIdentity.hashCode()

Applies to