class Azure::Cosmosdb::Mgmt::V2021_01_15::Models::ContainerPartitionKey

The configuration of the partition key to be used for partitioning data into multiple partitions

Attributes

kind[RW]

@return [PartitionKind] Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. Possible values include: 'Hash', 'Range', 'MultiHash'. Default value: 'Hash' .

paths[RW]

@return [Array<String>] List of paths using which data within the container can be partitioned

system_key[RW]

@return [Boolean] Indicates if the container is using a system generated partition key

version[RW]

@return [Integer] Indicates the version of the partition key definition

Private Class Methods

mapper() click to toggle source

Mapper for ContainerPartitionKey class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb, line 38
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ContainerPartitionKey',
    type: {
      name: 'Composite',
      class_name: 'ContainerPartitionKey',
      model_properties: {
        paths: {
          client_side_validation: true,
          required: false,
          serialized_name: 'paths',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          default_value: 'Hash',
          type: {
            name: 'String'
          }
        },
        version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'version',
          constraints: {
            InclusiveMaximum: 2,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        system_key: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'systemKey',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end