CosmosContainerProperties Classe

Pacote:

com.azure.cosmos.models

Artefato Maven:

com.azure:azure-cosmos:4.59.0

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

public final class CosmosContainerProperties

Representa um contêiner no serviço de banco de dados do Azure Cosmos DB. Um contêiner cosmos é um contêiner lógico nomeado para itens do Cosmos.

Um banco de dados pode conter zero ou mais contêineres nomeados e cada contêiner consiste em zero ou mais itens JSON. Sem esquema, os itens em um contêiner não precisam compartilhar a mesma estrutura ou campos. Como os contêineres são recursos de aplicativo, eles podem ser autorizados usando a chave de master ou as chaves de recurso.

Resumo do Construtor

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

Resumo do método

Modificador e tipo	Método e descrição
Integer	getAnalyticalStoreTimeToLiveInSeconds() Obtém o tempo de vida do repositório analítico em segundos para itens em um contêiner do serviço do Azure Cosmos DB.
ChangeFeedPolicy	getChangeFeedPolicy() Obtém a política de feedde alteraçãopara esse contêiner no serviço do Azure Cosmos DB.
ClientEncryptionPolicy	getClientEncryptionPolicy() Obtém a Política de Criptografiade Clienteusada para criptografar campos de item
Collection<ComputedProperty>	getComputedProperties() Obtém as propriedades computadaspara esse contêiner no serviço do Azure Cosmos DB.
ConflictResolutionPolicy	getConflictResolutionPolicy() Obtém a Política de Resoluçãode Conflitosusada para resolver gravações conflitantes em itens em regiões diferentes, em um contêiner no serviço do Azure Cosmos DB.
Integer	getDefaultTimeToLiveInSeconds() Obtém o valor de vida útil padrão do contêiner.
String	getETag() Obtenha a marca de entidade associada ao recurso.
String	getId() Obtém o nome do recurso.
IndexingPolicy	getIndexingPolicy() Obtém a política de indexação do contêiner.
PartitionKeyDefinition	getPartitionKeyDefinition() Obtém a definição de chave de partição dos contêineres.
String	getResourceId() Obtém a ID associada ao recurso.
Instant	getTimestamp() Obtenha o último carimbo de data/hora modificado associado ao recurso.
UniqueKeyPolicy	getUniqueKeyPolicy() Obtém a política de chave exclusiva de contêineres
CosmosContainerProperties	setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive) Define o tempo de armazenamento analítico como ativo em segundos para itens em um contêiner do serviço do Azure Cosmos DB.
CosmosContainerProperties	setChangeFeedPolicy(ChangeFeedPolicy value) Define a política de feedde alteraçãopara esse contêiner no serviço do Azure Cosmos DB.
CosmosContainerProperties	setClientEncryptionPolicy(ClientEncryptionPolicy value) Define a Política de Criptografiade Clienteusada para criptografar campos de item
CosmosContainerProperties	setComputedProperties(Collection<ComputedProperty> computedProperties) Define as propriedades computadaspara esse contêiner no serviço do Azure Cosmos DB.
CosmosContainerProperties	setConflictResolutionPolicy(ConflictResolutionPolicy value) Define a Política de Resoluçãode Conflitosusada para resolver gravações conflitantes em itens em regiões diferentes, em um contêiner no serviço do Azure Cosmos DB.
CosmosContainerProperties	setDefaultTimeToLiveInSeconds(Integer timeToLive) Define o valor de vida útil padrão do contêiner.
CosmosContainerProperties	setId(String id) Define o nome do recurso.
CosmosContainerProperties	setIndexingPolicy(IndexingPolicy indexingPolicy) Define a política de indexação do contêiner
CosmosContainerProperties	setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) Define a definição da chave de partição dos contêineres.
CosmosContainerProperties	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Define a política de chave exclusiva contêineres

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

CosmosContainerProperties

public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)

Construtor

Parameters:

id - id do contêiner

partitionKeyDefinition - O PartitionKeyDefinition

CosmosContainerProperties

public CosmosContainerProperties(String id, String partitionKeyPath)

Construtor

Parameters:

id - id do contêiner

partitionKeyPath - caminho da chave de partição

Detalhes do método

getAnalyticalStoreTimeToLiveInSeconds

public Integer getAnalyticalStoreTimeToLiveInSeconds()

Obtém o tempo de vida do repositório analítico em segundos para itens em um contêiner do serviço do Azure Cosmos DB. É uma propriedade opcional. Um valor válido deve ser um inteiro positivo diferente de zero, '-1' ou 0. Por padrão, AnalyticalStoreTimeToLive é definido como 0, o que significa que o repositório analítico está desativado para o contêiner; -1 significa que os itens no repositório analítico nunca expiram. A unidade de medida é de segundos. O valor máximo permitido é 2147483647.

Returns:

ttl analítico

getChangeFeedPolicy

public ChangeFeedPolicy getChangeFeedPolicy()

Obtém a changeFeedPolicy para esse contêiner no serviço do Azure Cosmos DB.

Returns:

ChangeFeedPolicy

getClientEncryptionPolicy

public ClientEncryptionPolicy getClientEncryptionPolicy()

Obtém o ClientEncryptionPolicy usado para criptografar campos de item

