CosmosContainerProperties Clase

Paquete:

com.azure.cosmos.models

Artefacto Maven:

com.azure:azure-cosmos:4.59.0

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

public final class CosmosContainerProperties

Representa un contenedor en el servicio de base de datos de Azure Cosmos DB. Un contenedor de Cosmos es un contenedor lógico con nombre para los elementos de Cosmos.

Una base de datos puede contener cero o más contenedores con nombre y cada contenedor consta de cero o más elementos JSON. Sin esquemas, los elementos de un contenedor no necesitan compartir la misma estructura o campos. Dado que los contenedores son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos.

Resumen del constructor

Constructor	Description
CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)	Constructor
CosmosContainerProperties(String id, String partitionKeyPath)	Constructor

Resumen del método

Modificador y tipo	Método y descripción
Integer	getAnalyticalStoreTimeToLiveInSeconds() Obtiene el tiempo de vida del almacén analítico en segundos para los elementos de un contenedor del servicio Azure Cosmos DB.
ChangeFeedPolicy	getChangeFeedPolicy() Obtiene la directiva de fuentede cambiospara este contenedor en el servicio Azure Cosmos DB.
ClientEncryptionPolicy	getClientEncryptionPolicy() Obtiene la directiva de cifradode clienteque se usa para cifrar campos de elemento.
Collection<ComputedProperty>	getComputedProperties() Obtiene las propiedades calculadasde este contenedor en el servicio Azure Cosmos DB.
ConflictResolutionPolicy	getConflictResolutionPolicy() Obtiene la directiva de resoluciónde conflictosque se usa para resolver escrituras en conflicto en elementos de diferentes regiones, en un contenedor del servicio Azure Cosmos DB.
Integer	getDefaultTimeToLiveInSeconds() Obtiene el valor predeterminado del período de vida del contenedor.
String	getETag() Obtenga la etiqueta de entidad asociada al recurso.
String	getId() Obtiene el nombre del recurso.
IndexingPolicy	getIndexingPolicy() Obtiene la directiva de indexación del contenedor.
PartitionKeyDefinition	getPartitionKeyDefinition() Obtiene la definición de clave de partición de los contenedores.
String	getResourceId() Obtiene el identificador asociado al recurso.
Instant	getTimestamp() Obtenga la marca de tiempo de la última modificación asociada al recurso.
UniqueKeyPolicy	getUniqueKeyPolicy() Obtiene la directiva de clave única de contenedores.
CosmosContainerProperties	setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive) Establece el tiempo de vida del almacén analítico en segundos para los elementos de un contenedor desde el servicio Azure Cosmos DB.
CosmosContainerProperties	setChangeFeedPolicy(ChangeFeedPolicy value) Establece la directiva de fuentede cambiospara este contenedor en el servicio Azure Cosmos DB.
CosmosContainerProperties	setClientEncryptionPolicy(ClientEncryptionPolicy value) Establece la directiva de cifradode clienteque se usa para cifrar campos de elementos
CosmosContainerProperties	setComputedProperties(Collection<ComputedProperty> computedProperties) Establece las propiedades calculadaspara este contenedor en el servicio Azure Cosmos DB.
CosmosContainerProperties	setConflictResolutionPolicy(ConflictResolutionPolicy value) Establece la directiva de resoluciónde conflictosque se usa para resolver escrituras en conflicto en elementos de diferentes regiones, en un contenedor del servicio Azure Cosmos DB.
CosmosContainerProperties	setDefaultTimeToLiveInSeconds(Integer timeToLive) Establece el valor predeterminado del período de vida del contenedor.
CosmosContainerProperties	setId(String id) Establece el nombre del recurso.
CosmosContainerProperties	setIndexingPolicy(IndexingPolicy indexingPolicy) Establece la directiva de indexación del contenedor
CosmosContainerProperties	setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) Establece la definición de clave de partición de los contenedores.
CosmosContainerProperties	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Establece la directiva de clave única de contenedores

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

CosmosContainerProperties

public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)

Constructor

Parameters:

id - id. del contenedor

partitionKeyDefinition - el PartitionKeyDefinition

CosmosContainerProperties

public CosmosContainerProperties(String id, String partitionKeyPath)

Constructor

Parameters:

id - id. del contenedor

partitionKeyPath - ruta de acceso de la clave de partición

Detalles del método

getAnalyticalStoreTimeToLiveInSeconds

public Integer getAnalyticalStoreTimeToLiveInSeconds()

Obtiene el tiempo de vida del almacén analítico en segundos para los elementos de un contenedor del servicio Azure Cosmos DB. Es una propiedad opcional. Un valor válido debe ser un entero positivo distinto de cero, "-1" o 0. De forma predeterminada, AnalyticalStoreTimeToLive se establece en 0, lo que significa que el almacén analítico está desactivado para el contenedor; -1 significa que los elementos del almacén analítico nunca expiran. La unidad de medida es de segundos. El valor máximo permitido es 2147483647.

Returns:

ttl analítico

getChangeFeedPolicy

public ChangeFeedPolicy getChangeFeedPolicy()

Obtiene changeFeedPolicy para este contenedor en el servicio Azure Cosmos DB.

Returns:

ChangeFeedPolicy

getClientEncryptionPolicy

public ClientEncryptionPolicy getClientEncryptionPolicy()

