instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	google.looker.instances

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Format: projects/{project}/locations/{location}/instances/{instance}.
adminSettings	object	Looker Instance Admin settings. (id: AdminSettings)
classType	string	Optional. Storage class of the instance.
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.
createTime	string (google-datetime)	Output only. The time when the Looker instance provisioning was first requested.
customDomain	object	Custom domain configuration for the instance. (id: CustomDomain)
denyMaintenancePeriod	object	Maintenance denial period for this instance. (id: DenyMaintenancePeriod)
egressPublicIp	string	Output only. Public Egress IP (IPv4).
encryptionConfig	object	Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance. (id: EncryptionConfig)
fipsEnabled	boolean	Optional. Whether FIPS is enabled on the Looker instance.
geminiEnabled	boolean	Optional. Whether Gemini feature is enabled on the Looker instance or not.
ingressPrivateIp	string	Output only. Private Ingress IP (IPv4).
ingressPublicIp	string	Output only. Public Ingress IP (IPv4).
lastDenyMaintenancePeriod	object	Output only. Last computed maintenance denial period for this instance. (id: DenyMaintenancePeriod)
linkedLspProjectNumber	string (int64)	Optional. Linked Google Cloud Project Number for Looker Studio Pro.
lookerUri	string	Output only. Looker instance URI which can be used to access the Looker Instance UI.
lookerVersion	string	Output only. The Looker version that the instance is using.
maintenanceSchedule	object	Maintenance schedule for this instance. (id: MaintenanceSchedule)
maintenanceWindow	object	Maintenance window for this instance. (id: MaintenanceWindow)
oauthConfig	object	Looker instance OAuth login settings. (id: OAuthConfig)
platformEdition	string	Platform edition.
privateIpEnabled	boolean	Whether private IP is enabled on the Looker instance.
pscConfig	object	Optional. PSC configuration. Used when psc_enabled is true. (id: PscConfig)
pscEnabled	boolean	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	boolean	Whether public IP is enabled on 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.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the instance.
updateTime	string (google-datetime)	Output only. The time when the Looker instance was last updated.
userMetadata	object	Optional. User metadata. (id: UserMetadata)

list

Successful response

Name	Datatype	Description
name	string	Output only. Format: projects/{project}/locations/{location}/instances/{instance}.
adminSettings	object	Looker Instance Admin settings. (id: AdminSettings)
classType	string	Optional. Storage class of the instance.
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.
createTime	string (google-datetime)	Output only. The time when the Looker instance provisioning was first requested.
customDomain	object	Custom domain configuration for the instance. (id: CustomDomain)
denyMaintenancePeriod	object	Maintenance denial period for this instance. (id: DenyMaintenancePeriod)
egressPublicIp	string	Output only. Public Egress IP (IPv4).
encryptionConfig	object	Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance. (id: EncryptionConfig)
fipsEnabled	boolean	Optional. Whether FIPS is enabled on the Looker instance.
geminiEnabled	boolean	Optional. Whether Gemini feature is enabled on the Looker instance or not.
ingressPrivateIp	string	Output only. Private Ingress IP (IPv4).
ingressPublicIp	string	Output only. Public Ingress IP (IPv4).
lastDenyMaintenancePeriod	object	Output only. Last computed maintenance denial period for this instance. (id: DenyMaintenancePeriod)
linkedLspProjectNumber	string (int64)	Optional. Linked Google Cloud Project Number for Looker Studio Pro.
lookerUri	string	Output only. Looker instance URI which can be used to access the Looker Instance UI.
lookerVersion	string	Output only. The Looker version that the instance is using.
maintenanceSchedule	object	Maintenance schedule for this instance. (id: MaintenanceSchedule)
maintenanceWindow	object	Maintenance window for this instance. (id: MaintenanceWindow)
oauthConfig	object	Looker instance OAuth login settings. (id: OAuthConfig)
platformEdition	string	Platform edition.
privateIpEnabled	boolean	Whether private IP is enabled on the Looker instance.
pscConfig	object	Optional. PSC configuration. Used when psc_enabled is true. (id: PscConfig)
pscEnabled	boolean	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	boolean	Whether public IP is enabled on 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.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the instance.
updateTime	string (google-datetime)	Output only. The time when the Looker instance was last updated.
userMetadata	object	Optional. User metadata. (id: UserMetadata)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, instancesId		Gets details of a single Instance.
list	select	projectsId, locationsId	pageSize, pageToken	Lists Instances in a given project and location.
create	insert	projectsId, locationsId	instanceId	Creates a new Instance in a given project and location.
patch	update	projectsId, locationsId, instancesId	updateMask	Update Instance.
delete	delete	projectsId, locationsId, instancesId	force	Delete instance.
restart	exec	projectsId, locationsId, instancesId		Restart instance.
restore	exec	projectsId, locationsId, instancesId		Restore Looker instance.
import	exec	projectsId, locationsId, instancesId		Import instance.
export	exec	projectsId, locationsId, instancesId		Export instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancesId	string
locationsId	string
projectsId	string
force	boolean
instanceId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Instance.

