Class: Azure::Cosmosdb::Mgmt::V2019_12_12::Models::MongoDBCollectionResource

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-12/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_resource.rb

Overview

Cosmos DB MongoDB collection resource object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#id ⇒ String

Returns Name of the Cosmos DB MongoDB collection.

Returns:

  • (String) —

    Name of the Cosmos DB MongoDB collection



16
17
18
 
# File 'lib/2019-12-12/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_resource.rb', line 16

def id
  @id
end

#indexes ⇒ Array<MongoIndex>

Returns List of index keys.

Returns:



23
24
25
 
# File 'lib/2019-12-12/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_resource.rb', line 23

def indexes
  @indexes
end

#shard_key ⇒ Hash{String => String}

applied for the request.

Returns:

  • (Hash{String => String}) —

    A key-value pair of shard keys to be



20
21
22
 
# File 'lib/2019-12-12/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_resource.rb', line 20

def shard_key
  @shard_key
end

Class Method Details

.mapper ⇒ Object

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



30
31
32
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
 
# File 'lib/2019-12-12/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection_resource.rb', line 30

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MongoDBCollectionResource',
    type: {
      name: 'Composite',
      class_name: 'MongoDBCollectionResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        shard_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'shardKey',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        indexes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'indexes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MongoIndexElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MongoIndex'
                }
            }
          }
        }
      }
    }
  }
end