DocumentCollection Classe

  • Referência
Pacote:
com.microsoft.azure.cosmosdb

public class DocumentCollection extends Resource

Representa uma coleção de documentos no serviço de banco de dados do Azure Cosmos DB. Uma coleção é um contêiner lógico nomeado para documentos.

Um banco de dados pode conter zero ou mais coleções nomeadas e cada coleção consiste em zero ou mais documentos JSON. Sendo livres de esquema, os documentos em uma coleção não precisam compartilhar a mesma estrutura ou campos. Como as coleções são recursos de aplicativo, elas podem ser autorizadas usando a chave master ou as chaves de recurso.

Resumo do Construtor

Construtor Description
DocumentCollection()

Inicializar um objeto de coleção de documentos.

DocumentCollection(String jsonString)

Inicialize um objeto de coleção de documentos da cadeia de caracteres json.

Resumo do método

Modificador e tipo Método e descrição
boolean equals(Object obj)
ConflictResolutionPolicy getConflictResolutionPolicy()

Obtém o conflictResolutionPolicy usado para resolver gravações conflitantes em documentos em regiões diferentes, em uma coleção no serviço do Azure Cosmos DB.
String getConflictsLink()

Obtém o auto-vínculo para conflitos em uma coleção.
Integer getDefaultTimeToLive()

Obtém o valor de vida útil padrão da coleção.
String getDocumentsLink()

Obtém o auto-link para documentos em uma coleção.
IndexingPolicy getIndexingPolicy()

Obtém a política de indexação.
PartitionKeyDefinition getPartitionKey()

Obtém a definição da chave de partição da coleção.
String getStoredProceduresLink()

Obtém o auto-link para procedimentos armazenados em uma coleção.
String getTriggersLink()

Obtém o auto-link para gatilhos em uma coleção.
UniqueKeyPolicy getUniqueKeyPolicy()

Define a Uni que garante a exclusividade dos documentos na coleção no serviço do Azure Cosmos DB.

String getUserDefinedFunctionsLink()

Obtém o auto-link para funções definidas pelo usuário em uma coleção.
int hashCode()
void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Define o conflictResolutionPolicy usado para resolver gravações conflitantes em documentos em diferentes regiões, em uma coleção no serviço do Azure Cosmos DB.
void setDefaultTimeToLive(Integer timeToLive)

Define o valor de vida útil padrão da coleção.

O valor de vida útil padrão em uma coleção é uma propriedade opcional. Se definido, os documentos dentro da coleção 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 útil está desabilitada e os documentos dentro da coleção nunca expirarão, independentemente de documentos individuais terem seu tempo de vida definido.

inteiro positivo diferente de zero – indica o valor de vida útil padrão para todos os documentos dentro da coleção. Esse valor pode ser substituído pelo valor de vida útil de documentos individuais.

-1 – indica, por padrão, que todos os documentos dentro da coleção nunca expiram. Esse valor pode ser substituído pelo valor de vida útil de documentos individuais.
void setIndexingPolicy(IndexingPolicy indexingPolicy)

Define a política de indexação.
void setPartitionKey(PartitionKeyDefinition partitionKey)

Define a definição da chave de partição da coleção.
void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Membros herdados

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()

Detalhes do construtor

DocumentCollection

public DocumentCollection()

Inicializar um objeto de coleção de documentos.

DocumentCollection

public DocumentCollection(String jsonString)

Inicialize um objeto de coleção de documentos da cadeia de caracteres json.

Parâmetros:

jsonString - a cadeia de caracteres json que representa a coleção de documentos.

Detalhes do método

equals

public boolean equals(Object obj)

Parâmetros:

obj

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Obtém o conflictResolutionPolicy usado para resolver gravações conflitantes em documentos em regiões diferentes, em uma coleção no serviço do Azure Cosmos DB.

Retornos:

Conflictresolutionpolicy

getConflictsLink

public String getConflictsLink()

Obtém o auto-vínculo para conflitos em uma coleção.

Retornos:

o link de conflitos.

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

Obtém o valor de vida útil padrão da coleção.

Retornos:

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

getDocumentsLink

public String getDocumentsLink()

Obtém o auto-link para documentos em uma coleção.

Retornos:

o link do documento.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Obtém a política de indexação.

Retornos:

a política de indexação.

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

Obtém a definição da chave de partição da coleção.

Retornos:

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

getStoredProceduresLink

public String getStoredProceduresLink()

Obtém o auto-link para procedimentos armazenados em uma coleção.

Retornos:

o link de procedimentos armazenados.

getTriggersLink

public String getTriggersLink()

Obtém o auto-link para gatilhos em uma coleção.

Retornos:

o link do gatilho.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Define a Uni que garante a exclusividade dos documentos na coleção no serviço do Azure Cosmos DB.

Retornos:

UniqueKeyPolicy

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

Obtém o auto-link para funções definidas pelo usuário em uma coleção.

Retornos:

o link de funções definidas pelo usuário.

hashCode

public int hashCode()

setConflictResolutionPolicy

public void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Define o conflictResolutionPolicy usado para resolver gravações conflitantes em documentos em diferentes regiões, em uma coleção no serviço do Azure Cosmos DB.

Parâmetros:

value - ConflictResolutionPolicy a ser usado.

setDefaultTimeToLive

public void setDefaultTimeToLive(Integer timeToLive)

Define o valor de vida útil padrão da coleção.

O valor de vida útil padrão em uma coleção é uma propriedade opcional. Se definido, os documentos dentro da coleção 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 útil está desabilitada e os documentos dentro da coleção nunca expirarão, independentemente de documentos individuais terem seu tempo de vida definido.

inteiro positivo diferente de zero – indica o valor de vida útil padrão para todos os documentos dentro da coleção. Esse valor pode ser substituído pelo valor de vida útil de documentos individuais.

-1 – indica, por padrão, que todos os documentos dentro da coleção nunca expiram. Esse valor pode ser substituído pelo valor de vida útil de documentos individuais.

Parâmetros:

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

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

Define a política de indexação.

Parâmetros:

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

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

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

Parâmetros:

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

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Parâmetros:

uniqueKeyPolicy

Aplica-se a