- Resource: Instance
- State
- PlatformEdition
- PscConfig
- ServiceAttachment
- ConnectionStatus
- MaintenanceWindow
- DayOfWeek
- TimeOfDay
- DenyMaintenancePeriod
- Date
- MaintenanceSchedule
- UserMetadata
- CustomDomain
- CustomDomainState
- EncryptionConfig
- KmsKeyState
- AdminSettings
- OAuthConfig
- Methods
Resource: Instance
A Looker instance.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. Format: |
createTime |
Output only. The time when the Looker instance provisioning was first requested. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time when the Looker instance was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The state of the instance. |
platformEdition |
Platform edition. |
publicIpEnabled |
Whether public IP is enabled on the Looker instance. |
privateIpEnabled |
Whether private IP is enabled on the Looker instance. |
lookerVersion |
Output only. The Looker version that the instance is using. |
egressPublicIp |
Output only. Public Egress IP (IPv4). |
ingressPrivateIp |
Output only. Private Ingress IP (IPv4). |
ingressPublicIp |
Output only. Public Ingress IP (IPv4). |
lookerUri |
Output only. Looker instance URI which can be used to access the Looker Instance UI. |
pscEnabled |
Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither |
pscConfig |
Optional. PSC configuration. Used when |
consumerNetwork |
Network name in the consumer project. Format: |
reservedRange |
Name of a reserved IP address range within the |
maintenanceWindow |
Maintenance window for this instance. |
denyMaintenancePeriod |
Maintenance denial period for this instance. |
lastDenyMaintenancePeriod |
Output only. Last computed maintenance denial period for this instance. |
maintenanceSchedule |
Maintenance schedule for this instance. |
userMetadata |
User metadata. |
customDomain |
|
encryptionConfig |
Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance. |
adminSettings |
Looker Instance Admin settings. |
oauthConfig |
Looker instance OAuth login settings. |
linkedLspProjectNumber |
Optional. Linked Google Cloud Project Number for Looker Studio Pro. |
fipsEnabled |
Optional. Whether FIPS is enabled on the Looker instance. |
geminiEnabled |
Optional. Whether Gemini feature is enabled on the Looker instance or not. |
State
Possible states for a Looker instance.
Enums | |
---|---|
STATE_UNSPECIFIED |
State is unspecified. |
ACTIVE |
Instance is active and ready for use. |
CREATING |
Instance provisioning is in progress. |
FAILED |
Instance is in a failed state. |
SUSPENDED |
Instance was suspended. |
UPDATING |
Instance update is in progress. |
DELETING |
Instance delete is in progress. |
EXPORTING |
Instance is being exported. |
IMPORTING |
Instance is importing data. |
PlatformEdition
Platform editions for a Looker instance. Each edition maps to a set of instance features.
Enums | |
---|---|
PLATFORM_EDITION_UNSPECIFIED |
Platform edition is unspecified. |
LOOKER_CORE_TRIAL |
Trial. |
LOOKER_CORE_STANDARD |
Standard. |
LOOKER_CORE_STANDARD_ANNUAL |
Subscription Standard. |
LOOKER_CORE_ENTERPRISE_ANNUAL |
Subscription Enterprise. |
LOOKER_CORE_EMBED_ANNUAL |
Subscription Embed. |
PscConfig
Information for Private Service Connect (PSC) setup for a Looker instance.
JSON representation |
---|
{
"allowedVpcs": [
string
],
"serviceAttachments": [
{
object ( |
Fields | |
---|---|
allowedVpcs[] |
Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network} |
serviceAttachments[] |
Optional. List of egress service attachment configurations. |
lookerServiceAttachmentUri |
Output only. URI of the Looker service attachment. |
ServiceAttachment
Service attachment configuration.
JSON representation |
---|
{
"localFqdn": string,
"targetServiceAttachmentUri": string,
"connectionStatus": enum ( |
Fields | |
---|---|
localFqdn |
Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. |
targetServiceAttachmentUri |
Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} |
connectionStatus |
Output only. Connection status. |
ConnectionStatus
Status of the service attachment connection. Referencing https://cloud.google.com/vpc/docs/about-accessing-vpc-hosted-services-endpoints#connection-statuses
Enums | |
---|---|
UNKNOWN |
Connection status is unspecified. |
ACCEPTED |
Connection is established and functioning normally. |
PENDING |
Connection is not established (Looker tenant project hasn't been allowlisted). |
REJECTED |
Connection is not established (Looker tenant project is explicitly in reject list). |
NEEDS_ATTENTION |
Issue with target service attachment, e.g. NAT subnet is exhausted. |
CLOSED |
Target service attachment does not exist. This status is a terminal state. |
MaintenanceWindow
Specifies the recurring maintenance window.
JSON representation |
---|
{ "dayOfWeek": enum ( |
Fields | |
---|---|
dayOfWeek |
Required. Day of the week for this MaintenanceWindow (in UTC). |
startTime |
Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes. |
DayOfWeek
Represents a day of the week.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
The day of the week is unspecified. |
MONDAY |
Monday |
TUESDAY |
Tuesday |
WEDNESDAY |
Wednesday |
THURSDAY |
Thursday |
FRIDAY |
Friday |
SATURDAY |
Saturday |
SUNDAY |
Sunday |
TimeOfDay
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
.
JSON representation |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Fields | |
---|---|
hours |
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Minutes of hour of day. Must be from 0 to 59. |
seconds |
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
DenyMaintenancePeriod
Specifies the maintenance denial period.
JSON representation |
---|
{ "startDate": { object ( |
Fields | |
---|---|
startDate |
Required. Start date of the deny maintenance period. |
endDate |
Required. End date of the deny maintenance period. |
time |
Required. Time in UTC when the period starts and ends. |
Date
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
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer } |
Fields | |
---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
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. |
MaintenanceSchedule
Published upcoming future maintenance schedule.
JSON representation |
---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
The scheduled start time for the maintenance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The scheduled end time for the maintenance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
UserMetadata
Metadata about users for a Looker instance.
JSON representation |
---|
{ "additionalViewerUserCount": integer, "additionalStandardUserCount": integer, "additionalDeveloperUserCount": integer } |
Fields | |
---|---|
additionalViewerUserCount |
Optional. The number of additional viewer users the instance owner has purchased. |
additionalStandardUserCount |
Optional. The number of additional standard users the instance owner has purchased. |
additionalDeveloperUserCount |
Optional. The number of additional developer users the instance owner has purchased. |
CustomDomain
Custom domain information.
JSON representation |
---|
{
"domain": string,
"state": enum ( |
Fields | |
---|---|
domain |
Domain name. |
state |
Domain state. |
CustomDomainState
Enum for Custom Domain State.
Enums | |
---|---|
CUSTOM_DOMAIN_STATE_UNSPECIFIED |
Unspecified state. |
UNVERIFIED |
DNS record is not created. |
VERIFIED |
DNS record is created. |
MODIFYING |
Calling SLM to update. |
AVAILABLE |
ManagedCertificate is ready. |
UNAVAILABLE |
ManagedCertificate is not ready. |
UNKNOWN |
Status is not known. |
EncryptionConfig
Encryption configuration (i.e. CMEK).
JSON representation |
---|
{
"kmsKeyName": string,
"kmsKeyState": enum ( |
Fields | |
---|---|
kmsKeyName |
Name of the CMEK key in KMS (input parameter). |
kmsKeyState |
Output only. Status of the CMEK key. |
kmsKeyNameVersion |
Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: |
KmsKeyState
Enum for CMEK state.
Enums | |
---|---|
KMS_KEY_STATE_UNSPECIFIED |
CMEK status not specified. |
VALID |
CMEK key is currently valid. |
REVOKED |
CMEK key is currently revoked (instance should in restricted mode). |
AdminSettings
Looker instance Admin settings fields.
JSON representation |
---|
{ "allowedEmailDomains": [ string ] } |
Fields | |
---|---|
allowedEmailDomains[] |
Email domain allowlist for the instance. |
OAuthConfig
Looker instance OAuth login settings.
JSON representation |
---|
{ "clientId": string, "clientSecret": string } |
Fields | |
---|---|
clientId |
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 |
Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses. |
Methods |
|
---|---|
|
Creates a new Instance in a given project and location. |
|
Delete instance. |
|
Export instance. |
|
Gets details of a single Instance. |
|
Gets the access control policy for a resource. |
|
Import instance. |
|
Lists Instances in a given project and location. |
|
Update Instance. |
|
Restart instance. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |