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