REST Resource: projects.locations.instances

Resource: Instance

A Looker instance.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "platformEdition": enum (PlatformEdition),
  "publicIpEnabled": boolean,
  "privateIpEnabled": boolean,
  "lookerVersion": string,
  "egressPublicIp": string,
  "ingressPrivateIp": string,
  "ingressPublicIp": string,
  "lookerUri": string,
  "consumerNetwork": string,
  "reservedRange": string,
  "maintenanceWindow": {
    object (MaintenanceWindow)
  },
  "denyMaintenancePeriod": {
    object (DenyMaintenancePeriod)
  },
  "lastDenyMaintenancePeriod": {
    object (DenyMaintenancePeriod)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "userMetadata": {
    object (UserMetadata)
  },
  "customDomain": {
    object (CustomDomain)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "adminSettings": {
    object (AdminSettings)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "linkedLspProjectNumber": string
}
Fields
name

string

Output only. Format: projects/{project}/locations/{location}/instances/{instance}.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The state of the instance.
platformEdition

enum (PlatformEdition)

Platform edition.
publicIpEnabled

boolean

Whether public IP is enabled on the Looker instance.
privateIpEnabled

boolean

Whether private IP is enabled on the Looker instance.
lookerVersion

string

Output only. The Looker version that the instance is using.
egressPublicIp

string

Output only. Public Egress IP (IPv4).
ingressPrivateIp

string

Output only. Private Ingress IP (IPv4).
ingressPublicIp

string

Output only. Public Ingress IP (IPv4).
lookerUri

string

Output only. Looker instance URI which can be used to access the Looker Instance UI.
consumerNetwork

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.
reservedRange

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.
maintenanceWindow

object (MaintenanceWindow)

Maintenance window for this instance.
denyMaintenancePeriod

object (DenyMaintenancePeriod)

Maintenance denial period for this instance.
lastDenyMaintenancePeriod

object (DenyMaintenancePeriod)

Output only. Last computed maintenance denial period for this instance.
maintenanceSchedule

object (MaintenanceSchedule)

Maintenance schedule for this instance.
userMetadata

object (UserMetadata)

User metadata.
customDomain

object (CustomDomain)
encryptionConfig

object (EncryptionConfig)

Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
adminSettings

object (AdminSettings)

Looker Instance Admin settings.
oauthConfig

object (OAuthConfig)

Looker instance OAuth login settings.
linkedLspProjectNumber

string (int64 format)

Optional. Linked Google Cloud Project Number for Looker Studio Pro.

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.

MaintenanceWindow

Specifies the recurring maintenance window.

JSON representation 
{
  "dayOfWeek": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Fields
dayOfWeek

enum (DayOfWeek)

Required. Day of the week for this MaintenanceWindow (in UTC).
startTime

object (TimeOfDay)

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

integer

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

integer

Minutes of hour of day. Must be from 0 to 59.
seconds

integer

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

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

DenyMaintenancePeriod

Specifies the maintenance denial period.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
Fields
startDate

object (Date)

Required. Start date of the deny maintenance period.
endDate

object (Date)

Required. End date of the deny maintenance period.
time

object (TimeOfDay)

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:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

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

string (Timestamp format)

The scheduled start time for the maintenance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

The scheduled end time for the maintenance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

UserMetadata

Metadata about users for a Looker instance.

JSON representation 
{
  "additionalViewerUserCount": integer,
  "additionalStandardUserCount": integer,
  "additionalDeveloperUserCount": integer
}
Fields
additionalViewerUserCount

integer

Optional. The number of additional viewer users the instance owner has purchased.
additionalStandardUserCount

integer

Optional. The number of additional standard users the instance owner has purchased.
additionalDeveloperUserCount

integer

Optional. The number of additional developer users the instance owner has purchased.

CustomDomain

Custom domain information.

JSON representation 
{
  "domain": string,
  "state": enum (CustomDomainState)
}
Fields
domain

string

Domain name.
state

enum (CustomDomainState)

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 (KmsKeyState),
  "kmsKeyNameVersion": string
}
Fields
kmsKeyName

string

Name of the CMEK key in KMS (input parameter).
kmsKeyState

enum (KmsKeyState)

Output only. Status of the CMEK key.
kmsKeyNameVersion

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

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[]

string

Email domain allowlist for the instance.

OAuthConfig

Looker instance OAuth login settings.

JSON representation 
{
  "clientId": string,
  "clientSecret": string
}
Fields
clientId

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

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.

Methods

create

 Creates a new Instance in a given project and location.

delete

 Delete instance.

export

 Export instance.

get

 Gets details of a single Instance.

getIamPolicy

 Gets the access control policy for a resource.

import

 Import instance.

list

 Lists Instances in a given project and location.

patch

 Update Instance.

restart

 Restart instance.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.