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 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
|
<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="migrationcenter_v1alpha1.html">Migration Center API</a> . <a href="migrationcenter_v1alpha1.projects.html">projects</a> . <a href="migrationcenter_v1alpha1.projects.locations.html">locations</a> . <a href="migrationcenter_v1alpha1.projects.locations.preferenceSets.html">preferenceSets</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="#create">create(parent, body=None, preferenceSetId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new preference set 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 preference set.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a preference set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the preference sets 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 preference set.</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, preferenceSetId=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a new preference set in a given project and location.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # The preferences that apply to all assets in a given context.
"createTime": "A String", # Output only. The timestamp when the preference set was created.
"databasePreferences": { # DatabasePreferences enables you to create sets of preferences for your migrated databases. # Optional. A set of preferences that applies to all databases in the context.
"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
"multithreading": "A String", # Optional. Preferences for multithreading support.
"versionType": "A String", # Optional. Edition of Microsoft SQL version that is used on a Cloud SQL for SQL server instance.
},
"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
},
"description": "A String", # A description of the preference set.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of the PreferenceSet.
"regionPreferences": { # The user preferences relating to target regions. # Optional. Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If unspecified, VirtualMachinePreferences.RegionPreferences is used.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"updateTime": "A String", # Output only. The timestamp when the preference set was last updated.
"virtualMachinePreferences": { # VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all virtual machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for operating systems. If unspecified, costs are calculated based on the default licensing plan. If os_pricing_preferences is specified, it overrides this field.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for Compute Engine. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server.
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters.
"estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100].
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If PreferenceSet.RegionPreferences is specified, it overrides this field.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationCustomParameters": { # Custom data to use for sizing optimizations. # Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to "custom".
"aggregationMethod": "A String", # Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics.
"cpuUsagePercentage": 42, # Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value).
"memoryUsagePercentage": 42, # Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value).
"storageMultiplier": 3.14, # Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value).
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine.
"allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
"protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering.
"storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available.
},
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"serviceType": "A String", # Optional. GCVE service type (fully licensed or portable license).
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
}
preferenceSetId: string, A parameter
requestId: string, Optional. An optional 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).
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, successful response of the operation. 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 preference set.
Args:
name: string, Required. Name of the group resource. (required)
requestId: string, Optional. An optional 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, successful response of the operation. 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="get">get(name, x__xgafv=None)</code>
<pre>Gets the details of a preference set.
Args:
name: string, Required. Name of the resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The preferences that apply to all assets in a given context.
"createTime": "A String", # Output only. The timestamp when the preference set was created.
"databasePreferences": { # DatabasePreferences enables you to create sets of preferences for your migrated databases. # Optional. A set of preferences that applies to all databases in the context.
"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
"multithreading": "A String", # Optional. Preferences for multithreading support.
"versionType": "A String", # Optional. Edition of Microsoft SQL version that is used on a Cloud SQL for SQL server instance.
},
"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
},
"description": "A String", # A description of the preference set.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of the PreferenceSet.
"regionPreferences": { # The user preferences relating to target regions. # Optional. Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If unspecified, VirtualMachinePreferences.RegionPreferences is used.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"updateTime": "A String", # Output only. The timestamp when the preference set was last updated.
"virtualMachinePreferences": { # VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all virtual machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for operating systems. If unspecified, costs are calculated based on the default licensing plan. If os_pricing_preferences is specified, it overrides this field.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for Compute Engine. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server.
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters.
"estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100].
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If PreferenceSet.RegionPreferences is specified, it overrides this field.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationCustomParameters": { # Custom data to use for sizing optimizations. # Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to "custom".
"aggregationMethod": "A String", # Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics.
"cpuUsagePercentage": 42, # Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value).
"memoryUsagePercentage": 42, # Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value).
"storageMultiplier": 3.14, # Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value).
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine.
"allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
"protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering.
"storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available.
},
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"serviceType": "A String", # Optional. GCVE service type (fully licensed or portable license).
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the preference sets in a given project and location.
Args:
parent: string, Required. Parent value for `ListPreferenceSetsRequest`. (required)
orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 500 preference sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A token identifying a page of results the server should return.
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 listing preference sets.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"preferenceSets": [ # The list of PreferenceSets
{ # The preferences that apply to all assets in a given context.
"createTime": "A String", # Output only. The timestamp when the preference set was created.
"databasePreferences": { # DatabasePreferences enables you to create sets of preferences for your migrated databases. # Optional. A set of preferences that applies to all databases in the context.
"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
"multithreading": "A String", # Optional. Preferences for multithreading support.
"versionType": "A String", # Optional. Edition of Microsoft SQL version that is used on a Cloud SQL for SQL server instance.
},
"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
},
"description": "A String", # A description of the preference set.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of the PreferenceSet.
"regionPreferences": { # The user preferences relating to target regions. # Optional. Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If unspecified, VirtualMachinePreferences.RegionPreferences is used.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"updateTime": "A String", # Output only. The timestamp when the preference set was last updated.
"virtualMachinePreferences": { # VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all virtual machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for operating systems. If unspecified, costs are calculated based on the default licensing plan. If os_pricing_preferences is specified, it overrides this field.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for Compute Engine. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server.
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters.
"estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100].
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If PreferenceSet.RegionPreferences is specified, it overrides this field.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationCustomParameters": { # Custom data to use for sizing optimizations. # Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to "custom".
"aggregationMethod": "A String", # Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics.
"cpuUsagePercentage": 42, # Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value).
"memoryUsagePercentage": 42, # Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value).
"storageMultiplier": 3.14, # Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value).
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine.
"allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
"protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering.
"storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available.
},
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"serviceType": "A String", # Optional. GCVE service type (fully licensed or portable license).
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
},
],
"unreachable": [ # 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 preference set.
Args:
name: string, Output only. Name of the PreferenceSet. (required)
body: object, The request body.
The object takes the form of:
{ # The preferences that apply to all assets in a given context.
"createTime": "A String", # Output only. The timestamp when the preference set was created.
"databasePreferences": { # DatabasePreferences enables you to create sets of preferences for your migrated databases. # Optional. A set of preferences that applies to all databases in the context.
"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
"multithreading": "A String", # Optional. Preferences for multithreading support.
"versionType": "A String", # Optional. Edition of Microsoft SQL version that is used on a Cloud SQL for SQL server instance.
},
"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL.
"common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases.
"backup": { # Preferences for database backups. # Optional. Preferences for database backups.
"backupMode": "A String", # Optional. Automated backup mode.
},
"commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available.
"edition": "A String", # Optional. Preferred Cloud SQL edition.
"persistentDiskType": "A String", # Optional. Persistent disk type to use. If unspecified, a disk type is recommended based on available usage data. For SQL Server, only SSD is available. For MySQL and PostgreSQL, only STANDARD (HDD) and SSD types are available.
"sizingOptimizationStrategy": "A String", # Optional. Sizing optimization strategy of the database. Currently supported for Cloud SQL are just two values: SIZING_OPTIMIZATION_STRATEGY_MODERATE and SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE. SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED will behave like SIZING_OPTIMIZATION_STRATEGY_MODERATE.
"zoneAvailability": "A String", # Optional. Preferred zone availability.
},
},
},
"description": "A String", # A description of the preference set.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of the PreferenceSet.
"regionPreferences": { # The user preferences relating to target regions. # Optional. Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If unspecified, VirtualMachinePreferences.RegionPreferences is used.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"updateTime": "A String", # Output only. The timestamp when the preference set was last updated.
"virtualMachinePreferences": { # VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all virtual machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for operating systems. If unspecified, costs are calculated based on the default licensing plan. If os_pricing_preferences is specified, it overrides this field.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for Compute Engine. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server.
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters.
"estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100].
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. If PreferenceSet.RegionPreferences is specified, it overrides this field.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationCustomParameters": { # Custom data to use for sizing optimizations. # Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to "custom".
"aggregationMethod": "A String", # Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics.
"cpuUsagePercentage": 42, # Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value).
"memoryUsagePercentage": 42, # Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value).
"storageMultiplier": 3.14, # Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value).
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images.
"rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
"windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified.
"commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD).
"licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).
},
},
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine.
"allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
"protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering.
"storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available.
},
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"serviceType": "A String", # Optional. GCVE service type (fully licensed or portable license).
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
}
requestId: string, Optional. An optional 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, Required. Field mask is used to specify the fields to be overwritten in the `PreferenceSet` resource by the update. The values specified in the `update_mask` field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
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, successful response of the operation. 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>
|