Package com.azure.resourcemanager.cosmos.models

Class ContainerPartitionKey

  • public final class ContainerPartitionKey
extends Object
    The configuration of the partition key to be used for partitioning data into multiple partitions.

    • Constructor Detail

      • ContainerPartitionKey

        public ContainerPartitionKey()

    • Method Detail

      • paths

        public List<String> paths()
        Get the paths property: List of paths using which data within the container can be partitioned.
        Returns:
        the paths value.

      • withPaths

        public ContainerPartitionKey withPaths​(List<String> paths)
        Set the paths property: List of paths using which data within the container can be partitioned.
        Parameters:
        paths - the paths value to set.
        Returns:
        the ContainerPartitionKey object itself.

      • kind

        public PartitionKind kind()
        Get the kind property: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.
        Returns:
        the kind value.

      • withKind

        public ContainerPartitionKey withKind​(PartitionKind kind)
        Set the kind property: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.
        Parameters:
        kind - the kind value to set.
        Returns:
        the ContainerPartitionKey object itself.

      • version

        public Integer version()
        Get the version property: Indicates the version of the partition key definition.
        Returns:
        the version value.

      • withVersion

        public ContainerPartitionKey withVersion​(Integer version)
        Set the version property: Indicates the version of the partition key definition.
        Parameters:
        version - the version value to set.
        Returns:
        the ContainerPartitionKey object itself.

      • systemKey

        public Boolean systemKey()
        Get the systemKey property: Indicates if the container is using a system generated partition key.
        Returns:
        the systemKey value.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.