-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
vmmigration_v1.projects.locations.sources.html
571 lines (518 loc) 路 40.5 KB
/
vmmigration_v1.projects.locations.sources.html
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="vmmigration_v1.projects.locations.sources.datacenterConnectors.html">datacenterConnectors()</a></code>
</p>
<p class="firstline">Returns the datacenterConnectors Resource.</p>
<p class="toc_element">
<code><a href="vmmigration_v1.projects.locations.sources.migratingVms.html">migratingVms()</a></code>
</p>
<p class="firstline">Returns the migratingVms Resource.</p>
<p class="toc_element">
<code><a href="vmmigration_v1.projects.locations.sources.utilizationReports.html">utilizationReports()</a></code>
</p>
<p class="firstline">Returns the utilizationReports Resource.</p>
<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="#create">create(parent, body=None, requestId=None, sourceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Source in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Source.</p>
<p class="toc_element">
<code><a href="#fetchInventory">fetchInventory(source, forceRefresh=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.</p>
<p class="toc_element">
<code><a href="#fetchInventory_next">fetchInventory_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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 Source.</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 Sources in a given project and location.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Source.</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="create">create(parent, body=None, requestId=None, sourceId=None, x__xgafv=None)</code>
<pre>Creates a new Source in a given project and location.
Args:
parent: string, Required. The Source's parent. (required)
body: object, The request body.
The object takes the form of:
{ # Source message describes a specific vm migration Source resource. It contains the source environment information.
"aws": { # AwsSourceDetails message describes a specific source details for the AWS source type. # AWS type source details.
"accessKeyCreds": { # Message describing AWS Credentials using access key id and secret. # AWS Credentials using access key id and secret.
"accessKeyId": "A String", # AWS access key ID.
"secretAccessKey": "A String", # Input only. AWS secret access key.
"sessionToken": "A String", # Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.
},
"awsRegion": "A String", # Immutable. The AWS region that the source VMs will be migrated from.
"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 Source 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.
},
"inventorySecurityGroupNames": [ # AWS security group names to limit the scope of the source inventory.
"A String",
],
"inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory.
{ # Tag is an AWS tag representation.
"key": "A String", # Key of tag.
"value": "A String", # Value of tag.
},
],
"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.
"a_key": "A String",
},
"publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP.
"state": "A String", # Output only. State of the source as determined by the health check.
},
"createTime": "A String", # Output only. The create time timestamp.
"description": "A String", # User-provided description of the source.
"labels": { # The labels of the source.
"a_key": "A String",
},
"name": "A String", # Output only. The Source name.
"updateTime": "A String", # Output only. The update time timestamp.
"vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
"password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
"thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
"username": "A String", # The credentials username.
"vcenterIp": "A String", # The ip address of the vcenter this Source represents.
},
}
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 the 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).
sourceId: string, Required. The source identifier.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"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). # The error result of the operation in case of failure or cancellation.
"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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Deletes a single Source.
Args:
name: string, Required. The Source name. (required)
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 the 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"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). # The error result of the operation in case of failure or cancellation.
"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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="fetchInventory">fetchInventory(source, forceRefresh=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.
Args:
source: string, Required. The name of the Source. (required)
forceRefresh: boolean, If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.
pageSize: integer, The maximum number of VMs to return. The service may return fewer than this value. For AWS source: If unspecified, at most 500 VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. For VMWare source: If unspecified, all VMs will be returned. There is no limit for maximum value.
pageToken: string, A page token, received from a previous `FetchInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchInventory` 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 fetchInventory.
"awsVms": { # AWSVmsDetails describes VMs in AWS. # The description of the VMs in a Source of type AWS.
"details": [ # The details of the AWS VMs.
{ # AwsVmDetails describes a VM in AWS.
"architecture": "A String", # The CPU architecture.
"bootOption": "A String", # The VM Boot Option.
"committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
"cpuCount": 42, # The number of cpus the VM has.
"diskCount": 42, # The number of disks the VM has.
"displayName": "A String", # The display name of the VM. Note that this value is not necessarily unique.
"instanceType": "A String", # The instance type of the VM.
"memoryMb": 42, # The memory size of the VM in MB.
"osDescription": "A String", # The VM's OS.
"powerState": "A String", # Output only. The power state of the VM at the moment list was taken.
"securityGroups": [ # The security groups the VM belongs to.
{ # AwsSecurityGroup describes a security group of an AWS VM.
"id": "A String", # The AWS security group id.
"name": "A String", # The AWS security group name.
},
],
"sourceDescription": "A String", # The descriptive name of the AWS's source this VM is connected to.
"sourceId": "A String", # The id of the AWS's source this VM is connected to.
"tags": { # The tags of the VM.
"a_key": "A String",
},
"virtualizationType": "A String", # The virtualization type.
"vmId": "A String", # The VM ID in AWS.
"vpcId": "A String", # The VPC ID the VM belongs to.
"zone": "A String", # The AWS zone of the VM.
},
],
},
"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.
"updateTime": "A String", # Output only. The timestamp when the source was last queried (if the result is from the cache).
"vmwareVms": { # VmwareVmsDetails describes VMs in vCenter. # The description of the VMs in a Source of type Vmware.
"details": [ # The details of the vmware VMs.
{ # VmwareVmDetails describes a VM in vCenter.
"bootOption": "A String", # Output only. The VM Boot Option.
"committedStorageMb": "A String", # The total size of the storage allocated to the VM in MB.
"cpuCount": 42, # The number of cpus in the VM.
"datacenterDescription": "A String", # The descriptive name of the vCenter's datacenter this VM is contained in.
"datacenterId": "A String", # The id of the vCenter's datacenter this VM is contained in.
"diskCount": 42, # The number of disks the VM has.
"displayName": "A String", # The display name of the VM. Note that this is not necessarily unique.
"guestDescription": "A String", # The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
"memoryMb": 42, # The size of the memory of the VM in MB.
"powerState": "A String", # The power state of the VM at the moment list was taken.
"uuid": "A String", # The unique identifier of the VM in vCenter.
"vmId": "A String", # The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="fetchInventory_next">fetchInventory_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>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Source.
Args:
name: string, Required. The Source name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Source message describes a specific vm migration Source resource. It contains the source environment information.
"aws": { # AwsSourceDetails message describes a specific source details for the AWS source type. # AWS type source details.
"accessKeyCreds": { # Message describing AWS Credentials using access key id and secret. # AWS Credentials using access key id and secret.
"accessKeyId": "A String", # AWS access key ID.
"secretAccessKey": "A String", # Input only. AWS secret access key.
"sessionToken": "A String", # Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.
},
"awsRegion": "A String", # Immutable. The AWS region that the source VMs will be migrated from.
"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 Source 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.
},
"inventorySecurityGroupNames": [ # AWS security group names to limit the scope of the source inventory.
"A String",
],
"inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory.
{ # Tag is an AWS tag representation.
"key": "A String", # Key of tag.
"value": "A String", # Value of tag.
},
],
"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.
"a_key": "A String",
},
"publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP.
"state": "A String", # Output only. State of the source as determined by the health check.
},
"createTime": "A String", # Output only. The create time timestamp.
"description": "A String", # User-provided description of the source.
"labels": { # The labels of the source.
"a_key": "A String",
},
"name": "A String", # Output only. The Source name.
"updateTime": "A String", # Output only. The update time timestamp.
"vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
"password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
"thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
"username": "A String", # The credentials username.
"vcenterIp": "A String", # The ip address of the vcenter this Source represents.
},
}</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 Sources in a given project and location.
Args:
parent: string, Required. The parent, which owns this collection of sources. (required)
filter: string, Optional. The filter request.
orderBy: string, Optional. the order by fields for the result.
pageSize: integer, Optional. The maximum number of sources to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Required. A page token, received from a previous `ListSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSources` 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 'ListSources' 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.
"sources": [ # Output only. The list of sources response.
{ # Source message describes a specific vm migration Source resource. It contains the source environment information.
"aws": { # AwsSourceDetails message describes a specific source details for the AWS source type. # AWS type source details.
"accessKeyCreds": { # Message describing AWS Credentials using access key id and secret. # AWS Credentials using access key id and secret.
"accessKeyId": "A String", # AWS access key ID.
"secretAccessKey": "A String", # Input only. AWS secret access key.
"sessionToken": "A String", # Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.
},
"awsRegion": "A String", # Immutable. The AWS region that the source VMs will be migrated from.
"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 Source 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.
},
"inventorySecurityGroupNames": [ # AWS security group names to limit the scope of the source inventory.
"A String",
],
"inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory.
{ # Tag is an AWS tag representation.
"key": "A String", # Key of tag.
"value": "A String", # Value of tag.
},
],
"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.
"a_key": "A String",
},
"publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP.
"state": "A String", # Output only. State of the source as determined by the health check.
},
"createTime": "A String", # Output only. The create time timestamp.
"description": "A String", # User-provided description of the source.
"labels": { # The labels of the source.
"a_key": "A String",
},
"name": "A String", # Output only. The Source name.
"updateTime": "A String", # Output only. The update time timestamp.
"vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
"password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
"thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
"username": "A String", # The credentials username.
"vcenterIp": "A String", # The ip address of the vcenter this Source represents.
},
},
],
"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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Source.
Args:
name: string, Output only. The Source name. (required)
body: object, The request body.
The object takes the form of:
{ # Source message describes a specific vm migration Source resource. It contains the source environment information.
"aws": { # AwsSourceDetails message describes a specific source details for the AWS source type. # AWS type source details.
"accessKeyCreds": { # Message describing AWS Credentials using access key id and secret. # AWS Credentials using access key id and secret.
"accessKeyId": "A String", # AWS access key ID.
"secretAccessKey": "A String", # Input only. AWS secret access key.
"sessionToken": "A String", # Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.
},
"awsRegion": "A String", # Immutable. The AWS region that the source VMs will be migrated from.
"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 Source 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.
},
"inventorySecurityGroupNames": [ # AWS security group names to limit the scope of the source inventory.
"A String",
],
"inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory.
{ # Tag is an AWS tag representation.
"key": "A String", # Key of tag.
"value": "A String", # Value of tag.
},
],
"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.
"a_key": "A String",
},
"publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP.
"state": "A String", # Output only. State of the source as determined by the health check.
},
"createTime": "A String", # Output only. The create time timestamp.
"description": "A String", # User-provided description of the source.
"labels": { # The labels of the source.
"a_key": "A String",
},
"name": "A String", # Output only. The Source name.
"updateTime": "A String", # Output only. The update time timestamp.
"vmware": { # VmwareSourceDetails message describes a specific source details for the vmware source type. # Vmware type source details.
"password": "A String", # Input only. The credentials password. This is write only and can not be read in a GET operation.
"thumbprint": "A String", # The thumbprint representing the certificate for the vcenter.
"username": "A String", # The credentials username.
"vcenterIp": "A String", # The ip address of the vcenter this Source represents.
},
}
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 the 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).
updateMask: string, Field mask is used to specify the fields to be overwritten in the Source 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"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). # The error result of the operation in case of failure or cancellation.
"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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>