{ "id": "observability:v1", "name": "observability", "revision": "20260507", "canonicalName": "Cloud Observability", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "rootUrl": "https://observability.googleapis.com/", "version_module": true, "documentationLink": "https://cloud.google.com/stackdriver/docs/", "version": "v1", "basePath": "", "protocol": "rest", "discoveryVersion": "v1", "endpoints": [ { "endpointUrl": "https://observability.africa-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "africa-south1" }, { "endpointUrl": "https://observability.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "location": "asia-east2", "description": "Regional Endpoint", "endpointUrl": "https://observability.asia-east2.rep.googleapis.com/" }, { "endpointUrl": "https://observability.asia-northeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast2" }, { "endpointUrl": "https://observability.asia-northeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast3" }, { "endpointUrl": "https://observability.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-south1" }, { "endpointUrl": "https://observability.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "asia-southeast3", "endpointUrl": "https://observability.asia-southeast3.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "australia-southeast2", "endpointUrl": "https://observability.australia-southeast2.rep.googleapis.com/" }, { "location": "europe-north2", "description": "Regional Endpoint", "endpointUrl": "https://observability.europe-north2.rep.googleapis.com/" }, { "location": "europe-west1", "description": "Regional Endpoint", "endpointUrl": "https://observability.europe-west1.rep.googleapis.com/" }, { "location": "europe-west3", "description": "Regional Endpoint", "endpointUrl": "https://observability.europe-west3.rep.googleapis.com/" }, { "endpointUrl": "https://observability.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.europe-west6.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west6" }, { "location": "europe-west8", "description": "Regional Endpoint", "endpointUrl": "https://observability.europe-west8.rep.googleapis.com/" }, { "endpointUrl": "https://observability.me-central1.rep.googleapis.com/", "location": "me-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.northamerica-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "northamerica-south1" }, { "endpointUrl": "https://observability.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.us-east1.rep.googleapis.com/", "location": "us-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "endpointUrl": "https://observability.us-south1.rep.googleapis.com/", "location": "us-south1", "description": "Regional Endpoint" }, { "location": "us-west1", "description": "Regional Endpoint", "endpointUrl": "https://observability.us-west1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://observability.us-west2.rep.googleapis.com/" }, { "endpointUrl": "https://observability.us-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west3" }, { "endpointUrl": "https://observability.us.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us" }, { "endpointUrl": "https://observability.eu.rep.googleapis.com/", "description": "Regional Endpoint", "location": "eu" } ], "resources": { "folders": { "resources": { "locations": { "methods": { "getSettings": { "id": "observability.folders.locations.getSettings", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/settings", "parameters": { "name": { "location": "path", "description": "Required. Name of the settings to retrieve. Name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/settings\" \"folders/[FOLDER_ID]/locations/[LOCATION]/settings\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings\"", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/settings$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Get Settings" }, "updateSettings": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.folders.locations.updateSettings", "request": { "$ref": "Settings" }, "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/settings", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/settings$", "type": "string", "location": "path", "description": "Identifier. The resource name of the settings.", "required": true }, "updateMask": { "description": "Optional. The field mask specifying which fields of the settings are to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "description": "Update Settings", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1/{+name}/locations", "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations", "parameters": { "filter": { "location": "query", "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)." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default." }, "pageToken": { "location": "query", "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." }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "name": { "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path", "pattern": "^folders/[^/]+$", "type": "string" } }, "id": "observability.folders.locations.list", "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.", "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "observability.folders.locations.get", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "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." }, "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "type": "string" } }, "id": "observability.folders.locations.operations.list", "parameterOrder": [ "name" ], "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "required": true, "location": "path" } }, "id": "observability.folders.locations.operations.get", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "httpMethod": "GET" }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "id": "observability.folders.locations.operations.delete", "path": "v1/{+name}", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "httpMethod": "DELETE" }, "cancel": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "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`.", "id": "observability.folders.locations.operations.cancel", "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:cancel" } } } } } } }, "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "location": "path" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "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." } }, "id": "observability.projects.locations.operations.list", "parameterOrder": [ "name" ], "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" }, "get": { "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.projects.locations.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } } }, "delete": { "path": "v1/{+name}", "id": "observability.projects.locations.operations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path" } }, "parameterOrder": [ "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`.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "path": "v1/{+name}:cancel", "id": "observability.projects.locations.operations.cancel", "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "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`.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "scopes": { "methods": { "get": { "response": { "$ref": "Scope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Scope.", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", "type": "string", "description": "Required. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", "required": true, "location": "path" } }, "id": "observability.projects.locations.scopes.get", "path": "v1/{+name}" }, "patch": { "response": { "$ref": "Scope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Scope.", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Scope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten when it is in the mask. If the user does not provide a mask, then all fields present in the request are overwritten." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", "type": "string", "description": "Identifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", "required": true, "location": "path" } }, "id": "observability.projects.locations.scopes.patch", "request": { "$ref": "Scope" }, "parameterOrder": [ "name" ], "path": "v1/{+name}" } } }, "buckets": { "resources": { "datasets": { "methods": { "get": { "httpMethod": "GET", "description": "Get a dataset.", "response": { "$ref": "Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.projects.locations.buckets.datasets.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}", "parameters": { "name": { "location": "path", "description": "Required. Name of the dataset to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+$", "type": "string" } } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets", "parameters": { "pageSize": { "description": "Optional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListDatasets` call. Provide this to retrieve the subsequent page." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "type": "string", "description": "Required. The parent bucket that owns this collection of datasets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]", "required": true, "location": "path" }, "showDeleted": { "location": "query", "type": "boolean", "description": "Optional. If true, then the response will include deleted datasets." } }, "id": "observability.projects.locations.buckets.datasets.list", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/datasets", "response": { "$ref": "ListDatasetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List datasets of a bucket.", "httpMethod": "GET" } }, "resources": { "views": { "methods": { "get": { "id": "observability.projects.locations.buckets.datasets.views.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/views/{viewsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+/views/[^/]+$", "type": "string", "description": "Required. Name of the view to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "View" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Get a view." }, "list": { "httpMethod": "GET", "description": "List views of a dataset.", "response": { "$ref": "ListViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/views", "id": "observability.projects.locations.buckets.datasets.views.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/views", "parameters": { "pageSize": { "description": "Optional. The maximum number of views to return. If unspecified, then at most 100 views are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListViews` call. Provide this to retrieve the subsequent page." }, "parent": { "location": "path", "description": "Required. Dataset whose views are to be listed. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ] } } }, "links": { "methods": { "create": { "path": "v1/{+parent}/links", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/links", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. Name of the containing dataset for this link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]", "required": true, "location": "path" }, "linkId": { "location": "query", "type": "string", "description": "Required. Id of the link to create." } }, "id": "observability.projects.locations.buckets.datasets.links.create", "request": { "$ref": "Link" }, "description": "Create a new link.", "httpMethod": "POST", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Get a link.", "httpMethod": "GET", "response": { "$ref": "Link" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/links/{linksId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+/links/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of the link to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]", "required": true } }, "id": "observability.projects.locations.buckets.datasets.links.get", "parameterOrder": [ "name" ] }, "list": { "path": "v1/{+parent}/links", "parameterOrder": [ "parent" ], "id": "observability.projects.locations.buckets.datasets.links.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/links", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of links to return. If unspecified, then at most 100 links are returned. The maximum value is 1000; values above 1000 are coerced to 1000." }, "pageToken": { "description": "Optional. A page token, received from a previous `ListLinks` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The parent dataset that owns this collection of links. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "List links of a dataset.", "response": { "$ref": "ListLinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/links/{linksId}", "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. The list of fields to update." }, "name": { "description": "Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+/links/[^/]+$", "type": "string" } }, "id": "observability.projects.locations.buckets.datasets.links.patch", "request": { "$ref": "Link" }, "parameterOrder": [ "name" ], "description": "Update a link.", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1/{+name}", "id": "observability.projects.locations.buckets.datasets.links.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/datasets/{datasetsId}/links/{linksId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/datasets/[^/]+/links/[^/]+$", "type": "string", "location": "path", "description": "Required. Name of the link to delete. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Delete a link.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "methods": { "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.projects.locations.buckets.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", "parameters": { "name": { "description": "Required. Name of the bucket to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "Get bucket resource.", "response": { "$ref": "Bucket" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1/{+parent}/buckets", "parameterOrder": [ "parent" ], "id": "observability.projects.locations.buckets.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets", "parameters": { "pageSize": { "description": "Optional. The maximum number of buckets to return. If unspecified, then at most 100 buckets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListBuckets` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent, which owns this collection of buckets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "showDeleted": { "location": "query", "type": "boolean", "description": "Optional. If true, then the response will include deleted buckets." } }, "httpMethod": "GET", "description": "List buckets of a project in a particular location.", "response": { "$ref": "ListBucketsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "traceScopes": { "methods": { "patch": { "id": "observability.projects.locations.traceScopes.patch", "request": { "$ref": "TraceScope" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", "parameters": { "name": { "location": "path", "description": "Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "TraceScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "description": "Update a TraceScope." }, "delete": { "httpMethod": "DELETE", "description": "Delete a TraceScope.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.projects.locations.traceScopes.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", "type": "string", "description": "Required. The full resource name of the trace scope to delete: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope", "required": true, "location": "path" } } }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes", "parameters": { "parent": { "description": "Required. The full resource name of the location where the trace scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "traceScopeId": { "description": "Required. A client-assigned identifier for the trace scope.", "location": "query", "type": "string" } }, "id": "observability.projects.locations.traceScopes.create", "request": { "$ref": "TraceScope" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/traceScopes", "response": { "$ref": "TraceScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a new TraceScope.", "httpMethod": "POST" }, "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}", "parameters": { "name": { "description": "Required. The resource name of the trace scope: projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID] For example: projects/my-project/locations/global/traceScopes/my-trace-scope", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/traceScopes/[^/]+$", "type": "string" } }, "id": "observability.projects.locations.traceScopes.get", "description": "Get TraceScope resource.", "httpMethod": "GET", "response": { "$ref": "TraceScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/traceScopes", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available." }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The full resource name of the location to look for trace scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "id": "observability.projects.locations.traceScopes.list", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/traceScopes", "response": { "$ref": "ListTraceScopesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List TraceScopes of a project in a particular location.", "httpMethod": "GET" } } } }, "methods": { "getSettings": { "id": "observability.projects.locations.getSettings", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", "parameters": { "name": { "description": "Required. Name of the settings to retrieve. Name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/settings\" \"folders/[FOLDER_ID]/locations/[LOCATION]/settings\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings\"", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Get Settings" }, "updateSettings": { "parameterOrder": [ "name" ], "id": "observability.projects.locations.updateSettings", "request": { "$ref": "Settings" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", "parameters": { "updateMask": { "description": "Optional. The field mask specifying which fields of the settings are to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Identifier. The resource name of the settings.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "description": "Update Settings" }, "list": { "flatPath": "v1/projects/{projectsId}/locations", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path", "pattern": "^projects/[^/]+$", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" } }, "id": "observability.projects.locations.list", "parameterOrder": [ "name" ], "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "httpMethod": "GET" }, "get": { "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Resource name for the location.", "required": true } }, "id": "observability.projects.locations.get", "parameterOrder": [ "name" ], "path": "v1/{+name}" } } } } }, "organizations": { "resources": { "locations": { "methods": { "getSettings": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "observability.organizations.locations.getSettings", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/settings", "parameters": { "name": { "description": "Required. Name of the settings to retrieve. Name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/settings\" \"folders/[FOLDER_ID]/locations/[LOCATION]/settings\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings\"", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "type": "string" } }, "httpMethod": "GET", "description": "Get Settings", "response": { "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "updateSettings": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "description": "Update Settings", "id": "observability.organizations.locations.updateSettings", "request": { "$ref": "Settings" }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/settings", "parameters": { "updateMask": { "description": "Optional. The field mask specifying which fields of the settings are to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "type": "string", "description": "Identifier. The resource name of the settings.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "list": { "id": "observability.organizations.locations.list", "flatPath": "v1/organizations/{organizationsId}/locations", "parameters": { "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "name": { "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^organizations/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default." }, "pageToken": { "location": "query", "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." }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "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." }, "get": { "id": "observability.organizations.locations.get", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "parameterOrder": [ "name" ], "id": "observability.organizations.locations.operations.delete", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "path": "v1/{+name}" }, "cancel": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "location": "path" } }, "id": "observability.organizations.locations.operations.cancel", "request": { "$ref": "CancelOperationRequest" }, "path": "v1/{+name}:cancel" }, "list": { "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "id": "observability.organizations.locations.operations.list", "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" }, "get": { "path": "v1/{+name}", "id": "observability.organizations.locations.operations.get", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "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." } } } }, "ownerName": "Google", "batchPath": "batch", "parameters": { "alt": { "location": "query", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "$.xgafv": { "location": "query", "description": "V1 error format.", "type": "string", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "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." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "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" } }, "fullyEncodeReservedExpansion": true, "title": "Observability API", "mtlsRootUrl": "https://observability.mtls.googleapis.com/", "baseUrl": "https://observability.googleapis.com/", "description": "Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view.", "schemas": { "ListViewsResponse": { "description": "Response for listing views.", "type": "object", "properties": { "views": { "items": { "$ref": "View" }, "description": "The list of views.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Optional. A token that can be sent as `page_token` to retrieve the next page. When this field is omitted, there are no subsequent pages." } }, "id": "ListViewsResponse" }, "ListLinksResponse": { "type": "object", "properties": { "links": { "description": "The list of links.", "type": "array", "items": { "$ref": "Link" } }, "nextPageToken": { "description": "Optional. A token that can be sent as `page_token` to retrieve the next page. When this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response for listing links.", "id": "ListLinksResponse" }, "Operation": { "type": "object", "properties": { "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "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." } } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation" }, "Settings": { "id": "Settings", "type": "object", "properties": { "defaultStorageLocation": { "description": "Optional. The location which should be used when any regional resources are provisioned by Google Cloud.", "type": "string" }, "kmsKeyName": { "description": "Optional. The resource name for the configured Cloud KMS key. KMS key name format: \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\" For example: `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"`", "type": "string" }, "serviceAccountId": { "description": "Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. The resource name of the settings.", "type": "string" } }, "description": "Describes the settings associated with a project, organization, or folder." }, "TraceScope": { "id": "TraceScope", "description": "A trace scope is a collection of resources whose traces are queried together.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The creation timestamp of the trace scope." }, "name": { "description": "Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The last update timestamp of the trace scope." }, "description": { "description": "Optional. Describes this trace scope. The maximum length of the description is 8000 characters.", "type": "string" }, "resourceNames": { "items": { "type": "string" }, "type": "array", "description": "Required. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects." } } }, "Bucket": { "description": "Bucket configuration for storing observability data.", "type": "object", "properties": { "deleteTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Delete timestamp." }, "purgeTime": { "description": "Output only. Timestamp when the bucket in soft-deleted state is purged.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Optional. User friendly display name." }, "name": { "type": "string", "description": "Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]" }, "updateTime": { "description": "Output only. Update timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "type": "string", "description": "Optional. Description of the bucket." }, "cmekSettings": { "description": "Optional. Settings for configuring CMEK on a bucket.", "$ref": "CmekSettings" }, "createTime": { "description": "Output only. Create timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "Bucket" }, "ListBucketsResponse": { "type": "object", "properties": { "buckets": { "description": "Optional. The list of buckets.", "type": "array", "items": { "$ref": "Bucket" } }, "nextPageToken": { "description": "Optional. A token that can be sent as `page_token` to retrieve the next page. When this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response for listing buckets.", "id": "ListBucketsResponse" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "items": { "$ref": "Location" }, "type": "array", "description": "A list of locations that matches the specified filter in the request." } }, "description": "The response message for Locations.ListLocations." }, "View": { "id": "View", "type": "object", "properties": { "displayName": { "type": "string", "description": "Optional. User friendly display name." }, "description": { "type": "string", "description": "Optional. Description of the view." }, "name": { "type": "string", "description": "Identifier. Name of the view. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update timestamp." }, "createTime": { "description": "Output only. Create timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "A view corresponds to a read-only representation of a subset of the data in a dataset." }, "ListTraceScopesResponse": { "description": "Response for listing TraceScopes.", "type": "object", "properties": { "traceScopes": { "type": "array", "description": "Optional. A list of trace scopes.", "items": { "$ref": "TraceScope" } }, "nextPageToken": { "type": "string", "description": "Optional. If there might be more results than appear in this response, then `next_page_token` is included. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`." } }, "id": "ListTraceScopesResponse" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "properties": {}, "description": "The request message for Operations.CancelOperation." }, "ListOperationsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "unreachable": { "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": "array" } }, "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse" }, "Empty": { "type": "object", "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); }", "id": "Empty" }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } } } }, "CmekSettings": { "id": "CmekSettings", "type": "object", "properties": { "kmsKeyVersion": { "readOnly": true, "type": "string", "description": "Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1 This read-only field is used to convey the specific configured CryptoKeyVersion of the `kms_key` that has been configured. It is populated when the CMEK settings are bound to a single key version." }, "serviceAccountId": { "readOnly": true, "type": "string", "description": "Output only. The service account used to access the key." }, "kmsKey": { "description": "Optional. The resource name for the configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY] For example: projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key", "type": "string" } }, "description": "Settings for configuring CMEK for a bucket." }, "ListDatasetsResponse": { "description": "Response for listing datasets.", "type": "object", "properties": { "datasets": { "description": "The list of datasets.", "type": "array", "items": { "$ref": "Dataset" } }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. When this field is omitted, there are no subsequent pages." } }, "id": "ListDatasetsResponse" }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "requestedCancellation": { "readOnly": true, "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" } } }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } }, "id": "Status" }, "Scope": { "id": "Scope", "type": "object", "properties": { "traceScope": { "description": "Required. The resource name of the `TraceScope`. For example: projects/myproject/locations/global/traceScopes/my-trace-scope", "type": "string" }, "logScope": { "description": "Required. The full resource name of the `LogScope`. For example: //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope", "type": "string" }, "name": { "description": "Identifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", "type": "string" }, "updateTime": { "description": "Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "Message describing Scope object" }, "Dataset": { "description": "A dataset is a collection of data that has a specific configuration. A dataset can be backed by multiple tables. One bucket can have multiple datasets.", "type": "object", "properties": { "name": { "type": "string", "description": "Identifier. Name of the dataset. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]" }, "description": { "description": "Optional. Description of the dataset.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Create timestamp." }, "deleteTime": { "description": "Output only. Delete timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "purgeTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the dataset in soft-deleted state is purged." }, "displayName": { "type": "string", "description": "Optional. User friendly display name." } }, "id": "Dataset" }, "Link": { "id": "Link", "description": "A link lets a dataset be accessible to BigQuery via usage of linked datasets.", "type": "object", "properties": { "description": { "type": "string", "description": "Optional. Description of the link." }, "name": { "description": "Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]", "type": "string" }, "displayName": { "description": "Optional. A user friendly display name.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Create timestamp." } } } }, "ownerDomain": "google.com", "kind": "discovery#restDescription" }