Package com.azure.spring.data.cosmos.core.mapping

Annotation Type Container

@Inherited @Retention(RUNTIME) @Target(TYPE) public @interface Container
Annotation for Cosmos Container

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoCreateContainer
    To set if create container automatically
    boolean
    autoScale
    To enable auto scale for container RU limit
    String
    containerName
    To set container name
    String[]
    hierarchicalPartitionKeyPaths
    To set the partition key definition for container Should only be used for hierarchical partition key scenario.
    String
    partitionKeyPath
    To set the partition key definition for container Should only be used for nested partition key scenario.
    String
    ru
    To set request unit
    int
    timeToLive
    To set the ttl of container level

  • Element Details

    • containerName

      String containerName
      To set container name
      Returns:
      String
      Default:
      ""

    • ru

      String ru
      To set request unit
      Returns:
      default as ""
      Default:
      ""

    • timeToLive

      int timeToLive
      To set the ttl of container level
      Returns:
      default as no ttl
      Default:
      -1

    • autoCreateContainer

      boolean autoCreateContainer
      To set if create container automatically
      Returns:
      default as true
      Default:
      true

    • partitionKeyPath

      String partitionKeyPath
      To set the partition key definition for container Should only be used for nested partition key scenario. For general partition key support, use the PartitionKey annotation By default PartitionKey annotation will take precedence, unless not specified.
      Returns:
      partition key path
      Default:
      ""

    • hierarchicalPartitionKeyPaths

      String[] hierarchicalPartitionKeyPaths
      To set the partition key definition for container Should only be used for hierarchical partition key scenario. For general partition key support, use the PartitionKey annotation By default PartitionKey annotation will take precedence, unless not specified.
      Returns:
      list of partition key paths
      Default:
      {}

    • autoScale

      boolean autoScale
      To enable auto scale for container RU limit
      Returns:
      default as false
      Default:
      false