Class: Azure::DataMigration::Mgmt::V2018_07_15_preview::Models::MongoDbCollectionInfo

Inherits:
MongoDbObjectInfo
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb

Overview

Describes a supported collection within a MongoDB database

Instance Attribute Summary collapse

Attributes inherited from MongoDbObjectInfo

#average_document_size, #data_size, #document_count, #name, #qualified_name

Class Method Summary collapse

Instance Attribute Details

#database_name ⇒ String

Returns The name of the database containing the collection.

Returns:

  • (String) —

    The name of the database containing the collection



16
17
18
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 16

def database_name
  @database_name
end

#is_capped ⇒ Boolean

whether it has a fixed size and acts like a circular buffer)

Returns:

  • (Boolean) —

    Whether the collection is a capped collection (i.e.



20
21
22
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 20

def is_capped
  @is_capped
end

#is_system_collection ⇒ Boolean

Returns Whether the collection is system collection.

Returns:

  • (Boolean) —

    Whether the collection is system collection



23
24
25
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 23

def is_system_collection
  @is_system_collection
end

#is_view ⇒ Boolean

collection

Returns:

  • (Boolean) —

    Whether the collection is a view of another



27
28
29
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 27

def is_view
  @is_view
end

#shard_key ⇒ MongoDbShardKeyInfo

if the collection is not sharded

Returns:



31
32
33
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 31

def shard_key
  @shard_key
end

#supports_sharding ⇒ Boolean

the migration task will enable sharding on the target if necessary.

Returns:

  • (Boolean) —

    Whether the database has sharding enabled. Note that



35
36
37
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 35

def supports_sharding
  @supports_sharding
end

#view_of ⇒ String

IsView is true

Returns:

  • (String) —

    The name of the collection that this is a view of, if



39
40
41
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 39

def view_of
  @view_of
end

Class Method Details

.mapper ⇒ Object

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



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
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_collection_info.rb', line 46

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MongoDbCollectionInfo',
    type: {
      name: 'Composite',
      class_name: 'MongoDbCollectionInfo',
      model_properties: {
        average_document_size: {
          client_side_validation: true,
          required: true,
          serialized_name: 'averageDocumentSize',
          type: {
            name: 'Number'
          }
        },
        data_size: {
          client_side_validation: true,
          required: true,
          serialized_name: 'dataSize',
          type: {
            name: 'Number'
          }
        },
        document_count: {
          client_side_validation: true,
          required: true,
          serialized_name: 'documentCount',
          type: {
            name: 'Number'
          }
        },
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        qualified_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'qualifiedName',
          type: {
            name: 'String'
          }
        },
        database_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'databaseName',
          type: {
            name: 'String'
          }
        },
        is_capped: {
          client_side_validation: true,
          required: true,
          serialized_name: 'isCapped',
          type: {
            name: 'Boolean'
          }
        },
        is_system_collection: {
          client_side_validation: true,
          required: true,
          serialized_name: 'isSystemCollection',
          type: {
            name: 'Boolean'
          }
        },
        is_view: {
          client_side_validation: true,
          required: true,
          serialized_name: 'isView',
          type: {
            name: 'Boolean'
          }
        },
        shard_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'shardKey',
          type: {
            name: 'Composite',
            class_name: 'MongoDbShardKeyInfo'
          }
        },
        supports_sharding: {
          client_side_validation: true,
          required: true,
          serialized_name: 'supportsSharding',
          type: {
            name: 'Boolean'
          }
        },
        view_of: {
          client_side_validation: true,
          required: false,
          serialized_name: 'viewOf',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end