{ "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/", "id": "looker:v1", "canonicalName": "Looker", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "baseUrl": "https://looker.googleapis.com/", "ownerDomain": "google.com", "parameters": { "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "location": "query", "description": "V1 error format.", "type": "string", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "alt": { "default": "json", "location": "query", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "enum": [ "json", "media", "proto" ] }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." } }, "schemas": { "EncryptionConfig": { "description": "Encryption configuration (i.e. CMEK).", "id": "EncryptionConfig", "type": "object", "properties": { "kmsKeyName": { "description": "Name of the CMEK key in KMS (input parameter).", "type": "string" }, "kmsKeyNameVersion": { "type": "string", "description": "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.", "readOnly": true }, "kmsKeyState": { "description": "Output only. Status of the CMEK key.", "type": "string", "enum": [ "KMS_KEY_STATE_UNSPECIFIED", "VALID", "REVOKED" ], "enumDescriptions": [ "CMEK status not specified.", "CMEK key is currently valid.", "CMEK key is currently revoked (instance should in restricted mode)." ], "readOnly": true } } }, "IngressIpAllowlistRule": { "type": "object", "properties": { "description": { "description": "Optional. Description for the IP range.", "type": "string" }, "ipRange": { "description": "Optional. The IP range to allow ingress traffic from.", "type": "string" } }, "description": "Ingress IP allowlist rule.", "id": "IngressIpAllowlistRule" }, "ServiceAttachment": { "description": "Service attachment configuration.", "id": "ServiceAttachment", "type": "object", "properties": { "localFqdns": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment." }, "failureReason": { "description": "Output only. Reason the service attachment creation failed. This value will only be populated if the service attachment encounters an issue during provisioning.", "readOnly": true, "type": "string" }, "connectionStatus": { "type": "string", "enum": [ "UNKNOWN", "ACCEPTED", "PENDING", "REJECTED", "NEEDS_ATTENTION", "CLOSED" ], "enumDescriptions": [ "Connection status is unspecified.", "Connection is established and functioning normally.", "Connection is not established (Looker tenant project hasn't been allowlisted).", "Connection is not established (Looker tenant project is explicitly in reject list).", "Issue with target service attachment, e.g. NAT subnet is exhausted.", "Target service attachment does not exist. This status is a terminal state." ], "description": "Output only. Connection status.", "readOnly": true }, "localFqdn": { "description": "Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", "type": "string" }, "targetServiceAttachmentUri": { "description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", "type": "string" } } }, "MaintenanceWindow": { "type": "object", "properties": { "dayOfWeek": { "description": "Required. Day of the week for this MaintenanceWindow (in UTC).", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "startTime": { "description": "Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.", "$ref": "TimeOfDay" } }, "description": "Specifies the recurring maintenance window.", "id": "MaintenanceWindow" }, "ExportInstanceRequest": { "id": "ExportInstanceRequest", "description": "Request options for exporting data of an Instance.", "properties": { "encryptionConfig": { "$ref": "ExportEncryptionConfig", "description": "Required. Encryption configuration (CMEK). For CMEK enabled instances it should be same as looker CMEK." }, "gcsUri": { "description": "The path to the folder in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/folderName`.", "type": "string" } }, "type": "object" }, "PeriodicExportConfig": { "id": "PeriodicExportConfig", "description": "Configuration for periodic export.", "properties": { "gcsUri": { "description": "Required. Cloud Storage bucket URI for periodic export. Format: gs://{bucket_name}", "type": "string" }, "kmsKey": { "description": "Required. Name of the CMEK key in KMS. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}", "type": "string" }, "startTime": { "description": "Required. Time in UTC to start the periodic export job.", "$ref": "TimeOfDay" } }, "type": "object" }, "Instance": { "description": "A Looker instance.", "id": "Instance", "type": "object", "properties": { "controlledEgressConfig": { "description": "Optional. Controlled egress configuration.", "$ref": "ControlledEgressConfig" }, "ingressPrivateIp": { "description": "Output only. Private Ingress IP (IPv4).", "readOnly": true, "type": "string" }, "fipsEnabled": { "description": "Optional. Whether FIPS is enabled on the Looker instance.", "type": "boolean" }, "egressPublicIp": { "type": "string", "description": "Output only. Public Egress IP (IPv4).", "readOnly": true }, "platformEdition": { "description": "Platform edition.", "type": "string", "enum": [ "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" ], "enumDescriptions": [ "Represents an unspecified platform edition.", "Represents the Looker Core Trial edition.", "Represents the Looker Core Standard edition.", "Represents the Looker Core Standard Annual edition.", "Represents the Looker Core Enterprise Annual edition.", "Represents the Looker Core Embed Annual edition.", "Represents the Looker Core Nonprod Standard Annual edition.", "Represents the Looker Core Nonprod Enterprise Annual edition.", "Represents the Looker Core Nonprod Embed Annual edition.", "Represents the Looker Core Trial Standard edition.", "Represents the Looker Core Trial Enterprise edition.", "Represents the Looker Core Trial Embed edition." ] }, "denyMaintenancePeriod": { "description": "Maintenance denial period for this instance.", "$ref": "DenyMaintenancePeriod" }, "periodicExportConfig": { "$ref": "PeriodicExportConfig", "description": "Optional. Configuration for periodic export." }, "adminSettings": { "$ref": "AdminSettings", "description": "Looker Instance Admin settings." }, "ingressPublicIp": { "type": "string", "description": "Output only. Public Ingress IP (IPv4).", "readOnly": true }, "acceleratedSecurityPatchEnabled": { "description": "Optional. Accelerated security patch enabled for the instance.", "type": "boolean" }, "name": { "type": "string", "description": "Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "readOnly": true }, "maintenanceSchedule": { "$ref": "MaintenanceSchedule", "description": "Maintenance schedule for this instance." }, "maintenanceWindow": { "$ref": "MaintenanceWindow", "description": "Maintenance window for this instance." }, "ingressIpAllowlistConfig": { "$ref": "IngressIpAllowlistConfig", "description": "Optional. Ingress IP allowlist configuration for the Looker instance." }, "lookerUri": { "description": "Output only. Looker instance URI which can be used to access the Looker Instance UI.", "readOnly": true, "type": "string" }, "suspendedTime": { "description": "Output only. The time when the Looker instance was suspended (soft deleted).", "readOnly": true, "format": "google-datetime", "type": "string" }, "geminiEnabled": { "description": "Optional. Whether Gemini feature is enabled on the Looker instance or not.", "type": "boolean" }, "linkedLspProjectNumber": { "type": "string", "description": "Optional. Linked Google Cloud Project Number for Looker Studio Pro.", "format": "int64" }, "privateIpEnabled": { "description": "Whether private IP is enabled on the Looker instance.", "type": "boolean" }, "controlledEgressEnabled": { "description": "Optional. Whether controlled egress is enabled on the Looker instance.", "type": "boolean" }, "consumerNetwork": { "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.", "type": "string" }, "catalogIntegrationOptOut": { "description": "Optional. Indicates whether catalog integration is disabled for the Looker instance.", "type": "boolean" }, "encryptionConfig": { "$ref": "EncryptionConfig", "description": "Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance." }, "releaseChannel": { "description": "Optional. The selected release channel for the instance.", "enumDescriptions": [ "Unspecified release channel.", "Rapid: Most frequent updates.", "Regular: Balanced, default for production.", "Stable: Least frequent, for maximum stability." ], "type": "string", "enum": [ "RELEASE_CHANNEL_UNSPECIFIED", "RAPID", "REGULAR", "STABLE" ] }, "classType": { "description": "Optional. Storage class of the instance.", "enumDescriptions": [ "Unspecified storage class.", "Filestore.", "PD SSD." ], "type": "string", "enum": [ "CLASS_TYPE_UNSPECIFIED", "R1", "P1" ] }, "customDomain": { "description": "Custom domain configuration for the instance.", "$ref": "CustomDomain" }, "oauthConfig": { "$ref": "OAuthConfig", "description": "Looker instance OAuth login settings." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "FAILED", "SUSPENDED", "UPDATING", "DELETING", "EXPORTING", "IMPORTING" ], "enumDescriptions": [ "State is unspecified.", "Instance is active and ready for use.", "Instance provisioning is in progress.", "Instance is in a failed state.", "Instance was suspended.", "Instance update is in progress.", "Instance delete is in progress.", "Instance is being exported.", "Instance is importing data." ], "description": "Output only. The state of the instance.", "readOnly": true }, "lookerVersion": { "type": "string", "description": "Output only. The Looker version that the instance is using.", "readOnly": true }, "reservedRange": { "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.", "type": "string" }, "createTime": { "description": "Output only. The time when the Looker instance provisioning was first requested.", "readOnly": true, "format": "google-datetime", "type": "string" }, "publicIpEnabled": { "description": "Whether public IP is enabled on the Looker instance.", "type": "boolean" }, "userMetadata": { "description": "Optional. User metadata.", "$ref": "UserMetadata" }, "pscEnabled": { "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.", "type": "boolean" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "lastDenyMaintenancePeriod": { "description": "Output only. Last computed maintenance denial period for this instance.", "readOnly": true, "$ref": "DenyMaintenancePeriod" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "updateTime": { "type": "string", "description": "Output only. The time when the Looker instance was last updated.", "readOnly": true, "format": "google-datetime" }, "pscConfig": { "$ref": "PscConfig", "description": "Optional. PSC configuration. Used when `psc_enabled` is true." }, "softDeleteReason": { "readOnly": true, "description": "Output only. The reason for the instance being in a soft-deleted state.", "type": "string", "enum": [ "SOFT_DELETE_REASON_UNSPECIFIED", "BILLING_ACCOUNT_ISSUE", "TRIAL_EXPIRED", "CUSTOMER_REQUEST" ], "enumDescriptions": [ "Soft delete reason is unspecified. This is the default value.", "Instance is soft deleted due to billing account issues.", "Instance is soft deleted due to trial expiration.", "Instance is soft deleted by the customer." ] } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "type": "array", "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object" }, "ListInstanceBackupsResponse": { "description": "Response from listing Looker instance backups.", "id": "ListInstanceBackupsResponse", "type": "object", "properties": { "nextPageToken": { "description": "If provided, a page token that can look up the next `page_size` results. If empty, the results list is exhausted.", "type": "string" }, "instanceBackups": { "description": "The list of instances matching the request filters, up to the requested `page_size`.", "type": "array", "items": { "$ref": "InstanceBackup" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } } }, "ListInstancesResponse": { "type": "object", "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "instances": { "description": "The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize.", "type": "array", "items": { "$ref": "Instance" } }, "nextPageToken": { "description": "If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted.", "type": "string" } }, "description": "Response from ListInstances.", "id": "ListInstancesResponse" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "AdminSettings": { "properties": { "allowedEmailDomains": { "type": "array", "items": { "type": "string" }, "description": "Email domain allowlist for the instance." } }, "type": "object", "id": "AdminSettings", "description": "Looker instance Admin settings fields." }, "IngressIpAllowlistConfig": { "id": "IngressIpAllowlistConfig", "description": "Ingress IP allowlist configuration.", "properties": { "enabled": { "description": "Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance.", "type": "boolean" }, "allowlistRules": { "type": "array", "items": { "$ref": "IngressIpAllowlistRule" }, "description": "Optional. List of IP range rules to allow ingress traffic." }, "googleServicesEnabled": { "description": "Optional. Whether google service connections are enabled for the instance.", "type": "boolean" } }, "type": "object" }, "ExportMetadataEncryptionKey": { "description": "Encryption key details for the exported artifact.", "id": "ExportMetadataEncryptionKey", "type": "object", "properties": { "cmek": { "description": "Name of the CMEK.", "type": "string" }, "version": { "description": "Version of the CMEK.", "type": "string" } } }, "OAuthConfig": { "type": "object", "properties": { "clientId": { "description": "Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.", "type": "string" }, "clientSecret": { "description": "Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.", "type": "string" }, "sharedOauthClientEnabled": { "description": "Optional. Whether to use the shared OAuth client. Instances specifying this field do not need to provide client_id and client_secret.", "type": "boolean" } }, "description": "Looker instance OAuth login settings.", "id": "OAuthConfig" }, "TimeOfDay": { "description": "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`.", "id": "TimeOfDay", "type": "object", "properties": { "hours": { "type": "integer", "description": "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.", "format": "int32" }, "seconds": { "description": "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.", "format": "int32", "type": "integer" }, "nanos": { "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32" }, "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" } } }, "InstanceBackup": { "properties": { "encryptionConfig": { "description": "Output only. Current status of the CMEK encryption", "readOnly": true, "$ref": "EncryptionConfig" }, "expireTime": { "type": "string", "description": "Output only. The time when the backup will be deleted.", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}`", "type": "string" }, "createTime": { "type": "string", "description": "Output only. The time when the backup was started.", "readOnly": true, "format": "google-datetime" }, "state": { "readOnly": true, "description": "Output only. The current state of the backup.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "DELETING", "ACTIVE", "FAILED" ], "enumDescriptions": [ "The state of the backup is unknown.", "The backup is being created.", "The backup is being deleted.", "The backup is active and ready to use.", "The backup failed." ] } }, "type": "object", "id": "InstanceBackup", "description": "The details of a backup resource." }, "RestoreInstanceRequest": { "id": "RestoreInstanceRequest", "description": "Request options for restoring an instance", "properties": { "backup": { "description": "Required. Backup being used to restore the instance Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}", "type": "string" } }, "type": "object" }, "ControlledEgressConfig": { "id": "ControlledEgressConfig", "description": "Controlled egress configuration.", "properties": { "marketplaceEnabled": { "description": "Optional. Whether marketplace is enabled.", "type": "boolean" }, "egressFqdns": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic." }, "webProxyIps": { "type": "array", "items": { "type": "string" }, "description": "Output only. The list of IP addresses used by Secure Web Proxy for outbound traffic.", "readOnly": true } }, "type": "object" }, "DenyMaintenancePeriod": { "properties": { "endDate": { "description": "Required. End date of the deny maintenance period.", "$ref": "Date" }, "startDate": { "$ref": "Date", "description": "Required. Start date of the deny maintenance period." }, "time": { "description": "Required. Time in UTC when the period starts and ends.", "$ref": "TimeOfDay" } }, "type": "object", "id": "DenyMaintenancePeriod", "description": "Specifies the maintenance denial period." }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "type": "object", "properties": {} }, "ExportEncryptionConfig": { "description": "Configuration for Encryption - e.g. CMEK.", "id": "ExportEncryptionConfig", "type": "object", "properties": { "kmsKeyName": { "description": "Required. Name of the CMEK key in KMS.", "type": "string" } } }, "Status": { "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "message": { "description": "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } }, "type": "object", "id": "Status", "description": "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)." }, "UndeleteInstanceRequest": { "properties": {}, "type": "object", "id": "UndeleteInstanceRequest", "description": "Request options for undeleting an instance." }, "UserMetadata": { "id": "UserMetadata", "description": "Metadata about users for a Looker instance.", "properties": { "additionalStandardUserCount": { "description": "Optional. The number of additional standard users the instance owner has purchased.", "format": "int32", "type": "integer" }, "additionalViewerUserCount": { "type": "integer", "description": "Optional. The number of additional viewer users the instance owner has purchased.", "format": "int32" }, "additionalDeveloperUserCount": { "type": "integer", "description": "Optional. The number of additional developer users the instance owner has purchased.", "format": "int32" } }, "type": "object" }, "ImportInstanceRequest": { "properties": { "gcsUri": { "description": "Path to the import folder in Google Cloud Storage, in the form `gs://bucketName/folderName`.", "type": "string" } }, "type": "object", "id": "ImportInstanceRequest", "description": "Requestion options for importing looker data to an Instance" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "type": "object", "properties": { "metadata": { "type": "object", "description": "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "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.", "type": "boolean" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "response": { "type": "object", "description": "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`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "description": "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}`.", "type": "string" } } }, "CustomDomain": { "id": "CustomDomain", "description": "Custom domain information.", "properties": { "domain": { "description": "Domain name.", "type": "string" }, "state": { "description": "Domain state.", "enumDescriptions": [ "Unspecified state.", "DNS record is not created.", "DNS record is created.", "Calling SLM to update.", "ManagedCertificate is ready.", "ManagedCertificate is not ready.", "Status is not known." ], "type": "string", "enum": [ "CUSTOM_DOMAIN_STATE_UNSPECIFIED", "UNVERIFIED", "VERIFIED", "MODIFYING", "AVAILABLE", "UNAVAILABLE", "UNKNOWN" ] } }, "type": "object" }, "ExportMetadata": { "type": "object", "properties": { "lookerPlatformEdition": { "description": "Platform edition of the exported instance.", "type": "string" }, "lookerInstance": { "description": "Name of the exported instance. Format: projects/{project}/locations/{location}/instances/{instance}", "type": "string" }, "exportEncryptionKey": { "$ref": "ExportMetadataEncryptionKey", "description": "Encryption key that was used to encrypt the export artifacts." }, "lookerVersion": { "description": "Version of instance when the export was created.", "type": "string" }, "lookerEncryptionKey": { "description": "Looker encryption key, encrypted with the provided export encryption key. This value will only be populated if the looker instance uses Looker managed encryption instead of CMEK.", "type": "string" }, "source": { "description": "The source type of the migration.", "type": "string", "enum": [ "SOURCE_UNSPECIFIED", "LOOKER_CORE", "LOOKER_ORIGINAL" ], "enumDescriptions": [ "Source not specified", "Source of export is Looker Core", "Source of export is Looker Original" ] }, "filePaths": { "type": "array", "items": { "type": "string" }, "description": "List of files created as part of export artifact (excluding the metadata). The paths are relative to the folder containing the metadata." } }, "description": "ExportMetadata represents the metadata of the exported artifacts. The metadata.json file in export artifact can be parsed as this message", "id": "ExportMetadata" }, "RestartInstanceRequest": { "properties": {}, "type": "object", "id": "RestartInstanceRequest", "description": "Request options for restarting an instance." }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "type": "object", "properties": {} }, "MaintenanceSchedule": { "type": "object", "properties": { "startTime": { "type": "string", "description": "The scheduled start time for the maintenance.", "format": "google-datetime" }, "endTime": { "description": "The scheduled end time for the maintenance.", "format": "google-datetime", "type": "string" } }, "description": "Published upcoming future maintenance schedule.", "id": "MaintenanceSchedule" }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", "type": "object", "properties": { "apiVersion": { "description": "API version used to start the operation.", "type": "string" }, "createTime": { "type": "string", "description": "The time the operation was created.", "format": "google-datetime" }, "verb": { "description": "Name of the verb executed by the operation.", "type": "string" }, "statusMessage": { "description": "Human-readable status of the operation, if any.", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", "type": "string" }, "target": { "description": "Server-defined resource path for the target of the operation.", "type": "string" }, "requestedCancellation": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" } } }, "Date": { "type": "object", "properties": { "day": { "description": "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.", "format": "int32", "type": "integer" }, "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" } }, "description": "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", "id": "Date" }, "PscConfig": { "id": "PscConfig", "description": "Information for Private Service Connect (PSC) setup for a Looker instance.", "properties": { "lookerServiceAttachmentUri": { "type": "string", "description": "Output only. URI of the Looker service attachment.", "readOnly": true }, "serviceAttachments": { "description": "Optional. List of egress service attachment configurations.", "type": "array", "items": { "$ref": "ServiceAttachment" } }, "allowedVpcs": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}" } }, "type": "object" }, "Location": { "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" } }, "description": "A resource that represents a Google Cloud location.", "id": "Location" } }, "servicePath": "", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "fullyEncodeReservedExpansion": true, "version": "v1", "discoveryVersion": "v1", "batchPath": "batch", "description": "", "mtlsRootUrl": "https://looker.mtls.googleapis.com/", "revision": "20260703", "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "id": "looker.projects.locations.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "parameterOrder": [ "name" ], "response": { "$ref": "Location" } }, "list": { "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" }, "extraLocationTypes": { "type": "string", "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "name": { "type": "string", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true } }, "id": "looker.projects.locations.list", "path": "v1/{+name}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." } }, "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "looker.projects.locations.operations.list", "path": "v1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "id": "looker.projects.locations.operations.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "id": "looker.projects.locations.operations.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "looker.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "CancelOperationRequest" } } } }, "instances": { "methods": { "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "description": "Creates a new Instance in a given project and location.", "id": "looker.projects.locations.instances.create", "path": "v1/{+parent}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Instance" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "instanceId": { "description": "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.", "location": "query", "type": "string" } } }, "restart": { "description": "Restart instance.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "RestartInstanceRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restart", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "location": "path", "required": true } }, "id": "looker.projects.locations.instances.restart", "path": "v1/{+name}:restart", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "restore": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Restore Looker instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Instance being restored Format: projects/{project}/locations/{location}/instances/{instance}", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "request": { "$ref": "RestoreInstanceRequest" }, "id": "looker.projects.locations.instances.restore", "path": "v1/{+name}:restore", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "undelete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:undelete", "httpMethod": "POST", "parameters": { "name": { "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "request": { "$ref": "UndeleteInstanceRequest" }, "id": "looker.projects.locations.instances.undelete", "path": "v1/{+name}:undelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Undeletes Looker instance.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "export": { "description": "Export instance.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.export", "path": "v1/{+name}:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string" } }, "request": { "$ref": "ExportInstanceRequest" } }, "patch": { "request": { "$ref": "Instance" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "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.", "format": "google-fieldmask", "type": "string", "location": "query" }, "name": { "description": "Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "location": "path", "required": true } }, "id": "looker.projects.locations.instances.patch", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Update Instance." }, "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListInstancesResponse" }, "description": "Lists Instances in a given project and location.", "id": "looker.projects.locations.instances.list", "path": "v1/{+parent}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from a previous ListInstancesRequest." }, "showDeleted": { "description": "Optional. Whether to include deleted instances in the response.", "type": "boolean", "location": "query" }, "pageSize": { "description": "The maximum number of instances to return. If unspecified at most 256 will be returned. The maximum possible value is 2048.", "format": "int32", "type": "integer", "location": "query" } } }, "delete": { "description": "Delete instance.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "DELETE", "parameters": { "force": { "description": "Whether to force cascading delete.", "type": "boolean", "location": "query" }, "name": { "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "location": "path", "required": true } }, "id": "looker.projects.locations.instances.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Instance" }, "description": "Gets details of a single Instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "id": "looker.projects.locations.instances.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "import": { "id": "looker.projects.locations.instances.import", "path": "v1/{+name}:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string" } }, "request": { "$ref": "ImportInstanceRequest" }, "description": "Import instance.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } } }, "resources": { "backups": { "methods": { "create": { "id": "looker.projects.locations.instances.backups.create", "path": "v1/{+parent}/backups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "InstanceBackup" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "description": "Backup Looker instance.", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" } }, "get": { "description": "", "parameterOrder": [ "name" ], "response": { "$ref": "InstanceBackup" }, "id": "looker.projects.locations.instances.backups.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}/backups/{backup}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", "type": "string" } } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of instances to return.", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from a previous ListInstances request." }, "orderBy": { "description": "Sort results. Default order is \"create_time desc\". Other supported fields are \"state\" and \"expire_time\". https://google.aip.dev/132#ordering", "type": "string", "location": "query" } }, "id": "looker.projects.locations.instances.backups.list", "path": "v1/{+parent}/backups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List backups of Looker instance.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListInstanceBackupsResponse" } }, "delete": { "description": "Delete backup.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.backups.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", "type": "string" } } } } } } } } } } } }, "kind": "discovery#restDescription", "rootUrl": "https://looker.googleapis.com/", "version_module": true, "title": "Looker (Google Cloud core) API", "protocol": "rest", "name": "looker", "basePath": "" }