1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="vmmigration_v1.html">VM Migration API</a> . <a href="vmmigration_v1.projects.html">projects</a> . <a href="vmmigration_v1.projects.locations.html">locations</a> . <a href="vmmigration_v1.projects.locations.sources.html">sources</a> . <a href="vmmigration_v1.projects.locations.sources.migratingVms.html">migratingVms</a> . <a href="vmmigration_v1.projects.locations.sources.migratingVms.replicationCycles.html">replicationCycles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single ReplicationCycle.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ReplicationCycles in a given MigratingVM.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single ReplicationCycle.
Args:
name: string, Required. The name of the ReplicationCycle. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ReplicationCycle contains information about the current replication cycle status.
"cycleNumber": 42, # The cycle's ordinal number.
"endTime": "A String", # The time the replication cycle has ended.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details on the state of the cycle in case of an error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # The identifier of the ReplicationCycle.
"progressPercent": 42, # The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
"startTime": "A String", # The time the replication cycle has started.
"state": "A String", # State of the ReplicationCycle.
"steps": [ # The cycle's steps list representing its progress.
{ # CycleStep holds information about a step progress.
"endTime": "A String", # The time the cycle step has ended.
"initializingReplication": { # InitializingReplicationStep contains specific step details. # Initializing replication step.
},
"postProcessing": { # PostProcessingStep contains specific step details. # Post processing step.
},
"replicating": { # ReplicatingStep contains specific step details. # Replicating step.
"lastThirtyMinutesAverageBytesPerSecond": "A String", # The source disks replication rate for the last 30 minutes in bytes per second.
"lastTwoMinutesAverageBytesPerSecond": "A String", # The source disks replication rate for the last 2 minutes in bytes per second.
"replicatedBytes": "A String", # Replicated bytes in the step.
"totalBytes": "A String", # Total bytes to be handled in the step.
},
"startTime": "A String", # The time the cycle step has started.
},
],
"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused.
"warnings": [ # Output only. Warnings that occurred during the cycle.
{ # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.
"actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"code": "A String", # The warning code.
"helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
"warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"warningTime": "A String", # The time the warning occurred.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists ReplicationCycles in a given MigratingVM.
Args:
parent: string, Required. The parent, which owns this collection of ReplicationCycles. (required)
filter: string, Optional. The filter request.
orderBy: string, Optional. the order by fields for the result.
pageSize: integer, Optional. The maximum number of replication cycles to return. The service may return fewer than this value. If unspecified, at most 100 migrating VMs will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken: string, Required. A page token, received from a previous `ListReplicationCycles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReplicationCycles` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for 'ListReplicationCycles' request.
"nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"replicationCycles": [ # Output only. The list of replication cycles response.
{ # ReplicationCycle contains information about the current replication cycle status.
"cycleNumber": 42, # The cycle's ordinal number.
"endTime": "A String", # The time the replication cycle has ended.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Provides details on the state of the cycle in case of an error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # The identifier of the ReplicationCycle.
"progressPercent": 42, # The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.
"startTime": "A String", # The time the replication cycle has started.
"state": "A String", # State of the ReplicationCycle.
"steps": [ # The cycle's steps list representing its progress.
{ # CycleStep holds information about a step progress.
"endTime": "A String", # The time the cycle step has ended.
"initializingReplication": { # InitializingReplicationStep contains specific step details. # Initializing replication step.
},
"postProcessing": { # PostProcessingStep contains specific step details. # Post processing step.
},
"replicating": { # ReplicatingStep contains specific step details. # Replicating step.
"lastThirtyMinutesAverageBytesPerSecond": "A String", # The source disks replication rate for the last 30 minutes in bytes per second.
"lastTwoMinutesAverageBytesPerSecond": "A String", # The source disks replication rate for the last 2 minutes in bytes per second.
"replicatedBytes": "A String", # Replicated bytes in the step.
"totalBytes": "A String", # Total bytes to be handled in the step.
},
"startTime": "A String", # The time the cycle step has started.
},
],
"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused.
"warnings": [ # Output only. Warnings that occurred during the cycle.
{ # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations.
"actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"code": "A String", # The warning code.
"helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
"warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"warningTime": "A String", # The time the warning occurred.
},
],
},
],
"unreachable": [ # Output only. Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
