{ "canonicalName": "Looker", "description": "", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.operations.delete", "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "path": "v1/{+name}", "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`." }, "cancel": { "request": { "$ref": "CancelOperationRequest" }, "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`.", "path": "v1/{+name}:cancel", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "Empty" }, "id": "looker.projects.locations.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "name": { "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "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.", "type": "boolean", "location": "query" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListOperationsResponse" }, "id": "looker.projects.locations.operations.list", "path": "v1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "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.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "id": "looker.projects.locations.operations.get" } } }, "instances": { "methods": { "restart": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restart", "httpMethod": "POST", "path": "v1/{+name}:restart", "request": { "$ref": "RestartInstanceRequest" }, "description": "Restart instance.", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.instances.restart", "response": { "$ref": "Operation" } }, "list": { "description": "Lists Instances in a given project and location.", "path": "v1/{+parent}/instances", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "response": { "$ref": "ListInstancesResponse" }, "id": "looker.projects.locations.instances.list", "parameters": { "showDeleted": { "type": "boolean", "description": "Optional. Whether to include deleted instances in the response.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}`." }, "pageSize": { "description": "The maximum number of instances to return. If unspecified at most 256 will be returned. The maximum possible value is 2048.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "A page token received from a previous ListInstancesRequest.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Delete instance.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "DELETE", "id": "looker.projects.locations.instances.delete", "response": { "$ref": "Operation" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "type": "string", "location": "path" }, "force": { "description": "Whether to force cascading delete.", "type": "boolean", "location": "query" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "import": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.instances.import", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import", "httpMethod": "POST", "path": "v1/{+name}:import", "request": { "$ref": "ImportInstanceRequest" }, "description": "Import instance." }, "restore": { "request": { "$ref": "RestoreInstanceRequest" }, "description": "Restore Looker instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore", "httpMethod": "POST", "path": "v1/{+name}:restore", "id": "looker.projects.locations.instances.restore", "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. Instance being restored Format: projects/{project}/locations/{location}/instances/{instance}", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "export": { "parameters": { "name": { "type": "string", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.instances.export", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export", "httpMethod": "POST", "path": "v1/{+name}:export", "request": { "$ref": "ExportInstanceRequest" }, "description": "Export instance." }, "get": { "parameters": { "name": { "location": "path", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.instances.get", "response": { "$ref": "Instance" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "GET", "description": "Gets details of a single Instance." }, "undelete": { "path": "v1/{+name}:undelete", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:undelete", "request": { "$ref": "UndeleteInstanceRequest" }, "description": "Undeletes Looker instance.", "parameters": { "name": { "location": "path", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.undelete" }, "create": { "request": { "$ref": "Instance" }, "description": "Creates a new Instance in a given project and location.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "path": "v1/{+parent}/instances", "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.create", "parameters": { "instanceId": { "location": "query", "type": "string", "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." }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Format: `projects/{project}/locations/{location}`.", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.patch", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "description": "Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "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." } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Instance" }, "description": "Update Instance.", "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}" } }, "resources": { "backups": { "methods": { "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", "description": "Delete backup.", "parameters": { "name": { "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "id": "looker.projects.locations.instances.backups.delete" }, "get": { "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", "description": "", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", "location": "path", "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}/backups/{backup}`.", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "InstanceBackup" }, "id": "looker.projects.locations.instances.backups.get" }, "list": { "response": { "$ref": "ListInstanceBackupsResponse" }, "id": "looker.projects.locations.instances.backups.list", "parameters": { "orderBy": { "type": "string", "description": "Sort results. Default order is \"create_time desc\". Other supported fields are \"state\" and \"expire_time\". https://google.aip.dev/132#ordering", "location": "query" }, "pageSize": { "type": "integer", "description": "The maximum number of instances to return.", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "description": "A page token received from a previous ListInstances request.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}." } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List backups of Looker instance.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", "path": "v1/{+parent}/backups" }, "create": { "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "looker.projects.locations.instances.backups.create", "response": { "$ref": "Operation" }, "path": "v1/{+parent}/backups", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", "httpMethod": "POST", "request": { "$ref": "InstanceBackup" }, "description": "Backup Looker instance." } } } } } }, "methods": { "list": { "path": "v1/{+name}/locations", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations", "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.", "parameters": { "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query" }, "filter": { "location": "query", "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).", "type": "string" }, "pageSize": { "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "name": { "location": "path", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListLocationsResponse" }, "id": "looker.projects.locations.list" }, "get": { "description": "Gets information about a location.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "id": "looker.projects.locations.get", "response": { "$ref": "Location" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Resource name for the location.", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "schemas": { "ServiceAttachment": { "properties": { "connectionStatus": { "description": "Output only. Connection status.", "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." ], "readOnly": true, "type": "string", "enum": [ "UNKNOWN", "ACCEPTED", "PENDING", "REJECTED", "NEEDS_ATTENTION", "CLOSED" ] }, "localFqdns": { "items": { "type": "string" }, "type": "array", "description": "Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment." }, "targetServiceAttachmentUri": { "description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", "type": "string" }, "localFqdn": { "description": "Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", "type": "string" }, "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" } }, "type": "object", "id": "ServiceAttachment", "description": "Service attachment configuration." }, "PeriodicExportConfig": { "type": "object", "id": "PeriodicExportConfig", "description": "Configuration for periodic export.", "properties": { "startTime": { "$ref": "TimeOfDay", "description": "Required. Time in UTC to start the periodic export job." }, "kmsKey": { "description": "Required. Name of the CMEK key in KMS. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}", "type": "string" }, "gcsUri": { "type": "string", "description": "Required. Cloud Storage bucket URI for periodic export. Format: gs://{bucket_name}" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" } } }, "ImportInstanceRequest": { "id": "ImportInstanceRequest", "description": "Requestion options for importing looker data to an Instance", "type": "object", "properties": { "gcsUri": { "type": "string", "description": "Path to the import folder in Google Cloud Storage, in the form `gs://bucketName/folderName`." } } }, "DenyMaintenancePeriod": { "type": "object", "id": "DenyMaintenancePeriod", "description": "Specifies the maintenance denial period.", "properties": { "startDate": { "description": "Required. Start date of the deny maintenance period.", "$ref": "Date" }, "endDate": { "description": "Required. End date of the deny maintenance period.", "$ref": "Date" }, "time": { "description": "Required. Time in UTC when the period starts and ends.", "$ref": "TimeOfDay" } } }, "IngressIpAllowlistRule": { "properties": { "description": { "description": "Optional. Description for the IP range.", "type": "string" }, "ipRange": { "type": "string", "description": "Optional. The IP range to allow ingress traffic from." } }, "type": "object", "id": "IngressIpAllowlistRule", "description": "Ingress IP allowlist rule." }, "TimeOfDay": { "properties": { "hours": { "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.", "type": "integer", "format": "int32" }, "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer", "format": "int32" }, "seconds": { "type": "integer", "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" }, "nanos": { "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "type": "integer", "format": "int32" } }, "id": "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`.", "type": "object" }, "InstanceBackup": { "id": "InstanceBackup", "description": "The details of a backup resource.", "type": "object", "properties": { "encryptionConfig": { "description": "Output only. Current status of the CMEK encryption", "readOnly": true, "$ref": "EncryptionConfig" }, "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" }, "expireTime": { "format": "google-datetime", "description": "Output only. The time when the backup will be deleted.", "readOnly": true, "type": "string" }, "state": { "readOnly": true, "type": "string", "description": "Output only. The current state of the backup.", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "DELETING", "ACTIVE", "FAILED" ] }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the backup was started.", "format": "google-datetime" } } }, "CancelOperationRequest": { "type": "object", "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "CustomDomain": { "properties": { "domain": { "type": "string", "description": "Domain name." }, "state": { "type": "string", "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." ], "enum": [ "CUSTOM_DOMAIN_STATE_UNSPECIFIED", "UNVERIFIED", "VERIFIED", "MODIFYING", "AVAILABLE", "UNAVAILABLE", "UNKNOWN" ] } }, "id": "CustomDomain", "description": "Custom domain information.", "type": "object" }, "MaintenanceSchedule": { "type": "object", "id": "MaintenanceSchedule", "description": "Published upcoming future maintenance schedule.", "properties": { "startTime": { "format": "google-datetime", "type": "string", "description": "The scheduled start time for the maintenance." }, "endTime": { "format": "google-datetime", "description": "The scheduled end time for the maintenance.", "type": "string" } } }, "RestartInstanceRequest": { "properties": {}, "id": "RestartInstanceRequest", "description": "Request options for restarting an instance.", "type": "object" }, "ExportMetadataEncryptionKey": { "type": "object", "id": "ExportMetadataEncryptionKey", "description": "Encryption key details for the exported artifact.", "properties": { "version": { "description": "Version of the CMEK.", "type": "string" }, "cmek": { "type": "string", "description": "Name of the CMEK." } } }, "AdminSettings": { "properties": { "allowedEmailDomains": { "items": { "type": "string" }, "description": "Email domain allowlist for the instance.", "type": "array" } }, "id": "AdminSettings", "description": "Looker instance Admin settings fields.", "type": "object" }, "Empty": { "type": "object", "id": "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); }", "properties": {} }, "ExportInstanceRequest": { "type": "object", "id": "ExportInstanceRequest", "description": "Request options for exporting data of an Instance.", "properties": { "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" }, "encryptionConfig": { "description": "Required. Encryption configuration (CMEK). For CMEK enabled instances it should be same as looker CMEK.", "$ref": "ExportEncryptionConfig" } } }, "EncryptionConfig": { "type": "object", "id": "EncryptionConfig", "description": "Encryption configuration (i.e. CMEK).", "properties": { "kmsKeyName": { "type": "string", "description": "Name of the CMEK key in KMS (input parameter)." }, "kmsKeyState": { "description": "Output only. Status of the CMEK key.", "enumDescriptions": [ "CMEK status not specified.", "CMEK key is currently valid.", "CMEK key is currently revoked (instance should in restricted mode)." ], "readOnly": true, "type": "string", "enum": [ "KMS_KEY_STATE_UNSPECIFIED", "VALID", "REVOKED" ] }, "kmsKeyNameVersion": { "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, "type": "string" } } }, "OAuthConfig": { "type": "object", "id": "OAuthConfig", "description": "Looker instance OAuth login settings.", "properties": { "clientSecret": { "type": "string", "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." }, "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" }, "sharedOauthClientEnabled": { "type": "boolean", "description": "Optional. Whether to use the shared OAuth client. Instances specifying this field do not need to provide client_id and client_secret." } } }, "Date": { "type": "object", "id": "Date", "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", "properties": { "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32" }, "year": { "format": "int32", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year." }, "day": { "type": "integer", "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" } } }, "ControlledEgressConfig": { "id": "ControlledEgressConfig", "description": "Controlled egress configuration.", "type": "object", "properties": { "egressFqdns": { "type": "array", "description": "Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic.", "items": { "type": "string" } }, "webProxyIps": { "description": "Output only. The list of IP addresses used by Secure Web Proxy for outbound traffic.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "marketplaceEnabled": { "description": "Optional. Whether marketplace is enabled.", "type": "boolean" } } }, "RestoreInstanceRequest": { "properties": { "backup": { "type": "string", "description": "Required. Backup being used to restore the instance Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}" } }, "type": "object", "id": "RestoreInstanceRequest", "description": "Request options for restoring an instance" }, "ExportMetadata": { "properties": { "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" }, "filePaths": { "type": "array", "description": "List of files created as part of export artifact (excluding the metadata). The paths are relative to the folder containing the metadata.", "items": { "type": "string" } }, "esaSourceDatasetId": { "type": "string", "description": "Source BigQuery dataset (formatted as `project_id:dataset_id`) for O2C Elite System Activity (ESA) direct dataset migration." }, "lookerVersion": { "type": "string", "description": "Version of instance when the export was created." }, "lookerPlatformEdition": { "type": "string", "description": "Platform edition of the exported instance." }, "source": { "enum": [ "SOURCE_UNSPECIFIED", "LOOKER_CORE", "LOOKER_ORIGINAL" ], "description": "The source type of the migration.", "enumDescriptions": [ "Source not specified", "Source of export is Looker Core", "Source of export is Looker Original" ], "type": "string" }, "exportEncryptionKey": { "description": "Encryption key that was used to encrypt the export artifacts.", "$ref": "ExportMetadataEncryptionKey" }, "lookerInstance": { "type": "string", "description": "Name of the exported instance. Format: projects/{project}/locations/{location}/instances/{instance}" } }, "id": "ExportMetadata", "description": "ExportMetadata represents the metadata of the exported artifacts. The metadata.json file in export artifact can be parsed as this message", "type": "object" }, "OperationMetadata": { "type": "object", "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "properties": { "target": { "type": "string", "description": "Server-defined resource path for the target of the operation." }, "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" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" }, "verb": { "type": "string", "description": "Name of the verb executed by the operation." }, "apiVersion": { "type": "string", "description": "API version used to start the operation." }, "statusMessage": { "description": "Human-readable status of the operation, if any.", "type": "string" } } }, "ListInstanceBackupsResponse": { "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "instanceBackups": { "description": "The list of instances matching the request filters, up to the requested `page_size`.", "type": "array", "items": { "$ref": "InstanceBackup" } }, "nextPageToken": { "type": "string", "description": "If provided, a page token that can look up the next `page_size` results. If empty, the results list is exhausted." } }, "type": "object", "id": "ListInstanceBackupsResponse", "description": "Response from listing Looker instance backups." }, "ListInstancesResponse": { "id": "ListInstancesResponse", "description": "Response from ListInstances.", "type": "object", "properties": { "nextPageToken": { "description": "If provided, a page token that can look up the next `pageSize` results. If empty, the results list is exhausted.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "instances": { "type": "array", "description": "The list of instances matching the request filters, up to the requested `pageSize`.", "items": { "$ref": "Instance" } } } }, "IngressIpAllowlistConfig": { "properties": { "enabled": { "type": "boolean", "description": "Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance." }, "allowlistRules": { "items": { "$ref": "IngressIpAllowlistRule" }, "description": "Optional. List of IP range rules to allow ingress traffic.", "type": "array" }, "googleServicesEnabled": { "type": "boolean", "description": "Optional. Whether google service connections are enabled for the instance." } }, "type": "object", "id": "IngressIpAllowlistConfig", "description": "Ingress IP allowlist configuration." }, "UndeleteInstanceRequest": { "properties": {}, "id": "UndeleteInstanceRequest", "description": "Request options for undeleting an instance.", "type": "object" }, "PscConfig": { "id": "PscConfig", "description": "Information for Private Service Connect (PSC) setup for a Looker instance.", "type": "object", "properties": { "lookerServiceAttachmentUri": { "description": "Output only. URI of the Looker service attachment.", "readOnly": true, "type": "string" }, "allowedVpcs": { "description": "Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}", "type": "array", "items": { "type": "string" } }, "serviceAttachments": { "items": { "$ref": "ServiceAttachment" }, "description": "Optional. List of egress service attachment configurations.", "type": "array" } } }, "ListOperationsResponse": { "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "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." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "MaintenanceWindow": { "type": "object", "id": "MaintenanceWindow", "description": "Specifies the recurring maintenance window.", "properties": { "startTime": { "description": "Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes.", "$ref": "TimeOfDay" }, "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" ] } } }, "ListLocationsResponse": { "properties": { "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object" }, "Instance": { "properties": { "encryptionConfig": { "description": "Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance.", "$ref": "EncryptionConfig" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`." }, "acceleratedSecurityPatchEnabled": { "description": "Optional. Accelerated security patch enabled for the instance.", "type": "boolean" }, "fipsEnabled": { "type": "boolean", "description": "Optional. Whether FIPS is enabled on the Looker instance." }, "periodicExportConfig": { "$ref": "PeriodicExportConfig", "description": "Optional. Configuration for periodic export." }, "privateIpEnabled": { "description": "Whether private IP is enabled on the Looker instance.", "type": "boolean" }, "denyMaintenancePeriod": { "description": "Maintenance denial period for this instance.", "$ref": "DenyMaintenancePeriod" }, "adminSettings": { "$ref": "AdminSettings", "description": "Looker Instance Admin settings." }, "softDeleteReason": { "enum": [ "SOFT_DELETE_REASON_UNSPECIFIED", "BILLING_ACCOUNT_ISSUE", "TRIAL_EXPIRED", "CUSTOMER_REQUEST" ], "readOnly": true, "type": "string", "description": "Output only. The reason for the instance being in a soft-deleted state.", "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." ] }, "oauthConfig": { "$ref": "OAuthConfig", "description": "Looker instance OAuth login settings." }, "egressPublicIp": { "description": "Output only. Public Egress IP (IPv4).", "readOnly": true, "type": "string" }, "classType": { "type": "string", "description": "Optional. Storage class of the instance.", "enumDescriptions": [ "Unspecified storage class.", "Filestore.", "PD SSD." ], "enum": [ "CLASS_TYPE_UNSPECIFIED", "R1", "P1" ] }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "userMetadata": { "description": "Optional. User metadata.", "$ref": "UserMetadata" }, "createTime": { "description": "Output only. The time when the Looker instance provisioning was first requested.", "readOnly": true, "type": "string", "format": "google-datetime" }, "pscConfig": { "$ref": "PscConfig", "description": "Optional. PSC configuration. Used when `psc_enabled` is true." }, "lookerUri": { "readOnly": true, "type": "string", "description": "Output only. Looker instance URI which can be used to access the Looker Instance UI." }, "lastDenyMaintenancePeriod": { "readOnly": true, "$ref": "DenyMaintenancePeriod", "description": "Output only. Last computed maintenance denial period for this instance." }, "controlledEgressEnabled": { "type": "boolean", "description": "Optional. Whether controlled egress is enabled on the Looker instance." }, "ingressPublicIp": { "description": "Output only. Public Ingress IP (IPv4).", "readOnly": true, "type": "string" }, "controlledEgressConfig": { "description": "Optional. Controlled egress configuration.", "$ref": "ControlledEgressConfig" }, "maintenanceWindow": { "description": "Maintenance window for this instance.", "$ref": "MaintenanceWindow" }, "lookerVersion": { "readOnly": true, "type": "string", "description": "Output only. The Looker version that the instance is using." }, "catalogIntegrationOptOut": { "type": "boolean", "description": "Optional. Indicates whether catalog integration is disabled for the Looker 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" ] }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time when the Looker instance was last updated." }, "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" }, "linkedLspProjectNumber": { "type": "string", "description": "Optional. Linked Google Cloud Project Number for Looker Studio Pro.", "format": "int64" }, "publicIpEnabled": { "type": "boolean", "description": "Whether public IP is enabled on the Looker instance." }, "customDomain": { "description": "Custom domain configuration for the instance.", "$ref": "CustomDomain" }, "suspendedTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the Looker instance was suspended (soft deleted).", "format": "google-datetime" }, "state": { "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "FAILED", "SUSPENDED", "UPDATING", "DELETING", "EXPORTING", "IMPORTING" ], "readOnly": true, "type": "string", "description": "Output only. The state of the instance.", "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." ] }, "consumerNetwork": { "type": "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." }, "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" }, "ingressPrivateIp": { "readOnly": true, "type": "string", "description": "Output only. Private Ingress IP (IPv4)." }, "geminiEnabled": { "type": "boolean", "description": "Optional. Whether Gemini feature is enabled on the Looker instance or not." }, "ingressIpAllowlistConfig": { "$ref": "IngressIpAllowlistConfig", "description": "Optional. Ingress IP allowlist configuration for the Looker instance." }, "platformEdition": { "type": "string", "description": "Platform edition.", "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." ], "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" ] }, "maintenanceSchedule": { "$ref": "MaintenanceSchedule", "description": "Maintenance schedule for this instance." } }, "type": "object", "id": "Instance", "description": "A Looker instance." }, "ExportEncryptionConfig": { "properties": { "kmsKeyName": { "type": "string", "description": "Required. Name of the CMEK key in KMS." } }, "type": "object", "id": "ExportEncryptionConfig", "description": "Configuration for Encryption - e.g. CMEK." }, "UserMetadata": { "properties": { "additionalDeveloperUserCount": { "format": "int32", "description": "Optional. The number of additional developer users the instance owner has purchased.", "type": "integer" }, "additionalViewerUserCount": { "description": "Optional. The number of additional viewer users the instance owner has purchased.", "type": "integer", "format": "int32" }, "additionalStandardUserCount": { "type": "integer", "description": "Optional. The number of additional standard users the instance owner has purchased.", "format": "int32" } }, "type": "object", "id": "UserMetadata", "description": "Metadata about users for a Looker instance." }, "Operation": { "type": "object", "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "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.", "type": "object", "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" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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`." }, "name": { "type": "string", "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}`." } } }, "Status": { "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "type": "string", "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." }, "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": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "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).", "type": "object" } }, "version_module": true, "servicePath": "", "discoveryVersion": "v1", "name": "looker", "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." } } } }, "kind": "discovery#restDescription", "protocol": "rest", "fullyEncodeReservedExpansion": true, "mtlsRootUrl": "https://looker.mtls.googleapis.com/", "ownerDomain": "google.com", "parameters": { "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "quotaUser": { "location": "query", "type": "string", "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." }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "type": "string", "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" ], "location": "query" }, "key": { "location": "query", "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.", "type": "string" }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" } }, "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/", "basePath": "", "rootUrl": "https://looker.googleapis.com/", "ownerName": "Google", "title": "Looker (Google Cloud core) API", "id": "looker:v1", "revision": "20260812", "baseUrl": "https://looker.googleapis.com/", "batchPath": "batch", "version": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" } }