class Azure::Cosmosdb::Mgmt::V2021_01_15::Models::IndexingPolicy

Cosmos DB indexing policy

Attributes

automatic[RW]

@return [Boolean] Indicates if the indexing policy is automatic

composite_indexes[RW]

@return [Array<Array<CompositePath>>] List of composite path list

excluded_paths[RW]

@return [Array<ExcludedPath>] List of paths to exclude from indexing

included_paths[RW]

@return [Array<IncludedPath>] List of paths to include in the indexing

indexing_mode[RW]

@return [IndexingMode] Indicates the indexing mode. Possible values include: 'consistent', 'lazy', 'none'. Default value: 'consistent' .

spatial_indexes[RW]

@return [Array<SpatialSpec>] List of spatial specifics

Private Class Methods

mapper() click to toggle source

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

# File lib/2021-01-15/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