Obtiene clientEncryptionPolicy que se usa para cifrar campos de elemento.

Returns:

ClientEncryptionPolicy

getComputedProperties

public Collection getComputedProperties()

Obtiene computedProperties para este contenedor en el servicio Azure Cosmos DB.

Returns:

computedProperties.

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Obtiene el conflictResolutionPolicy que se usa para resolver escrituras en conflicto en elementos de diferentes regiones, en un contenedor del servicio Azure Cosmos DB.

Returns:

ConflictResolutionPolicy

getDefaultTimeToLiveInSeconds

public Integer getDefaultTimeToLiveInSeconds()

Obtiene el valor predeterminado del período de vida del contenedor.

Returns:

valor predeterminado de período de vida en segundos.

getETag

public String getETag()

Obtenga la etiqueta de entidad asociada al recurso. Esto solo es relevante al obtener la respuesta del servidor.

Returns:

la etiqueta e.

getId

public String getId()

Obtiene el nombre del recurso.

Returns:

el nombre del recurso.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Obtiene la directiva de indexación del contenedor.

Returns:

la directiva de indexación.

getPartitionKeyDefinition

public PartitionKeyDefinition getPartitionKeyDefinition()

Obtiene la definición de clave de partición de los contenedores.

Returns:

definición de clave de partición.

getResourceId

public String getResourceId()

Obtiene el identificador asociado al recurso.

Returns:

el identificador asociado al recurso.

getTimestamp

public Instant getTimestamp()

Obtenga la marca de tiempo de la última modificación asociada al recurso. Esto solo es relevante cuando se obtiene la respuesta del servidor.

Returns:

marca de tiempo.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Obtiene la directiva de clave única de contenedores.

Returns:

la directiva de clave única

setAnalyticalStoreTimeToLiveInSeconds

public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)

Establece el tiempo de vida del almacén analítico en segundos para los elementos de un contenedor desde el servicio Azure Cosmos DB. Es una propiedad opcional. Un valor válido debe ser un entero positivo distinto de cero, "-1" o 0. De forma predeterminada, AnalyticalStoreTimeToLive se establece en 0, lo que significa que el almacén analítico está desactivado para el contenedor; -1 significa que los elementos del almacén analítico nunca expiran. La unidad de medida es de segundos. El valor máximo permitido es 2147483647.

Parameters:

timeToLive - el período de vida del almacén analítico en segundos.

Returns:

CosmosContainerProperties.

setChangeFeedPolicy

public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)

Establece changeFeedPolicy para este contenedor en el servicio Azure Cosmos DB.

Parameters:

value - ChangeFeedPolicy que se va a usar.

Returns:

CosmosContainerProperties.

setClientEncryptionPolicy

public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)

Establece clientEncryptionPolicy que se usa para cifrar campos de elementos

Parameters:

value - ClientEncryptionPolicy que se va a usar.

Returns:

CosmosContainerProperties.

setComputedProperties

public CosmosContainerProperties setComputedProperties(Collection computedProperties)

Establece computedProperties para este contenedor en el servicio Azure Cosmos DB. Para más información sobre cómo usar propiedades calculadas, consulte Propiedades calculadas en Azure Cosmos DB.

Parameters:

computedProperties - computedProperties.

Returns:

CosmosContainerProperties.

setConflictResolutionPolicy

public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)

Establece conflictResolutionPolicy que se usa para resolver escrituras en conflicto en elementos de diferentes regiones, en un contenedor del servicio Azure Cosmos DB.

Parameters:

value - ConflictResolutionPolicy que se va a usar.

Returns:

CosmosContainerProperties.

setDefaultTimeToLiveInSeconds

public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)

Establece el valor predeterminado del período de vida del contenedor.

El valor predeterminado de período de vida en un contenedor es una propiedad opcional. Si se establece, los elementos del contenedor expiran después del número de segundos especificado desde su última hora de escritura. El valor de esta propiedad debe ser uno de los siguientes:

null: indica que la evaluación del período de vida está deshabilitada y los elementos del contenedor nunca expirarán, independientemente de si los elementos individuales tienen su período de vida establecido.

entero positivo distinto de cero: indica el valor predeterminado de período de vida para todos los elementos del contenedor. Este valor se puede invalidar mediante el valor de período de vida de los elementos individuales.

-1: indica de forma predeterminada que todos los elementos del contenedor nunca expiran. Este valor se puede invalidar mediante el valor de período de vida de los elementos individuales.

Parameters:

timeToLive - valor predeterminado de período de vida en segundos.

Returns:

CosmosContainerProperties.

setId

public CosmosContainerProperties setId(String id)

Establece el nombre del recurso.

Parameters:

id - el nombre del recurso.

Returns:

la instancia actual de CosmosContainerProperties.

setIndexingPolicy

public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)

Establece la directiva de indexación del contenedor

Parameters:

indexingPolicy - IndexingPolicy la directiva de indexación

Returns:

CosmosContainerProperties.

setPartitionKeyDefinition

public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

Establece la definición de clave de partición de los contenedores.

Parameters:

partitionKeyDefinition - definición de clave de partición.

Returns:

CosmosContainerProperties.

setUniqueKeyPolicy

public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Establece la directiva de clave única de contenedores

Parameters:

uniqueKeyPolicy - la directiva de clave única

Returns:

CosmosContainerProperties.