Class: Azure::Cosmosdb::Mgmt::V2015_04_08::Models::MongoDBCollection

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-04-08/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection.rb

Overview

An Azure Cosmos DB MongoDB collection.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#indexes ⇒ Array<MongoIndex>

Returns List of index keys.

Returns:



23
24
25
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection.rb', line 23

def indexes
  @indexes
end

#mongo_dbcollection_id ⇒ String

Returns Name of the Cosmos DB MongoDB collection.

Returns:

  • (String) —

    Name of the Cosmos DB MongoDB collection



16
17
18
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection.rb', line 16

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

def shard_key
  @shard_key
end

Class Method Details

.mapper ⇒ Object

Mapper for MongoDBCollection 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
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
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/models/mongo_dbcollection.rb', line 30

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MongoDBCollection',
    type: {
      name: 'Composite',
      class_name: 'MongoDBCollection',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        mongo_dbcollection_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.id',
          type: {
            name: 'String'
          }
        },
        shard_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.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: 'properties.indexes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MongoIndexElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MongoIndex'
                }
            }
          }
        }
      }
    }
  }
end