DocumentCollection Classe

Paquet:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • JsonSerializable
  • • Ressource
    • • com.microsoft.azure.cosmosdb.DocumentCollection

public class DocumentCollection extends Resource

Représente une collection de documents dans le service de base de données Azure Cosmos DB. Une collection est un conteneur logique nommé pour les documents.

Une base de données peut contenir zéro ou plusieurs collections nommées et chaque collection se compose de zéro ou plusieurs documents JSON. Étant sans schéma, les documents d’une collection n’ont pas besoin de partager la même structure ou les mêmes champs. Étant donné que les collections sont des ressources d’application, elles peuvent être autorisées à l’aide de la clé master ou des clés de ressource.

Récapitulatif du constructeur

Constructeur	Description
DocumentCollection()	Initialiser un objet de collection de documents.
DocumentCollection(String jsonString)	Initialisez un objet de collection de documents à partir d’une chaîne json.

Résumé de la méthode

Modificateur et type	Méthode et description
boolean	equals(Object obj)
ConflictResolutionPolicy	getConflictResolutionPolicy() Obtient la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des documents dans différentes régions, dans une collection dans le service Azure Cosmos DB.
String	getConflictsLink() Obtient le lien automatique pour les conflits dans une collection.
Integer	getDefaultTimeToLive() Obtient la valeur de durée de vie par défaut de la collection.
String	getDocumentsLink() Obtient le lien automatique pour les documents d’une collection.
IndexingPolicy	getIndexingPolicy() Obtient la stratégie d’indexation.
PartitionKeyDefinition	getPartitionKey() Obtient la définition de clé de partition de la collection.
String	getStoredProceduresLink() Obtient l’auto-liaison pour les procédures stockées dans une collection.
String	getTriggersLink() Obtient l’auto-liaison pour les déclencheurs d’une collection.
UniqueKeyPolicy	getUniqueKeyPolicy() Définit l’uni qui garantit l’unicité des documents dans la collection dans le service Azure Cosmos DB.
String	getUserDefinedFunctionsLink() Obtient l’auto-liaison pour les fonctions définies par l’utilisateur dans une collection.
int	hashCode()
void	setConflictResolutionPolicy(ConflictResolutionPolicy value) Définit la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des documents dans différentes régions, dans une collection dans le service Azure Cosmos DB.
void	setDefaultTimeToLive(Integer timeToLive) Définit la valeur de durée de vie par défaut de la collection. La valeur de durée de vie par défaut sur une collection est une propriété facultative. S’ils sont définis, les documents de la collection expirent après le nombre de secondes spécifié depuis leur dernière écriture. La valeur de cette propriété doit être l’une des suivantes : null : indique que l’évaluation de la durée de vie est désactivée et que les documents de la collection n’expireront jamais, que la durée de vie des documents individuels soit définie ou non. entier positif différent de zéro : indique la valeur de durée de vie par défaut pour tous les documents de la collection. Cette valeur peut être remplacée par la valeur de durée de vie des documents individuels. -1 : indique par défaut que tous les documents de la collection n’expirent jamais. Cette valeur peut être remplacée par la valeur de durée de vie des documents individuels.
void	setIndexingPolicy(IndexingPolicy indexingPolicy) Définit la stratégie d’indexation.
void	setPartitionKey(PartitionKeyDefinition partitionKey) Définit la définition de clé de partition de la collection.
void	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Membres hérités

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) Resource.Resource(Resource resource) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Détails du constructeur

DocumentCollection

public DocumentCollection()

Initialiser un objet de collection de documents.

DocumentCollection

public DocumentCollection(String jsonString)

Initialisez un objet de collection de documents à partir d’une chaîne json.

Parameters:

jsonString - chaîne json qui représente la collection de documents.

Détails de la méthode

equals

public boolean equals(Object obj)

Parameters:

obj

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Obtient la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des documents dans différentes régions, dans une collection dans le service Azure Cosmos DB.

Returns:

ConflictResolutionPolicy

getConflictsLink

public String getConflictsLink()

Obtient le lien automatique pour les conflits dans une collection.

Returns:

le lien conflits.

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

Obtient la valeur de durée de vie par défaut de la collection.

Returns:

valeur de durée de vie par défaut en secondes.

getDocumentsLink

public String getDocumentsLink()

Obtient le lien automatique pour les documents d’une collection.

Returns:

lien de document.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Obtient la stratégie d’indexation.

Returns:

stratégie d’indexation.

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

Obtient la définition de clé de partition de la collection.

Returns:

définition de clé de partition.

getStoredProceduresLink

public String getStoredProceduresLink()

Obtient l’auto-liaison pour les procédures stockées dans une collection.

Returns:

lien procédures stockées.

getTriggersLink

public String getTriggersLink()

Obtient l’auto-liaison pour les déclencheurs d’une collection.

Returns:

lien du déclencheur.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Définit l’uni qui garantit l’unicité des documents dans la collection dans le service Azure Cosmos DB.

Returns:

UniqueKeyPolicy

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

Obtient l’auto-liaison pour les fonctions définies par l’utilisateur dans une collection.

Returns:

lien des fonctions définies par l’utilisateur.

hashCode

public int hashCode()

setConflictResolutionPolicy

public void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Définit la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des documents dans différentes régions, dans une collection dans le service Azure Cosmos DB.

Parameters:

value - ConflictResolutionPolicy à utiliser.

setDefaultTimeToLive

public void setDefaultTimeToLive(Integer timeToLive)

Définit la valeur de durée de vie par défaut de la collection.

La valeur de durée de vie par défaut sur une collection est une propriété facultative. S’ils sont définis, les documents de la collection expirent après le nombre de secondes spécifié depuis leur dernière écriture. La valeur de cette propriété doit être l’une des suivantes :

null : indique que l’évaluation de la durée de vie est désactivée et que les documents de la collection n’expireront jamais, que la durée de vie des documents individuels soit définie ou non.

entier positif différent de zéro : indique la valeur de durée de vie par défaut pour tous les documents de la collection. Cette valeur peut être remplacée par la valeur de durée de vie des documents individuels.

-1 : indique par défaut que tous les documents de la collection n’expirent jamais. Cette valeur peut être remplacée par la valeur de durée de vie des documents individuels.

Parameters:

timeToLive - valeur de durée de vie par défaut en secondes.

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

Définit la stratégie d’indexation.

Parameters:

indexingPolicy - stratégie d’indexation.

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

Définit la définition de clé de partition de la collection.

Parameters:

partitionKey - définition de clé de partition.

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Parameters:

uniqueKeyPolicy