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 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
|
<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="looker_v1.html">Looker (Google Cloud core) API</a> . <a href="looker_v1.projects.html">projects</a> . <a href="looker_v1.projects.locations.html">locations</a> . <a href="looker_v1.projects.locations.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="looker_v1.projects.locations.instances.backups.html">backups()</a></code>
</p>
<p class="firstline">Returns the backups 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, instanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Instance in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete instance.</p>
<p class="toc_element">
<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Export instance.</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 Instance.</p>
<p class="toc_element">
<code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Import instance.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Instances 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, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update Instance.</p>
<p class="toc_element">
<code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restart instance.</p>
<p class="toc_element">
<code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restore Looker instance.</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, instanceId=None, x__xgafv=None)</code>
<pre>Creates a new Instance in a given project and location.
Args:
parent: string, Required. Format: `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # A Looker instance.
"adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings.
"allowedEmailDomains": [ # Email domain allowlist for the instance.
"A String",
],
},
"classType": "A String", # Optional. Storage class of the instance.
"consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
"createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested.
"customDomain": { # Custom domain information. # Custom domain configuration for the instance.
"domain": "A String", # Domain name.
"state": "A String", # Domain state.
},
"denyMaintenancePeriod": { # Specifies the maintenance denial period. # Maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"egressPublicIp": "A String", # Output only. Public Egress IP (IPv4).
"encryptionConfig": { # Encryption configuration (i.e. CMEK). # Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
"kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
"kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
"kmsKeyState": "A String", # Output only. Status of the CMEK key.
},
"fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance.
"geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not.
"ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4).
"ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4).
"lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro.
"lookerUri": "A String", # Output only. Looker instance URI which can be used to access the Looker Instance UI.
"lookerVersion": "A String", # Output only. The Looker version that the instance is using.
"maintenanceSchedule": { # Published upcoming future maintenance schedule. # Maintenance schedule for this instance.
"endTime": "A String", # The scheduled end time for the maintenance.
"startTime": "A String", # The scheduled start time for the maintenance.
},
"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance.
"dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC).
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.
"oauthConfig": { # Looker instance OAuth login settings. # Looker instance OAuth login settings.
"clientId": "A String", # Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
"clientSecret": "A String", # Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
},
"platformEdition": "A String", # Platform edition.
"privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance.
"pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true.
"allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}
"A String",
],
"lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment.
"serviceAttachments": [ # Optional. List of egress service attachment configurations.
{ # Service attachment configuration.
"connectionStatus": "A String", # Output only. Connection status.
"localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.
"localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.
"A String",
],
"targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
},
],
},
"pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.
"publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance.
"reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The state of the instance.
"updateTime": "A String", # Output only. The time when the Looker instance was last updated.
"userMetadata": { # Metadata about users for a Looker instance. # Optional. User metadata.
"additionalDeveloperUserCount": 42, # Optional. The number of additional developer users the instance owner has purchased.
"additionalStandardUserCount": 42, # Optional. The number of additional standard users the instance owner has purchased.
"additionalViewerUserCount": 42, # Optional. The number of additional viewer users the instance owner has purchased.
},
}
instanceId: string, Required. The unique instance identifier. Must contain only lowercase letters, numbers, or hyphens, with the first character a letter and the last a letter or a number. 63 characters maximum.
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, force=None, x__xgafv=None)</code>
<pre>Delete instance.
Args:
name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
force: boolean, Whether to force cascading delete.
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="export">export(name, body=None, x__xgafv=None)</code>
<pre>Export instance.
Args:
name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request options for exporting data of an Instance.
"encryptionConfig": { # Configuration for Encryption - e.g. CMEK. # Required. Encryption configuration (CMEK). For CMEK enabled instances it should be same as looker CMEK.
"kmsKeyName": "A String", # Required. Name of the CMEK key in KMS.
},
"gcsUri": "A String", # The path to the folder in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/folderName`.
}
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 details of a single Instance.
Args:
name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Looker instance.
"adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings.
"allowedEmailDomains": [ # Email domain allowlist for the instance.
"A String",
],
},
"classType": "A String", # Optional. Storage class of the instance.
"consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
"createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested.
"customDomain": { # Custom domain information. # Custom domain configuration for the instance.
"domain": "A String", # Domain name.
"state": "A String", # Domain state.
},
"denyMaintenancePeriod": { # Specifies the maintenance denial period. # Maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"egressPublicIp": "A String", # Output only. Public Egress IP (IPv4).
"encryptionConfig": { # Encryption configuration (i.e. CMEK). # Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
"kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
"kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
"kmsKeyState": "A String", # Output only. Status of the CMEK key.
},
"fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance.
"geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not.
"ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4).
"ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4).
"lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro.
"lookerUri": "A String", # Output only. Looker instance URI which can be used to access the Looker Instance UI.
"lookerVersion": "A String", # Output only. The Looker version that the instance is using.
"maintenanceSchedule": { # Published upcoming future maintenance schedule. # Maintenance schedule for this instance.
"endTime": "A String", # The scheduled end time for the maintenance.
"startTime": "A String", # The scheduled start time for the maintenance.
},
"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance.
"dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC).
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.
"oauthConfig": { # Looker instance OAuth login settings. # Looker instance OAuth login settings.
"clientId": "A String", # Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
"clientSecret": "A String", # Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
},
"platformEdition": "A String", # Platform edition.
"privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance.
"pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true.
"allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}
"A String",
],
"lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment.
"serviceAttachments": [ # Optional. List of egress service attachment configurations.
{ # Service attachment configuration.
"connectionStatus": "A String", # Output only. Connection status.
"localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.
"localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.
"A String",
],
"targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
},
],
},
"pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.
"publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance.
"reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The state of the instance.
"updateTime": "A String", # Output only. The time when the Looker instance was last updated.
"userMetadata": { # Metadata about users for a Looker instance. # Optional. User metadata.
"additionalDeveloperUserCount": 42, # Optional. The number of additional developer users the instance owner has purchased.
"additionalStandardUserCount": 42, # Optional. The number of additional standard users the instance owner has purchased.
"additionalViewerUserCount": 42, # Optional. The number of additional viewer users the instance owner has purchased.
},
}</pre>
</div>
<div class="method">
<code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
<pre>Import instance.
Args:
name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
body: object, The request body.
The object takes the form of:
{ # Requestion options for importing looker data to an Instance
"gcsUri": "A String", # Path to the import folder in Google Cloud Storage, in the form `gs://bucketName/folderName`.
}
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="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Instances in a given project and location.
Args:
parent: string, Required. Format: `projects/{project}/locations/{location}`. (required)
pageSize: integer, The maximum number of instances to return. If unspecified at most 256 will be returned. The maximum possible value is 2048.
pageToken: string, A page token received from a previous ListInstancesRequest.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from ListInstances.
"instances": [ # The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize.
{ # A Looker instance.
"adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings.
"allowedEmailDomains": [ # Email domain allowlist for the instance.
"A String",
],
},
"classType": "A String", # Optional. Storage class of the instance.
"consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
"createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested.
"customDomain": { # Custom domain information. # Custom domain configuration for the instance.
"domain": "A String", # Domain name.
"state": "A String", # Domain state.
},
"denyMaintenancePeriod": { # Specifies the maintenance denial period. # Maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"egressPublicIp": "A String", # Output only. Public Egress IP (IPv4).
"encryptionConfig": { # Encryption configuration (i.e. CMEK). # Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
"kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
"kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
"kmsKeyState": "A String", # Output only. Status of the CMEK key.
},
"fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance.
"geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not.
"ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4).
"ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4).
"lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro.
"lookerUri": "A String", # Output only. Looker instance URI which can be used to access the Looker Instance UI.
"lookerVersion": "A String", # Output only. The Looker version that the instance is using.
"maintenanceSchedule": { # Published upcoming future maintenance schedule. # Maintenance schedule for this instance.
"endTime": "A String", # The scheduled end time for the maintenance.
"startTime": "A String", # The scheduled start time for the maintenance.
},
"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance.
"dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC).
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.
"oauthConfig": { # Looker instance OAuth login settings. # Looker instance OAuth login settings.
"clientId": "A String", # Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
"clientSecret": "A String", # Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
},
"platformEdition": "A String", # Platform edition.
"privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance.
"pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true.
"allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}
"A String",
],
"lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment.
"serviceAttachments": [ # Optional. List of egress service attachment configurations.
{ # Service attachment configuration.
"connectionStatus": "A String", # Output only. Connection status.
"localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.
"localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.
"A String",
],
"targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
},
],
},
"pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.
"publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance.
"reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The state of the instance.
"updateTime": "A String", # Output only. The time when the Looker instance was last updated.
"userMetadata": { # Metadata about users for a Looker instance. # Optional. User metadata.
"additionalDeveloperUserCount": 42, # Optional. The number of additional developer users the instance owner has purchased.
"additionalStandardUserCount": 42, # Optional. The number of additional standard users the instance owner has purchased.
"additionalViewerUserCount": 42, # Optional. The number of additional viewer users the instance owner has purchased.
},
},
],
"nextPageToken": "A String", # If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted.
"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, updateMask=None, x__xgafv=None)</code>
<pre>Update Instance.
Args:
name: string, Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
body: object, The request body.
The object takes the form of:
{ # A Looker instance.
"adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings.
"allowedEmailDomains": [ # Email domain allowlist for the instance.
"A String",
],
},
"classType": "A String", # Optional. Storage class of the instance.
"consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
"createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested.
"customDomain": { # Custom domain information. # Custom domain configuration for the instance.
"domain": "A String", # Domain name.
"state": "A String", # Domain state.
},
"denyMaintenancePeriod": { # Specifies the maintenance denial period. # Maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"egressPublicIp": "A String", # Output only. Public Egress IP (IPv4).
"encryptionConfig": { # Encryption configuration (i.e. CMEK). # Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
"kmsKeyName": "A String", # Name of the CMEK key in KMS (input parameter).
"kmsKeyNameVersion": "A String", # Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.
"kmsKeyState": "A String", # Output only. Status of the CMEK key.
},
"fipsEnabled": True or False, # Optional. Whether FIPS is enabled on the Looker instance.
"geminiEnabled": True or False, # Optional. Whether Gemini feature is enabled on the Looker instance or not.
"ingressPrivateIp": "A String", # Output only. Private Ingress IP (IPv4).
"ingressPublicIp": "A String", # Output only. Public Ingress IP (IPv4).
"lastDenyMaintenancePeriod": { # Specifies the maintenance denial period. # Output only. Last computed maintenance denial period for this instance.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. End date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts and ends.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"linkedLspProjectNumber": "A String", # Optional. Linked Google Cloud Project Number for Looker Studio Pro.
"lookerUri": "A String", # Output only. Looker instance URI which can be used to access the Looker Instance UI.
"lookerVersion": "A String", # Output only. The Looker version that the instance is using.
"maintenanceSchedule": { # Published upcoming future maintenance schedule. # Maintenance schedule for this instance.
"endTime": "A String", # The scheduled end time for the maintenance.
"startTime": "A String", # The scheduled start time for the maintenance.
},
"maintenanceWindow": { # Specifies the recurring maintenance window. # Maintenance window for this instance.
"dayOfWeek": "A String", # Required. Day of the week for this MaintenanceWindow (in UTC).
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"name": "A String", # Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.
"oauthConfig": { # Looker instance OAuth login settings. # Looker instance OAuth login settings.
"clientId": "A String", # Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
"clientSecret": "A String", # Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.
},
"platformEdition": "A String", # Platform edition.
"privateIpEnabled": True or False, # Whether private IP is enabled on the Looker instance.
"pscConfig": { # Information for Private Service Connect (PSC) setup for a Looker instance. # Optional. PSC configuration. Used when `psc_enabled` is true.
"allowedVpcs": [ # Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}
"A String",
],
"lookerServiceAttachmentUri": "A String", # Output only. URI of the Looker service attachment.
"serviceAttachments": [ # Optional. List of egress service attachment configurations.
{ # Service attachment configuration.
"connectionStatus": "A String", # Output only. Connection status.
"localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.
"localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.
"A String",
],
"targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
},
],
},
"pscEnabled": True or False, # Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.
"publicIpEnabled": True or False, # Whether public IP is enabled on the Looker instance.
"reservedRange": "A String", # Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The state of the instance.
"updateTime": "A String", # Output only. The time when the Looker instance was last updated.
"userMetadata": { # Metadata about users for a Looker instance. # Optional. User metadata.
"additionalDeveloperUserCount": 42, # Optional. The number of additional developer users the instance owner has purchased.
"additionalStandardUserCount": 42, # Optional. The number of additional standard users the instance owner has purchased.
"additionalViewerUserCount": 42, # Optional. The number of additional viewer users the instance owner has purchased.
},
}
updateMask: string, Required. Field mask used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
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="restart">restart(name, body=None, x__xgafv=None)</code>
<pre>Restart instance.
Args:
name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request options for restarting an instance.
}
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="restore">restore(name, body=None, x__xgafv=None)</code>
<pre>Restore Looker instance.
Args:
name: string, Required. Instance being restored Format: projects/{project}/locations/{location}/instances/{instance} (required)
body: object, The request body.
The object takes the form of:
{ # Request options for restoring an instance
"backup": "A String", # Required. Backup being used to restore the instance Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}
}
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>
|