SELECT
name,
adminSettings,
classType,
consumerNetwork,
createTime,
customDomain,
denyMaintenancePeriod,
egressPublicIp,
encryptionConfig,
fipsEnabled,
geminiEnabled,
ingressPrivateIp,
ingressPublicIp,
lastDenyMaintenancePeriod,
linkedLspProjectNumber,
lookerUri,
lookerVersion,
maintenanceSchedule,
maintenanceWindow,
oauthConfig,
platformEdition,
privateIpEnabled,
pscConfig,
pscEnabled,
publicIpEnabled,
reservedRange,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
userMetadata
FROM google.looker.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

list

Lists Instances in a given project and location.

SELECT
name,
adminSettings,
classType,
consumerNetwork,
createTime,
customDomain,
denyMaintenancePeriod,
egressPublicIp,
encryptionConfig,
fipsEnabled,
geminiEnabled,
ingressPrivateIp,
ingressPublicIp,
lastDenyMaintenancePeriod,
linkedLspProjectNumber,
lookerUri,
lookerVersion,
maintenanceSchedule,
maintenanceWindow,
oauthConfig,
platformEdition,
privateIpEnabled,
pscConfig,
pscEnabled,
publicIpEnabled,
reservedRange,
satisfiesPzi,
satisfiesPzs,
state,
updateTime,
userMetadata
FROM google.looker.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new Instance in a given project and location.

