Class: Azure::Cosmosdb::Mgmt::V2019_08_01::Models::IndexingPolicy

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb

Overview

Cosmos DB indexing policy

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#automatic ⇒ Boolean

Returns Indicates if the indexing policy is automatic.

Returns:

  • (Boolean) —

    Indicates if the indexing policy is automatic



16
17
18
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 16

def automatic
  @automatic
end

#composite_indexes ⇒ Array<Array<CompositePath>>

Returns List of composite path list.

Returns:



29
30
31
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 29

def composite_indexes
  @composite_indexes
end

#excluded_paths ⇒ Array<ExcludedPath>

Returns List of paths to exclude from indexing.

Returns:

  • (Array<ExcludedPath>) —

    List of paths to exclude from indexing



26
27
28
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 26

def excluded_paths
  @excluded_paths
end

#included_paths ⇒ Array<IncludedPath>

Returns List of paths to include in the indexing.

Returns:

  • (Array<IncludedPath>) —

    List of paths to include in the indexing



23
24
25
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 23

def included_paths
  @included_paths
end

#indexing_mode ⇒ IndexingMode

include: ‘Consistent’, ‘Lazy’, ‘None’. Default value: ‘Consistent’ .

Returns:

  • (IndexingMode) —

    Indicates the indexing mode. Possible values



20
21
22
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 20

def indexing_mode
  @indexing_mode
end

#spatial_indexes ⇒ Array<SpatialSpec>

Returns List of spatial specifics.

Returns:



32
33
34
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 32

def spatial_indexes
  @spatial_indexes
end

Class Method Details

.mapper ⇒ Object

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



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/2019-08-01/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 39

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'IndexingPolicy',
    type: {
      name: 'Composite',
      class_name: 'IndexingPolicy',
      model_properties: {
        automatic: {
          client_side_validation: true,
          required: false,
          serialized_name: 'automatic',
          type: {
            name: 'Boolean'
          }
        },
        indexing_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'indexingMode',
          default_value: 'Consistent',
          type: {
            name: 'String'
          }
        },
        included_paths: {
          client_side_validation: true,
          required: false,
          serialized_name: 'includedPaths',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IncludedPathElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IncludedPath'
                }
            }
          }
        },
        excluded_paths: {
          client_side_validation: true,
          required: false,
          serialized_name: 'excludedPaths',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ExcludedPathElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ExcludedPath'
                }
            }
          }
        },
        composite_indexes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'compositeIndexes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ArrayElementType',
                type: {
                  name: 'Sequence',
                  element: {
                      client_side_validation: true,
                      required: false,
                      serialized_name: 'CompositePathElementType',
                      type: {
                        name: 'Composite',
                        class_name: 'CompositePath'
                      }
                  }
                }
            }
          }
        },
        spatial_indexes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'spatialIndexes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SpatialSpecElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SpatialSpec'
                }
            }
          }
        }
      }
    }
  }
end