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