Package com.azure.resourcemanager.cosmos.models

Class ContainerPartitionKey

java.lang.Object
com.azure.resourcemanager.cosmos.models.ContainerPartitionKey
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContainerPartitionKey>
public final class ContainerPartitionKey extends Object implements com.azure.json.JsonSerializable<ContainerPartitionKey>
The configuration of the partition key to be used for partitioning data into multiple partitions.

  • Constructor Details

    • ContainerPartitionKey

      public ContainerPartitionKey()
      Creates an instance of ContainerPartitionKey class.

  • Method Details

    • 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ContainerPartitionKey>
      Throws:
      IOException

    • fromJson

      public static ContainerPartitionKey fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ContainerPartitionKey from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ContainerPartitionKey if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ContainerPartitionKey.