blob: 180231fedce464370f44cc2850bb93089fbbf4ad [file] [log] [blame]
yoshi-code-botf4773f62021-10-19 00:22:31 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addGroupMigration">addGroupMigration(group, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Adds a MigratingVm to a Group.</p>
80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
84 <code><a href="#create">create(parent, body=None, groupId=None, requestId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates a new Group in a given project and location.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Deletes a single Group.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets details of a single Group.</p>
92<p class="toc_element">
93 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Lists Groups in a given project and location.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Updates the parameters of a single Group.</p>
101<p class="toc_element">
102 <code><a href="#removeGroupMigration">removeGroupMigration(group, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Removes a MigratingVm from a Group.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="addGroupMigration">addGroupMigration(group, body=None, x__xgafv=None)</code>
107 <pre>Adds a MigratingVm to a Group.
108
109Args:
110 group: string, Required. The full path name of the Group to add to. (required)
111 body: object, The request body.
112 The object takes the form of:
113
114{ # Request message for &#x27;AddGroupMigration&#x27; request.
115 &quot;migratingVm&quot;: &quot;A String&quot;, # The full path name of the MigratingVm to add.
116}
117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
126 { # This resource represents a long-running operation that is the result of a network API call.
127 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
128 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
129 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
130 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
131 {
132 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133 },
134 ],
135 &quot;message&quot;: &quot;A String&quot;, # 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.
136 },
137 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
141 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
144}</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="close">close()</code>
149 <pre>Close httplib2 connections.</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="create">create(parent, body=None, groupId=None, requestId=None, x__xgafv=None)</code>
154 <pre>Creates a new Group in a given project and location.
155
156Args:
157 parent: string, Required. The Group&#x27;s parent. (required)
158 body: object, The request body.
159 The object takes the form of:
160
161{ # Describes message for &#x27;Group&#x27; resource. The Group is a collections of several MigratingVms.
162 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
163 &quot;description&quot;: &quot;A String&quot;, # User-provided description of the group.
164 &quot;displayName&quot;: &quot;A String&quot;, # Display name is a user defined name for this group which can be updated.
165 &quot;name&quot;: &quot;A String&quot;, # The Group name.
166 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
167}
168
169 groupId: string, Required. The group identifier.
170 requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # This resource represents a long-running operation that is the result of a network API call.
180 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
181 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
182 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
183 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
184 {
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 ],
188 &quot;message&quot;: &quot;A String&quot;, # 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.
189 },
190 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192 },
193 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
194 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
195 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
196 },
197}</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
202 <pre>Deletes a single Group.
203
204Args:
205 name: string, Required. The Group name. (required)
206 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212Returns:
213 An object of the form:
214
215 { # This resource represents a long-running operation that is the result of a network API call.
216 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
217 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
218 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
219 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
220 {
221 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
222 },
223 ],
224 &quot;message&quot;: &quot;A String&quot;, # 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.
225 },
226 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
227 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
228 },
229 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
230 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
232 },
233}</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="get">get(name, x__xgafv=None)</code>
238 <pre>Gets details of a single Group.
239
240Args:
241 name: string, Required. The group name. (required)
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # Describes message for &#x27;Group&#x27; resource. The Group is a collections of several MigratingVms.
251 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
252 &quot;description&quot;: &quot;A String&quot;, # User-provided description of the group.
253 &quot;displayName&quot;: &quot;A String&quot;, # Display name is a user defined name for this group which can be updated.
254 &quot;name&quot;: &quot;A String&quot;, # The Group name.
255 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
256}</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
261 <pre>Lists Groups in a given project and location.
262
263Args:
264 parent: string, Required. The parent, which owns this collection of groups. (required)
265 filter: string, Optional. The filter request.
266 orderBy: string, Optional. the order by fields for the result.
267 pageSize: integer, Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
268 pageToken: string, Required. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token.
269 x__xgafv: string, V1 error format.
270 Allowed values
271 1 - v1 error format
272 2 - v2 error format
273
274Returns:
275 An object of the form:
276
277 { # Response message for &#x27;ListGroups&#x27; request.
278 &quot;groups&quot;: [ # Output only. The list of groups response.
279 { # Describes message for &#x27;Group&#x27; resource. The Group is a collections of several MigratingVms.
280 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
281 &quot;description&quot;: &quot;A String&quot;, # User-provided description of the group.
282 &quot;displayName&quot;: &quot;A String&quot;, # Display name is a user defined name for this group which can be updated.
283 &quot;name&quot;: &quot;A String&quot;, # The Group name.
284 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
285 },
286 ],
287 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
288 &quot;unreachable&quot;: [ # Output only. Locations that could not be reached.
289 &quot;A String&quot;,
290 ],
291}</pre>
292</div>
293
294<div class="method">
295 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
296 <pre>Retrieves the next page of results.
297
298Args:
299 previous_request: The request for the previous page. (required)
300 previous_response: The response from the request for the previous page. (required)
301
302Returns:
303 A request object that you can call &#x27;execute()&#x27; on to request the next
304 page. Returns None if there are no more items in the collection.
305 </pre>
306</div>
307
308<div class="method">
309 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
310 <pre>Updates the parameters of a single Group.
311
312Args:
313 name: string, The Group name. (required)
314 body: object, The request body.
315 The object takes the form of:
316
317{ # Describes message for &#x27;Group&#x27; resource. The Group is a collections of several MigratingVms.
318 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time timestamp.
319 &quot;description&quot;: &quot;A String&quot;, # User-provided description of the group.
320 &quot;displayName&quot;: &quot;A String&quot;, # Display name is a user defined name for this group which can be updated.
321 &quot;name&quot;: &quot;A String&quot;, # The Group name.
322 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time timestamp.
323}
324
325 requestId: string, A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
326 updateMask: string, Field mask is used to specify the fields to be overwritten in the Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332Returns:
333 An object of the form:
334
335 { # This resource represents a long-running operation that is the result of a network API call.
336 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
337 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
340 {
341 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
342 },
343 ],
344 &quot;message&quot;: &quot;A String&quot;, # 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.
345 },
346 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
347 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
348 },
349 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
350 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
352 },
353}</pre>
354</div>
355
356<div class="method">
357 <code class="details" id="removeGroupMigration">removeGroupMigration(group, body=None, x__xgafv=None)</code>
358 <pre>Removes a MigratingVm from a Group.
359
360Args:
361 group: string, Required. The name of the Group. (required)
362 body: object, The request body.
363 The object takes the form of:
364
365{ # Request message for &#x27;RemoveMigration&#x27; request.
366 &quot;migratingVm&quot;: &quot;A String&quot;, # The MigratingVm to remove.
367}
368
369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
373
374Returns:
375 An object of the form:
376
377 { # This resource represents a long-running operation that is the result of a network API call.
378 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
379 &quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
380 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
381 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
382 {
383 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
384 },
385 ],
386 &quot;message&quot;: &quot;A String&quot;, # 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.
387 },
388 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
389 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
390 },
391 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
392 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
393 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
394 },
395}</pre>
396</div>
397
398</body></html>