CosmosContainerProperties Classe
- java.
lang. Object - com.
azure. cosmos. models. CosmosContainerProperties
- com.
public final class CosmosContainerProperties
Représente un conteneur dans le service de base de données Azure Cosmos DB. Un conteneur cosmos est un conteneur logique nommé pour les éléments cosmos.
Une base de données peut contenir zéro ou plusieurs conteneurs nommés et chaque conteneur se compose de zéro ou plusieurs éléments JSON. Étant sans schéma, les éléments d’un conteneur n’ont pas besoin de partager la même structure ou les mêmes champs. Étant donné que les conteneurs sont des ressources d’application, ils peuvent être autorisés à l’aide de la clé master ou des clés de ressource.
Récapitulatif du constructeur
| Constructeur | Description |
|---|---|
| CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition) |
Constructeur |
| CosmosContainerProperties(String id, String partitionKeyPath) |
Constructeur |
Résumé de la méthode
| Modificateur et type | Méthode et description |
|---|---|
| Integer |
getAnalyticalStoreTimeToLiveInSeconds()
Obtient la durée de vie du magasin analytique en secondes pour les éléments d’un conteneur à partir du service Azure Cosmos DB. |
|
Change |
getChangeFeedPolicy()
Obtient la stratégie de flux |
|
Client |
getClientEncryptionPolicy()
Obtient la stratégie de chiffrement |
|
Collection<Computed |
getComputedProperties()
Obtient les propriétés calculées |
|
Conflict |
getConflictResolutionPolicy()
Obtient la stratégie de résolution |
| Integer |
getDefaultTimeToLiveInSeconds()
Obtient la valeur de durée de vie par défaut du conteneur. |
| String |
getETag()
Obtenez la balise d’entité associée à la ressource. |
| String |
getId()
Obtient le nom de la ressource. |
|
Indexing |
getIndexingPolicy()
Obtient la stratégie d’indexation du conteneur. |
|
Partition |
getPartitionKeyDefinition()
Obtient la définition de clé de partition des conteneurs. |
| String |
getResourceId()
Obtient l’ID associé à la ressource. |
| Instant |
getTimestamp()
Obtenez le dernier horodatage modifié associé à la ressource. |
|
Unique |
getUniqueKeyPolicy()
Obtient la stratégie de clé unique des conteneurs |
|
Cosmos |
setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)
Définit la durée de vie du magasin analytique en secondes pour les éléments d’un conteneur à partir du service Azure Cosmos DB. |
|
Cosmos |
setChangeFeedPolicy(ChangeFeedPolicy value)
Définit la stratégie de flux |
|
Cosmos |
setClientEncryptionPolicy(ClientEncryptionPolicy value)
Définit la stratégie de chiffrement |
|
Cosmos |
setComputedProperties(Collection<ComputedProperty> computedProperties)
Définit les propriétés calculées |
|
Cosmos |
setConflictResolutionPolicy(ConflictResolutionPolicy value)
Définit la stratégie de résolution |
|
Cosmos |
setDefaultTimeToLiveInSeconds(Integer timeToLive)
Définit la valeur de durée de vie par défaut du conteneur. |
|
Cosmos |
setId(String id)
Définit le nom de la ressource. |
|
Cosmos |
setIndexingPolicy(IndexingPolicy indexingPolicy)
Définit la stratégie d’indexation du conteneur |
|
Cosmos |
setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)
Définit la définition de clé de partition des conteneurs. |
|
Cosmos |
setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)
Définit la stratégie de clé unique conteneurs |
Méthodes héritées de java.lang.Object
Détails du constructeur
CosmosContainerProperties
public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)
Constructeur
Parameters:
CosmosContainerProperties
public CosmosContainerProperties(String id, String partitionKeyPath)
Constructeur
Parameters:
Détails de la méthode
getAnalyticalStoreTimeToLiveInSeconds
public Integer getAnalyticalStoreTimeToLiveInSeconds()
Obtient la durée de vie du magasin analytique en secondes pour les éléments d’un conteneur à partir du service Azure Cosmos DB. Il s’agit d’une propriété facultative. Une valeur valide doit être un entier positif différent de zéro, « -1 » ou 0. Par défaut, AnalyticalStoreTimeToLive est défini sur 0, ce qui signifie que le magasin analytique est désactivé pour le conteneur ; -1 signifie que les éléments du magasin analytique n’expirent jamais. L’unité de mesure est en secondes. La valeur maximale autorisée est 2147483647.
Returns:
getChangeFeedPolicy
public ChangeFeedPolicy getChangeFeedPolicy()
Obtient la changeFeedPolicy pour ce conteneur dans le service Azure Cosmos DB.
Returns:
getClientEncryptionPolicy
public ClientEncryptionPolicy getClientEncryptionPolicy()
Obtient la stratégie ClientEncryptionPolicy utilisée pour chiffrer les champs d’élément
Returns:
getComputedProperties
public Collection
Obtient les propriétés calculées pour ce conteneur dans le service Azure Cosmos DB.
Returns:
getConflictResolutionPolicy
public ConflictResolutionPolicy getConflictResolutionPolicy()
Obtient la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des éléments dans différentes régions, dans un conteneur du service Azure Cosmos DB.
Returns:
getDefaultTimeToLiveInSeconds
public Integer getDefaultTimeToLiveInSeconds()
Obtient la valeur de durée de vie par défaut du conteneur.
Returns:
getETag
public String getETag()
Obtenez la balise d’entité associée à la ressource. Cela s’applique uniquement lors de l’obtention d’une réponse du serveur.
Returns:
getId
public String getId()
Obtient le nom de la ressource.
Returns:
getIndexingPolicy
public IndexingPolicy getIndexingPolicy()
Obtient la stratégie d’indexation du conteneur.
Returns:
getPartitionKeyDefinition
public PartitionKeyDefinition getPartitionKeyDefinition()
Obtient la définition de clé de partition des conteneurs.
Returns:
getResourceId
public String getResourceId()
Obtient l’ID associé à la ressource.
Returns:
getTimestamp
public Instant getTimestamp()
Obtenez le dernier horodatage modifié associé à la ressource. Cela n’est pertinent que lors de l’obtention de la réponse du serveur.
Returns:
getUniqueKeyPolicy
public UniqueKeyPolicy getUniqueKeyPolicy()
Obtient la stratégie de clé unique des conteneurs
Returns:
setAnalyticalStoreTimeToLiveInSeconds
public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)
Définit la durée de vie du magasin analytique en secondes pour les éléments d’un conteneur à partir du service Azure Cosmos DB. Il s’agit d’une propriété facultative. Une valeur valide doit être un entier positif différent de zéro, « -1 » ou 0. Par défaut, AnalyticalStoreTimeToLive a la valeur 0, ce qui signifie que le magasin analytique est désactivé pour le conteneur ; -1 signifie que les éléments du magasin analytique n’expirent jamais. L’unité de mesure est en secondes. La valeur maximale autorisée est 2147483647.
Parameters:
Returns:
setChangeFeedPolicy
public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)
Définit la changeFeedPolicy pour ce conteneur dans le service Azure Cosmos DB.
Parameters:
Returns:
setClientEncryptionPolicy
public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)
Définit la stratégie ClientEncryptionPolicy utilisée pour chiffrer les champs d’élément
Parameters:
Returns:
setComputedProperties
public CosmosContainerProperties setComputedProperties(Collection
Définit les propriétés computedProperties pour ce conteneur dans le service Azure Cosmos DB. Pour plus d’informations sur l’utilisation des propriétés calculées, consultez Propriétés calculées dans Azure Cosmos DB.
Parameters:
Returns:
setConflictResolutionPolicy
public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)
Définit la conflictResolutionPolicy utilisée pour résoudre les écritures en conflit sur des éléments dans différentes régions, dans un conteneur du service Azure Cosmos DB.
Parameters:
Returns:
setDefaultTimeToLiveInSeconds
public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)
Définit la valeur de durée de vie par défaut du conteneur.
La valeur de durée de vie par défaut sur un conteneur est une propriété facultative. S’ils sont définis, les éléments du conteneur 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 éléments du conteneur n’expireront jamais, que les éléments individuels aient ou non leur durée de vie définie.
entier positif non nul : indique la valeur de durée de vie par défaut pour tous les éléments du conteneur. Cette valeur peut être remplacée par la valeur de durée de vie des éléments individuels.
-1 : indique par défaut tous les éléments du conteneur n’expirent jamais. Cette valeur peut être remplacée par la valeur de durée de vie des éléments individuels.
Parameters:
Returns:
setId
public CosmosContainerProperties setId(String id)
Définit le nom de la ressource.
Parameters:
Returns:
setIndexingPolicy
public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)
Définit la stratégie d’indexation du conteneur
Parameters:
Returns:
setPartitionKeyDefinition
public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)
Définit la définition de clé de partition des conteneurs.
Parameters:
Returns:
setUniqueKeyPolicy
public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)
Définit la stratégie de clé unique conteneurs
Parameters:
Returns:
S’applique à
Azure SDK for Java
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour