Class: Azure::Cosmosdb::Mgmt::V2021_01_15::Models::ContainerPartitionKey

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#kind ⇒ PartitionKind

partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. Possible values include: ‘Hash’, ‘Range’, ‘MultiHash’. Default value: ‘Hash’ .

Returns:



24
25
26
 
# File 'lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb', line 24

def kind
  @kind
end

#paths ⇒ Array<String>

container can be partitioned

Returns:

  • (Array<String>) —

    List of paths using which data within the



18
19
20
 
# File 'lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb', line 18

def paths
  @paths
end

#system_key ⇒ Boolean

generated partition key

Returns:

  • (Boolean) —

    Indicates if the container is using a system



31
32
33
 
# File 'lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb', line 31

def system_key
  @system_key
end

#version ⇒ Integer

Returns Indicates the version of the partition key definition.

Returns:

  • (Integer) —

    Indicates the version of the partition key definition



27
28
29
 
# File 'lib/2021-01-15/generated/azure_mgmt_cosmosdb/models/container_partition_key.rb', line 27

def version
  @version
end

Class Method Details

.mapper ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# 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