INSERT INTO google.looker.instances (
data__platformEdition,
data__publicIpEnabled,
data__privateIpEnabled,
data__pscEnabled,
data__pscConfig,
data__consumerNetwork,
data__reservedRange,
data__maintenanceWindow,
data__denyMaintenancePeriod,
data__maintenanceSchedule,
data__userMetadata,
data__customDomain,
data__encryptionConfig,
data__adminSettings,
data__oauthConfig,
data__linkedLspProjectNumber,
data__fipsEnabled,
data__geminiEnabled,
data__classType,
projectsId,
locationsId,
instanceId
)
SELECT 
'{{ platformEdition }}',
{{ publicIpEnabled }},
{{ privateIpEnabled }},
{{ pscEnabled }},
'{{ pscConfig }}',
'{{ consumerNetwork }}',
'{{ reservedRange }}',
'{{ maintenanceWindow }}',
'{{ denyMaintenancePeriod }}',
'{{ maintenanceSchedule }}',
'{{ userMetadata }}',
'{{ customDomain }}',
'{{ encryptionConfig }}',
'{{ adminSettings }}',
'{{ oauthConfig }}',
'{{ linkedLspProjectNumber }}',
{{ fipsEnabled }},
{{ geminiEnabled }},
'{{ classType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the instances resource.
    - name: platformEdition
      value: string
      description: >
        Platform edition.
        
      valid_values: ['PLATFORM_EDITION_UNSPECIFIED', 'LOOKER_CORE_TRIAL', 'LOOKER_CORE_STANDARD', 'LOOKER_CORE_STANDARD_ANNUAL', 'LOOKER_CORE_ENTERPRISE_ANNUAL', 'LOOKER_CORE_EMBED_ANNUAL', 'LOOKER_CORE_NONPROD_STANDARD_ANNUAL', 'LOOKER_CORE_NONPROD_ENTERPRISE_ANNUAL', 'LOOKER_CORE_NONPROD_EMBED_ANNUAL', 'LOOKER_CORE_TRIAL_STANDARD', 'LOOKER_CORE_TRIAL_ENTERPRISE', 'LOOKER_CORE_TRIAL_EMBED']
    - name: publicIpEnabled
      value: boolean
      description: >
        Whether public IP is enabled on the Looker instance.
        
    - name: privateIpEnabled
      value: boolean
      description: >
        Whether private IP is enabled on the Looker instance.
        
    - name: pscEnabled
      value: boolean
      description: >
        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.
        
    - name: pscConfig
      value: object
      description: >
        Optional. PSC configuration. Used when `psc_enabled` is true.
        
    - name: consumerNetwork
      value: string
      description: >
        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.
        
    - name: reservedRange
      value: string
      description: >
        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.
        
    - name: maintenanceWindow
      value: object
      description: >
        Maintenance window for this instance.
        
    - name: denyMaintenancePeriod
      value: object
      description: >
        Maintenance denial period for this instance.
        
    - name: maintenanceSchedule
      value: object
      description: >
        Maintenance schedule for this instance.
        
    - name: userMetadata
      value: object
      description: >
        Optional. User metadata.
        
    - name: customDomain
      value: object
      description: >
        Custom domain configuration for the instance.
        
    - name: encryptionConfig
      value: object
      description: >
        Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.
        
    - name: adminSettings
      value: object
      description: >
        Looker Instance Admin settings.
        
    - name: oauthConfig
      value: object
      description: >
        Looker instance OAuth login settings.
        
    - name: linkedLspProjectNumber
      value: string
      description: >
        Optional. Linked Google Cloud Project Number for Looker Studio Pro.
        
    - name: fipsEnabled
      value: boolean
      description: >
        Optional. Whether FIPS is enabled on the Looker instance.
        
    - name: geminiEnabled
      value: boolean
      description: >
        Optional. Whether Gemini feature is enabled on the Looker instance or not.
        
    - name: classType
      value: string
      description: >
        Optional. Storage class of the instance.
        
      valid_values: ['CLASS_TYPE_UNSPECIFIED', 'R1', 'P1']
    - name: instanceId
      value: string

UPDATE examples

patch

Update Instance.

UPDATE google.looker.instances
SET 
data__platformEdition = '{{ platformEdition }}',
data__publicIpEnabled = {{ publicIpEnabled }},
data__privateIpEnabled = {{ privateIpEnabled }},
data__pscEnabled = {{ pscEnabled }},
data__pscConfig = '{{ pscConfig }}',
data__consumerNetwork = '{{ consumerNetwork }}',
data__reservedRange = '{{ reservedRange }}',
data__maintenanceWindow = '{{ maintenanceWindow }}',
data__denyMaintenancePeriod = '{{ denyMaintenancePeriod }}',
data__maintenanceSchedule = '{{ maintenanceSchedule }}',
data__userMetadata = '{{ userMetadata }}',
data__customDomain = '{{ customDomain }}',
data__encryptionConfig = '{{ encryptionConfig }}',
data__adminSettings = '{{ adminSettings }}',
data__oauthConfig = '{{ oauthConfig }}',
data__linkedLspProjectNumber = '{{ linkedLspProjectNumber }}',
data__fipsEnabled = {{ fipsEnabled }},
data__geminiEnabled = {{ geminiEnabled }},
data__classType = '{{ classType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete instance.

DELETE FROM google.looker.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND force = '{{ force }}';

Lifecycle Methods

restart

Restart instance.

EXEC google.looker.instances.restart 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required;

restore

Restore Looker instance.

EXEC google.looker.instances.restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"backup": "{{ backup }}"
}';

import

Import instance.

EXEC google.looker.instances.import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"gcsUri": "{{ gcsUri }}"
}';

export

Export instance.

EXEC google.looker.instances.export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"gcsUri": "{{ gcsUri }}", 
"encryptionConfig": "{{ encryptionConfig }}"
}';