Class: Azure::Cosmosdb::Mgmt::V2015_04_08::Models::IndexingPolicy

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-04-08/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/2015-04-08/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 16

def automatic
  @automatic
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/2015-04-08/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/2015-04-08/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/2015-04-08/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 20

def indexing_mode
  @indexing_mode
end

Class Method Details

.mapper ⇒ Object

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



33
34
35
36
37
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/2015-04-08/generated/azure_mgmt_cosmosdb/models/indexing_policy.rb', line 33

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'
                }
            }
          }
        }
      }
    }
  }
end