CosmosContainerProperties (Azure SDK for Java Reference Documentation)

Posted by Na Lin on Tuesday, June 11, 2024
CosmosContainerProperties (Azure SDK for Java Reference Documentation) public final class CosmosContainerProperties extends Object Represents a container in the Azure Cosmos DB database service. A cosmos container is a named logical container for cosmos items.

A database may contain zero or more named containers and each container consists of zero or more JSON items. Being schema-free, the items in a container do not need to share the same structure or fields. Since containers are application resources, they can be authorized using either the master key or resource keys.

  • Constructor Summary

    Constructors

    Constructor

    Constructor

  • Method Summary

    All MethodsInstance MethodsConcrete Methods

    Gets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service.

    Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.

    Gets the ClientEncryptionPolicy that is used for encrypting item fields

    Gets the computedProperties for this container in the Azure Cosmos DB service.

    Gets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.

    Gets the container's default time-to-live value.

    Get the entity tag associated with the resource.

    Gets the name of the resource.

    Gets the container's indexing policy.

    Gets the containers's partition key definition.

    Gets the ID associated with the resource.

    Get the last modified timestamp associated with the resource.

    Gets the containers unique key policy

    Gets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.

    Sets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service.

    Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.

    Sets the ClientEncryptionPolicy that is used for encrypting item fields

    Sets the computedProperties for this container in the Azure Cosmos DB service.

    Sets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.

    Sets the container's default time-to-live value.

    Sets the name of the resource.

    Sets the container's indexing policy

    Sets the containers's partition key definition.

    Sets the Containers unique key policy

    Sets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CosmosContainerProperties

      public CosmosContainerProperties(String id, String partitionKeyPath)

      Constructor

      Parameters: id - id of the Container partitionKeyPath - partition key path

    • CosmosContainerProperties

      Constructor

      Parameters: id - id of the container partitionKeyDefinition - the PartitionKeyDefinition

  • Method Details

    • getIndexingPolicy

      Gets the container's indexing policy.

      Returns: the indexing policy.

    • setIndexingPolicy

      Sets the container's indexing policy

      Parameters: indexingPolicy - IndexingPolicy the indexing policy Returns: the CosmosContainerProperties.

    • getUniqueKeyPolicy

      Gets the containers unique key policy

      Returns: the unique key policy

    • setUniqueKeyPolicy

      Sets the Containers unique key policy

      Parameters: uniqueKeyPolicy - the unique key policy Returns: the CosmosContainerProperties.

    • getPartitionKeyDefinition

      Gets the containers's partition key definition.

      Returns: the partition key definition.

    • setPartitionKeyDefinition

      Sets the containers's partition key definition.

      Parameters: partitionKeyDefinition - the partition key definition. Returns: the CosmosContainerProperties.

    • getConflictResolutionPolicy

      Gets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.

      Returns: ConflictResolutionPolicy

    • setConflictResolutionPolicy

      Sets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.

      Parameters: value - ConflictResolutionPolicy to be used. Returns: the CosmosContainerProperties.

    • getChangeFeedPolicy

      Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.

      Returns: ChangeFeedPolicy

    • setChangeFeedPolicy

      Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.

      Parameters: value - ChangeFeedPolicy to be used. Returns: the CosmosContainerProperties.

    • getComputedProperties

      Gets the computedProperties for this container in the Azure Cosmos DB service.

      Returns: the computedProperties.

    • setComputedProperties

      Parameters: computedProperties - the computedProperties. Returns: the CosmosContainerProperties.

    • getDefaultTimeToLiveInSeconds

      public Integer getDefaultTimeToLiveInSeconds()

      Gets the container's default time-to-live value.

      Returns: the default time-to-live value in seconds.

    • setDefaultTimeToLiveInSeconds

      Sets the container's default time-to-live value.

      The default time-to-live value on a container is an optional property. If set, the items within the container expires after the specified number of seconds since their last write time. The value of this property should be one of the following:

      null - indicates evaluation of time-to-live is disabled and items within the container will never expire, regardless whether individual items have their time-to-live set.

      nonzero positive integer - indicates the default time-to-live value for all items within the container. This value can be overridden by individual items time-to-live value.

      -1 - indicates by default all items within the container never expire. This value can be overridden by individual items time-to-live value.

      Parameters: timeToLive - the default time-to-live value in seconds. Returns: the CosmosContainerProperties.

    • setAnalyticalStoreTimeToLiveInSeconds

      Sets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service. It is an optional property. A valid value must be either a nonzero positive integer, '-1', or 0. By default, AnalyticalStoreTimeToLive is set to 0 meaning the analytical store is turned off for the container; -1 means items in analytical store never expire. The unit of measurement is seconds. The maximum allowed value is 2147483647.

      Parameters: timeToLive - the analytical store time to live in seconds. Returns: the CosmosContainerProperties.

    • getAnalyticalStoreTimeToLiveInSeconds

      public Integer getAnalyticalStoreTimeToLiveInSeconds()

      Gets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service. It is an optional property. A valid value must be either a nonzero positive integer, '-1', or 0. By default, AnalyticalStoreTimeToLive is set to 0 meaning the analytical store is turned off for the container; -1 means items in analytical store never expire. The unit of measurement is seconds. The maximum allowed value is 2147483647.

      Returns: analytical ttl

    • getId

      Gets the name of the resource.

      Returns: the name of the resource.

    • setId

      Sets the name of the resource.

      Parameters: id - the name of the resource. Returns: the current instance of CosmosContainerProperties.

    • getResourceId

      public String getResourceId()

      Gets the ID associated with the resource.

      Returns: the ID associated with the resource.

    • getTimestamp

      Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server.

      Returns: the timestamp.

    • getETag

      Get the entity tag associated with the resource. This is only relevant when getting response from the server.

      Returns: the e tag.

    • getClientEncryptionPolicy

      Gets the ClientEncryptionPolicy that is used for encrypting item fields

      Returns: ClientEncryptionPolicy

    • setClientEncryptionPolicy

      Sets the ClientEncryptionPolicy that is used for encrypting item fields

      Parameters: value - ClientEncryptionPolicy to be used. Returns: the CosmosContainerProperties.

    • getVectorEmbeddingPolicy

      Gets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.

      Returns: the Vector Embedding Policy.

    • setVectorEmbeddingPolicy

      Sets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.

      Parameters: value - the Vector Embedding Policy. Returns: the CosmosContainerProperties.

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnploopGrrnCt2a6pnmWTpMCuu9Joo5qslajBcK%2FOpmaasqWnsnCvzqykqKtforylscusZnyno6K8tI%2FOp6uaoZ6av5G%2Bzqmcq6yZmsBvtNOmow%3D%3D

CATALOG
    FEATURED TAGS