Returns:

ClientEncryptionPolicy

getComputedProperties

public Collection getComputedProperties()

Obtém as computedProperties para esse contêiner no serviço do Azure Cosmos DB.

Returns:

as computedProperties.

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Obtém o conflictResolutionPolicy usado para resolver gravações conflitantes em itens em regiões diferentes, em um contêiner no serviço do Azure Cosmos DB.

Returns:

Conflictresolutionpolicy

getDefaultTimeToLiveInSeconds

public Integer getDefaultTimeToLiveInSeconds()

Obtém o valor de vida útil padrão do contêiner.

Returns:

o valor de vida útil padrão em segundos.

getETag

public String getETag()

Obtenha a marca de entidade associada ao recurso. Isso só é relevante ao obter resposta do servidor.

Returns:

a marca e.

getId

public String getId()

Obtém o nome do recurso.

Returns:

o nome do recurso.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Obtém a política de indexação do contêiner.

Returns:

a política de indexação.

getPartitionKeyDefinition

public PartitionKeyDefinition getPartitionKeyDefinition()

Obtém a definição de chave de partição dos contêineres.

Returns:

a definição da chave de partição.

getResourceId

public String getResourceId()

Obtém a ID associada ao recurso.

Returns:

a ID associada ao recurso.

getTimestamp

public Instant getTimestamp()

Obtenha o último carimbo de data/hora modificado associado ao recurso. Isso só é relevante ao obter resposta do servidor.

Returns:

o carimbo de data/hora.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Obtém a política de chave exclusiva de contêineres

Returns:

a política de chave exclusiva

setAnalyticalStoreTimeToLiveInSeconds

public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)

Define o tempo de armazenamento analítico como ativo em segundos para itens em um contêiner do serviço do Azure Cosmos DB. É uma propriedade opcional. Um valor válido deve ser um inteiro positivo diferente de zero, '-1' ou 0. Por padrão, AnalyticalStoreTimeToLive é definido como 0, o que significa que o repositório analítico está desativado para o contêiner; -1 significa que os itens no repositório analítico nunca expiram. A unidade de medida é de segundos. O valor máximo permitido é 2147483647.

Parameters:

timeToLive - o tempo de vida do repositório analítico em segundos.

Returns:

o CosmosContainerProperties.

setChangeFeedPolicy

public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)

Define o changeFeedPolicy para esse contêiner no serviço do Azure Cosmos DB.

Parameters:

value - ChangeFeedPolicy a ser usado.

Returns:

o CosmosContainerProperties.

setClientEncryptionPolicy

public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)

Define o ClientEncryptionPolicy usado para criptografar campos de item

Parameters:

value - ClientEncryptionPolicy a ser usado.

Returns:

o CosmosContainerProperties.

setComputedProperties

public CosmosContainerProperties setComputedProperties(Collection computedProperties)

Define as computedProperties para esse contêiner no serviço do Azure Cosmos DB. Para obter mais informações sobre como usar propriedades computadas, visite Propriedades computadas no Azure Cosmos DB

Parameters:

computedProperties - as computedProperties.

Returns:

o CosmosContainerProperties.

setConflictResolutionPolicy

public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)

Define o conflictResolutionPolicy usado para resolver gravações conflitantes em itens em regiões diferentes, em um contêiner no serviço do Azure Cosmos DB.

Parameters:

value - ConflictResolutionPolicy a ser usado.

Returns:

o CosmosContainerProperties.

setDefaultTimeToLiveInSeconds

public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)

Define o valor de vida útil padrão do contêiner.

O valor de vida útil padrão em um contêiner é uma propriedade opcional. Se definido, os itens dentro do contêiner expiram após o número especificado de segundos desde o último tempo de gravação. O valor dessa propriedade deve ser um dos seguintes:

nulo – indica que a avaliação do tempo de vida está desabilitada e os itens dentro do contêiner nunca expirarão, independentemente de os itens individuais terem seu tempo de vida definido.

inteiro positivo diferente de zero – indica o valor de vida útil padrão para todos os itens dentro do contêiner. Esse valor pode ser substituído pelo valor de vida útil de itens individuais.

-1 - indica, por padrão, que todos os itens dentro do contêiner nunca expiram. Esse valor pode ser substituído pelo valor de vida útil de itens individuais.

Parameters:

timeToLive - o valor de vida útil padrão em segundos.

Returns:

o CosmosContainerProperties.

setId

public CosmosContainerProperties setId(String id)

Define o nome do recurso.

Parameters:

id - o nome do recurso.

Returns:

a instância atual do CosmosContainerProperties.

setIndexingPolicy

public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)

Define a política de indexação do contêiner

Parameters:

indexingPolicy - IndexingPolicy a política de indexação

Returns:

o CosmosContainerProperties.

setPartitionKeyDefinition

public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

Define a definição da chave de partição dos contêineres.

Parameters:

partitionKeyDefinition - a definição da chave de partição.

Returns:

o CosmosContainerProperties.

setUniqueKeyPolicy

public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Define a política de chave exclusiva contêineres

Parameters:

uniqueKeyPolicy - a política de chave exclusiva

Returns:

o CosmosContainerProperties.