Class: Azure::DataMigration::Mgmt::V2018_07_15_preview::Models::MongoDbProgress

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

Overview

Base class for MongoDB migration outputs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#bytes_copied ⇒ Integer

Copying stage

Returns:

  • (Integer) —

    The number of document bytes copied during the



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

def bytes_copied
  @bytes_copied
end

#documents_copied ⇒ Integer

stage

Returns:

  • (Integer) —

    The number of documents copied during the Copying



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

def documents_copied
  @documents_copied
end

#elapsed_time ⇒ String

ddd.]hh:mm:ss[.fffffff

(i.e. TimeSpan format)

Returns:

  • (String) —

    The elapsed time in the format



25
26
27
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 25

def elapsed_time
  @elapsed_time
end

#errors ⇒ Hash{String => MongoDbError}

have occurred for the current object. The keys are the error codes.

Returns:

  • (Hash{String => MongoDbError}) —

    The errors and warnings that



29
30
31
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 29

def errors
  @errors
end

#events_pending ⇒ Integer

Returns The number of oplog events awaiting replay.

Returns:

  • (Integer) —

    The number of oplog events awaiting replay



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

def events_pending
  @events_pending
end

#events_replayed ⇒ Integer

Returns The number of oplog events replayed so far.

Returns:

  • (Integer) —

    The number of oplog events replayed so far



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

def events_replayed
  @events_replayed
end

#last_event_time ⇒ DateTime

null if no oplog event has been received yet

Returns:

  • (DateTime) —

    The timestamp of the last oplog event received, or



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

def last_event_time
  @last_event_time
end

#last_replay_time ⇒ DateTime

null if no oplog event has been replayed yet

Returns:

  • (DateTime) —

    The timestamp of the last oplog event replayed, or



43
44
45
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 43

def last_replay_time
  @last_replay_time
end

#name ⇒ String

this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null.

Returns:

  • (String) —

    The name of the progress object. For a collection,



48
49
50
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 48

def name
  @name
end

#qualified_name ⇒ String

collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null.

Returns:

  • (String) —

    The qualified name of the progress object. For a



53
54
55
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 53

def qualified_name
  @qualified_name
end

#result_type ⇒ Enum

‘Migration’, ‘Database’, ‘Collection’

Returns:

  • (Enum) —

    The type of progress object. Possible values include:



57
58
59
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 57

def result_type
  @result_type
end

#state ⇒ MongoDbMigrationState

‘ValidatingInput’, ‘Initializing’, ‘Restarting’, ‘Copying’, ‘InitialReplay’, ‘Replaying’, ‘Finalizing’, ‘Complete’, ‘Canceled’, ‘Failed’

Returns:



63
64
65
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 63

def state
  @state
end

#total_bytes ⇒ Integer

the beginning of the Copying stage, or -1 if the total size was unknown

Returns:

  • (Integer) —

    The total number of document bytes on the source at



67
68
69
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 67

def total_bytes
  @total_bytes
end

#total_documents ⇒ Integer

beginning of the Copying stage, or -1 if the total count was unknown

Returns:

  • (Integer) —

    The total number of documents on the source at the



71
72
73
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 71

def total_documents
  @total_documents
end

Class Method Details

.mapper ⇒ Object

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



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/2018-07-15-preview/generated/azure_mgmt_data_migration/models/mongo_db_progress.rb', line 78

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MongoDbProgress',
    type: {
      name: 'Composite',
      class_name: 'MongoDbProgress',
      model_properties: {
        bytes_copied: {
          client_side_validation: true,
          required: true,
          serialized_name: 'bytesCopied',
          type: {
            name: 'Number'
          }
        },
        documents_copied: {
          client_side_validation: true,
          required: true,
          serialized_name: 'documentsCopied',
          type: {
            name: 'Number'
          }
        },
        elapsed_time: {
          client_side_validation: true,
          required: true,
          serialized_name: 'elapsedTime',
          type: {
            name: 'String'
          }
        },
        errors: {
          client_side_validation: true,
          required: true,
          serialized_name: 'errors',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MongoDbErrorElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MongoDbError'
                }
            }
          }
        },
        events_pending: {
          client_side_validation: true,
          required: true,
          serialized_name: 'eventsPending',
          type: {
            name: 'Number'
          }
        },
        events_replayed: {
          client_side_validation: true,
          required: true,
          serialized_name: 'eventsReplayed',
          type: {
            name: 'Number'
          }
        },
        last_event_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'lastEventTime',
          type: {
            name: 'DateTime'
          }
        },
        last_replay_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'lastReplayTime',
          type: {
            name: 'DateTime'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        qualified_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'qualifiedName',
          type: {
            name: 'String'
          }
        },
        result_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'resultType',
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: true,
          serialized_name: 'state',
          type: {
            name: 'String'
          }
        },
        total_bytes: {
          client_side_validation: true,
          required: true,
          serialized_name: 'totalBytes',
          type: {
            name: 'Number'
          }
        },
        total_documents: {
          client_side_validation: true,
          required: true,
          serialized_name: 'totalDocuments',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end