{ "batchPath": "batch", "resources": { "sinks": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource in which to create the sink: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-project\"` `\"organizations/123456789\"`", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true }, "uniqueWriterIdentity": { "description": "Optional. Determines the kind of IAM identity returned as `writer_identity` in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as `writer_identity` is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of `writer_identity` will be a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see `writer_identity` in LogSink.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogSink" }, "flatPath": "v2/{v2Id}/{v2Id1}/sinks", "description": "BigQuery and GCS exports are not supported. Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "request": { "$ref": "LogSink" }, "id": "logging.sinks.create", "path": "v2/{+parent}/sinks" }, "get": { "parameters": { "sinkName": { "location": "path", "description": "Required. The resource name of the sink: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/sinks/[^/]+$" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+sinkName}", "id": "logging.sinks.get", "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Gets a sink." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "required": true, "pattern": "^[^/]+/[^/]+$", "location": "path", "description": "Required. The parent resource whose sinks are to be listed: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string" }, "filter": { "type": "string", "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: * `''` * `'in_scope(\"ALL\")'`, * `'in_scope(\"ANCESTOR\")'`, * `'in_scope(\"DEFAULT\")'`. Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by `parent`. When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", "location": "query" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSinksResponse" }, "httpMethod": "GET", "path": "v2/{+parent}/sinks", "id": "logging.sinks.list", "flatPath": "v2/{v2Id}/{v2Id1}/sinks", "description": "BigQuery and GCS exports are not supported. Lists sinks." }, "update": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" }, "sinkName": { "required": true, "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", "location": "path", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string" }, "uniqueWriterIdentity": { "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "location": "query" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PUT", "request": { "$ref": "LogSink" }, "path": "v2/{+sinkName}", "id": "logging.sinks.update", "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field." }, "delete": { "httpMethod": "DELETE", "parameters": { "sinkName": { "location": "path", "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/sinks/[^/]+$" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.", "id": "logging.sinks.delete", "path": "v2/{+sinkName}" } } }, "exclusions": { "methods": { "delete": { "id": "logging.exclusions.delete", "path": "v2/{+name}", "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", "description": "Deletes an exclusion in the _Default sink.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of an existing exclusion to delete: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "list": { "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent resource whose exclusions are to be listed. \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "required": true, "pattern": "^[^/]+/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExclusionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/exclusions", "description": "Lists all the exclusions on the _Default sink in a parent resource.", "id": "logging.exclusions.list", "path": "v2/{+parent}/exclusions" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "description": "Required. The resource name of the exclusion to update: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", "required": true }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `\"filter,description\"`." } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "PATCH", "request": { "$ref": "LogExclusion" }, "path": "v2/{+name}", "id": "logging.exclusions.patch", "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", "description": "Changes one or more properties of an existing exclusion in the _Default sink." }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The resource name of an existing exclusion: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", "description": "Gets the description of an exclusion in the _Default sink.", "id": "logging.exclusions.get", "path": "v2/{+name}" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "required": true, "pattern": "^[^/]+/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource in which to create the exclusion: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-logging-project\"` `\"organizations/123456789\"`" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "POST", "request": { "$ref": "LogExclusion" }, "path": "v2/{+parent}/exclusions", "id": "logging.exclusions.create", "flatPath": "v2/{v2Id}/{v2Id1}/exclusions", "description": "Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." } } }, "v2": { "methods": { "getSettings": { "parameters": { "name": { "location": "path", "description": "Required. The resource for which to retrieve settings. \"projects/[PROJECT_ID]/settings\" \"organizations/[ORGANIZATION_ID]/settings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"` Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts.", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/settings", "description": "Gets the settings for the given resource. Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts. See [View default resource settings for Logging] (https://documentation.s3ns.fr/logging/docs/default-settings#view-org-settings) for more information.", "path": "v2/{+name}/settings", "id": "logging.getSettings" }, "updateSettings": { "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^[^/]+/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"`", "location": "path" }, "updateMask": { "description": "Optional. Field mask identifying which fields from `settings` should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated. See FieldMask for more information. For example: `\"updateMask=kmsKeyName\"`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/{v2Id}/{v2Id1}/settings", "description": "Updates the settings for the given resource. This method applies to all feature configurations for organization and folders. UpdateSettings fails when any of the following are true: * The value of `storage_location` either isn't supported by Logging or violates the location OrgPolicy. * The `default_sink_config` field is set, but it has an unspecified filter write mode. * The value of `kms_key_name` is invalid. * The associated service account doesn't have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. * Access to the key is disabled. See [Configure default settings for organizations and folders] (https://documentation.s3ns.fr/logging/docs/default-settings) for more information.", "id": "logging.updateSettings", "path": "v2/{+name}/settings", "request": { "$ref": "Settings" } } } }, "projects": { "resources": { "locations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "httpMethod": "GET", "path": "v2/{+name}", "id": "logging.projects.locations.get", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}", "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "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." }, "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" }, "name": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "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).", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "id": "logging.projects.locations.list", "path": "v2/{+name}/locations", "flatPath": "v2/projects/{projectsId}/locations", "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe." } }, "resources": { "buckets": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`" }, "bucketId": { "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogBucket" }, "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets", "description": "Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.", "request": { "$ref": "LogBucket" }, "path": "v2/{+parent}/buckets", "id": "logging.projects.locations.buckets.create" }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the bucket to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Deletes a log bucket. Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.", "path": "v2/{+name}", "id": "logging.projects.locations.buckets.delete" }, "undelete": { "path": "v2/{+name}:undelete", "id": "logging.projects.locations.buckets.undelete", "request": { "$ref": "UndeleteBucketRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}:undelete", "description": "Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "location": "path", "type": "string", "description": "Required. The full resource name of the bucket to undelete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Gets a log bucket.", "id": "logging.projects.locations.buckets.get", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" } }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" }, "parent": { "description": "Required. The parent resource whose buckets are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBucketsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets", "description": "Lists log buckets.", "id": "logging.projects.locations.buckets.list", "path": "v2/{+parent}/buckets" }, "patch": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Updates a log bucket. If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. After a bucket has been created, the bucket's location cannot be changed.", "request": { "$ref": "LogBucket" }, "id": "logging.projects.locations.buckets.patch", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" } } }, "resources": { "views": { "resources": { "logs": { "methods": { "list": { "parameters": { "parent": { "type": "string", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "resourceNames": { "location": "query", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string" }, "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+parent}/logs", "id": "logging.projects.locations.buckets.views.logs.list", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." } } } }, "methods": { "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions", "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v2/{+resource}:testIamPermissions", "id": "logging.projects.locations.buckets.views.testIamPermissions" }, "create": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.", "request": { "$ref": "LogView" }, "path": "v2/{+parent}/views", "id": "logging.projects.locations.buckets.views.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "type": "string", "description": "Required. The bucket in which to create the view `\"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"` For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "location": "path" }, "viewId": { "location": "query", "description": "Required. A client-assigned identifier such as `\"my-view\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogView" }, "httpMethod": "POST" }, "getIamPolicy": { "parameters": { "resource": { "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy", "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+resource}:getIamPolicy", "id": "logging.projects.locations.buckets.views.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" } }, "delete": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.", "path": "v2/{+name}", "id": "logging.projects.locations.buckets.views.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "type": "string", "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"", "location": "path" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Lists views on a log bucket.", "id": "logging.projects.locations.buckets.views.list", "path": "v2/{+parent}/views" }, "patch": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `view` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Updates a view on a log bucket. This method replaces the value of the `filter` field from the existing view with the corresponding value from the new view. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.", "path": "v2/{+name}", "id": "logging.projects.locations.buckets.views.patch", "request": { "$ref": "LogView" } }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "resource": { "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "request": { "$ref": "SetIamPolicyRequest" }, "id": "logging.projects.locations.buckets.views.setIamPolicy", "path": "v2/{+resource}:setIamPolicy", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy", "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe." }, "get": { "id": "logging.projects.locations.buckets.views.get", "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Gets a view on a log bucket.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" } } } } } }, "logScopes": { "methods": { "create": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes", "description": "Creates a log scope.", "path": "v2/{+parent}/logScopes", "id": "logging.projects.locations.logScopes.create", "request": { "$ref": "LogScope" }, "parameters": { "parent": { "location": "path", "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "logScopeId": { "description": "Required. A client-assigned identifier such as `\"log-scope\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogScope" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "location": "path", "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Gets a log scope.", "id": "logging.projects.locations.logScopes.get", "path": "v2/{+name}" }, "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\"", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogScopesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes", "description": "Lists log scopes.", "path": "v2/{+parent}/logScopes", "id": "logging.projects.locations.logScopes.list" }, "patch": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Updates a log scope.", "id": "logging.projects.locations.logScopes.patch", "path": "v2/{+name}", "request": { "$ref": "LogScope" }, "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, "type": "string", "description": "Output only. The resource name of the log scope. Log scopes are only available in the `global` location. For example: `projects/my-project/locations/global/logScopes/my-log-scope`", "location": "path" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `log_scope` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=description`", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Deletes a log scope.", "id": "logging.projects.locations.logScopes.delete", "path": "v2/{+name}" } } }, "recentQueries": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `projects/my-project/locations/us-central1` Note: The location portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all recent queries.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") of the recent queries to list. The only valid value for this field is one of the two allowable `type` function calls, which are the following: * `type(\"Logging\")` * `type(\"OpsAnalytics\")`", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRecentQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/recentQueries", "description": "Lists the RecentQueries that were created by the user making the request.", "id": "logging.projects.locations.recentQueries.list", "path": "v2/{+parent}/recentQueries" } } }, "operations": { "methods": { "cancel": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}:cancel", "id": "logging.projects.locations.operations.cancel", "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "list": { "id": "logging.projects.locations.operations.list", "path": "v2/{+name}/operations", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "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." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" } }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "logging.projects.locations.operations.get", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } } } }, "savedQueries": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/us-central1\" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character `-` can be used for [LOCATION_ID], for example: \"projects/my-project/locations/-\"", "type": "string", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the `type` function or a `visibility` token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character. The two supported `type` function calls are: * `type(\"Logging\")` * `type(\"OpsAnalytics\")` The two supported `visibility` tokens are: * `visibility = PRIVATE` * `visibility = SHARED` For example: `type(\"Logging\") AND visibility = PRIVATE` `visibility=SHARED type(\"OpsAnalytics\")` `type(\"OpsAnalytics)\"` `visibility = PRIVATE` `visibility = SHARED`" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSavedQueriesResponse" }, "httpMethod": "GET", "path": "v2/{+parent}/savedQueries", "id": "logging.projects.locations.savedQueries.list", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/savedQueries", "description": "Lists the SavedQueries that were created by the user making the request." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "required": true, "description": "Output only. Resource name of the saved query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support#bucket-regions) After the saved query is created, the location cannot be changed. If the user doesn't provide a [QUERY_ID], the system will generate an alphanumeric ID.", "type": "string", "location": "path" }, "updateMask": { "description": "Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the `saved_query` and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. To update all mutable fields, specify an `update_mask` of `*`. For example, to change the description and query filter text of a saved query, specify an `update_mask` of `\"description, query.filter\"`.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Updates an existing SavedQuery.", "request": { "$ref": "SavedQuery" }, "id": "logging.projects.locations.savedQueries.patch", "path": "v2/{+name}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "required": true, "description": "Required. The resource name of the saved query. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Returns all data associated with the requested query.", "path": "v2/{+name}", "id": "logging.projects.locations.savedQueries.get" }, "delete": { "id": "logging.projects.locations.savedQueries.delete", "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Deletes an existing SavedQuery that was created by the user making the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "required": true, "description": "Required. The full resource name of the saved query to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" } }, "create": { "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource in which to create the saved query: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/global\" \"organizations/123456789/locations/us-central1\"" }, "savedQueryId": { "type": "string", "description": "Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name. If the `saved_query_id` is not provided, the system will generate an alphanumeric ID. The `saved_query_id` is limited to 100 characters and can include only the following characters: * upper and lower-case alphanumeric characters, * underscores, * hyphens, * periods. First character has to be alphanumeric.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SavedQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.projects.locations.savedQueries.create", "path": "v2/{+parent}/savedQueries", "request": { "$ref": "SavedQuery" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/savedQueries", "description": "Creates a new SavedQuery for the user making the request." } } } } }, "exclusions": { "methods": { "get": { "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", "description": "Gets the description of an exclusion in the _Default sink.", "path": "v2/{+name}", "id": "logging.projects.exclusions.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of an existing exclusion: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "required": true, "pattern": "^projects/[^/]+/exclusions/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "GET" }, "list": { "path": "v2/{+parent}/exclusions", "id": "logging.projects.exclusions.list", "flatPath": "v2/projects/{projectsId}/exclusions", "description": "Lists all the exclusions on the _Default sink in a parent resource.", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent resource whose exclusions are to be listed. \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "required": true, "pattern": "^projects/[^/]+$" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExclusionsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "parameters": { "name": { "type": "string", "description": "Required. The resource name of the exclusion to update: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "location": "path", "pattern": "^projects/[^/]+/exclusions/[^/]+$", "required": true }, "updateMask": { "location": "query", "description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `\"filter,description\"`.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}", "id": "logging.projects.exclusions.patch", "request": { "$ref": "LogExclusion" }, "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", "description": "Changes one or more properties of an existing exclusion in the _Default sink." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "description": "Required. The resource name of an existing exclusion to delete: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/exclusions/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v2/{+name}", "id": "logging.projects.exclusions.delete", "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", "description": "Deletes an exclusion in the _Default sink." }, "create": { "request": { "$ref": "LogExclusion" }, "path": "v2/{+parent}/exclusions", "id": "logging.projects.exclusions.create", "flatPath": "v2/projects/{projectsId}/exclusions", "description": "Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource in which to create the exclusion: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-logging-project\"` `\"organizations/123456789\"`", "location": "path", "pattern": "^projects/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "POST" } } }, "sinks": { "methods": { "create": { "flatPath": "v2/projects/{projectsId}/sinks", "description": "BigQuery and GCS exports are not supported. Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "request": { "$ref": "LogSink" }, "path": "v2/{+parent}/sinks", "id": "logging.projects.sinks.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. The resource in which to create the sink: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-project\"` `\"organizations/123456789\"`", "type": "string" }, "uniqueWriterIdentity": { "description": "Optional. Determines the kind of IAM identity returned as `writer_identity` in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as `writer_identity` is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of `writer_identity` will be a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see `writer_identity` in LogSink.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogSink" }, "httpMethod": "POST" }, "update": { "httpMethod": "PUT", "parameters": { "sinkName": { "location": "path", "type": "string", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$" }, "uniqueWriterIdentity": { "location": "query", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "type": "boolean" }, "customWriterIdentity": { "location": "query", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string" }, "updateMask": { "location": "query", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "id": "logging.projects.sinks.update", "path": "v2/{+sinkName}", "request": { "$ref": "LogSink" } }, "delete": { "parameters": { "sinkName": { "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$", "location": "path", "type": "string", "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.", "path": "v2/{+sinkName}", "id": "logging.projects.sinks.delete" }, "list": { "httpMethod": "GET", "parameters": { "parent": { "location": "path", "description": "Required. The parent resource whose sinks are to be listed: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string", "required": true, "pattern": "^projects/[^/]+$" }, "filter": { "type": "string", "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: * `''` * `'in_scope(\"ALL\")'`, * `'in_scope(\"ANCESTOR\")'`, * `'in_scope(\"DEFAULT\")'`. Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by `parent`. When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/projects/{projectsId}/sinks", "description": "BigQuery and GCS exports are not supported. Lists sinks.", "id": "logging.projects.sinks.list", "path": "v2/{+parent}/sinks" }, "patch": { "path": "v2/{+sinkName}", "id": "logging.projects.sinks.patch", "request": { "$ref": "LogSink" }, "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "parameters": { "sinkName": { "required": true, "pattern": "^projects/[^/]+/sinks/[^/]+$", "location": "path", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string" }, "uniqueWriterIdentity": { "type": "boolean", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "location": "query" }, "customWriterIdentity": { "location": "query", "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated." }, "updateMask": { "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "path": "v2/{+sinkName}", "id": "logging.projects.sinks.get", "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Gets a sink.", "parameters": { "sinkName": { "pattern": "^projects/[^/]+/sinks/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the sink: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "location": "path" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "logs": { "methods": { "list": { "httpMethod": "GET", "parameters": { "resourceNames": { "repeated": true, "type": "string", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "id": "logging.projects.logs.list", "path": "v2/{+parent}/logs", "flatPath": "v2/projects/{projectsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." } } } }, "methods": { "getSettings": { "flatPath": "v2/projects/{projectsId}/settings", "description": "Gets the settings for the given resource. Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts. See [View default resource settings for Logging] (https://documentation.s3ns.fr/logging/docs/default-settings#view-org-settings) for more information.", "path": "v2/{+name}/settings", "id": "logging.projects.getSettings", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource for which to retrieve settings. \"projects/[PROJECT_ID]/settings\" \"organizations/[ORGANIZATION_ID]/settings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"` Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts.", "required": true, "pattern": "^projects/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "logs": { "methods": { "list": { "flatPath": "v2/{v2Id}/{v2Id1}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "id": "logging.logs.list", "path": "v2/{+parent}/logs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "resourceNames": { "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." }, "parent": { "type": "string", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" } } } }, "billingAccounts": { "resources": { "locations": { "methods": { "get": { "parameters": { "name": { "description": "Resource name for the location.", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}", "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+name}", "id": "logging.billingAccounts.locations.get" }, "list": { "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "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." }, "name": { "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+$" }, "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)." } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/billingAccounts/{billingAccountsId}/locations", "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe.", "id": "logging.billingAccounts.locations.list", "path": "v2/{+name}/locations" } }, "resources": { "recentQueries": { "methods": { "list": { "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/recentQueries", "description": "Lists the RecentQueries that were created by the user making the request.", "id": "logging.billingAccounts.locations.recentQueries.list", "path": "v2/{+parent}/recentQueries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `projects/my-project/locations/us-central1` Note: The location portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all recent queries.", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") of the recent queries to list. The only valid value for this field is one of the two allowable `type` function calls, which are the following: * `type(\"Logging\")` * `type(\"OpsAnalytics\")`" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRecentQueriesResponse" } } } }, "operations": { "methods": { "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "request": { "$ref": "CancelOperationRequest" }, "path": "v2/{+name}:cancel", "id": "logging.billingAccounts.locations.operations.cancel", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+$" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "path": "v2/{+name}/operations", "id": "logging.billingAccounts.locations.operations.list", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "logging.billingAccounts.locations.operations.get", "path": "v2/{+name}", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "buckets": { "resources": { "views": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The bucket in which to create the view `\"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"` For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" }, "viewId": { "description": "Required. A client-assigned identifier such as `\"my-view\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogView" }, "httpMethod": "POST", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.", "request": { "$ref": "LogView" }, "path": "v2/{+parent}/views", "id": "logging.billingAccounts.locations.buckets.views.create" }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}", "id": "logging.billingAccounts.locations.buckets.views.delete", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes." }, "list": { "path": "v2/{+parent}/views", "id": "logging.billingAccounts.locations.buckets.views.list", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Lists views on a log bucket.", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", "location": "path", "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListViewsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "type": "string", "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `view` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "PATCH", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Updates a view on a log bucket. This method replaces the value of the `filter` field from the existing view with the corresponding value from the new view. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.", "request": { "$ref": "LogView" }, "path": "v2/{+name}", "id": "logging.billingAccounts.locations.buckets.views.patch" }, "get": { "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Gets a view on a log bucket.", "path": "v2/{+name}", "id": "logging.billingAccounts.locations.buckets.views.get", "parameters": { "name": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } }, "resources": { "logs": { "methods": { "list": { "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "id": "logging.billingAccounts.locations.buckets.views.logs.list", "path": "v2/{+parent}/logs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "type": "string" }, "resourceNames": { "location": "query", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string" }, "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" } } } } } } }, "methods": { "list": { "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose buckets are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBucketsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets", "description": "Lists log buckets.", "id": "logging.billingAccounts.locations.buckets.list", "path": "v2/{+parent}/buckets" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" }, "updateMask": { "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "request": { "$ref": "LogBucket" }, "id": "logging.billingAccounts.locations.buckets.patch", "path": "v2/{+name}", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Updates a log bucket. If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. After a bucket has been created, the bucket's location cannot be changed." }, "get": { "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Gets a log bucket.", "path": "v2/{+name}", "id": "logging.billingAccounts.locations.buckets.get", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "delete": { "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Deletes a log bucket. Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.", "id": "logging.billingAccounts.locations.buckets.delete", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The full resource name of the bucket to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" } }, "undelete": { "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the bucket to undelete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}:undelete", "id": "logging.billingAccounts.locations.buckets.undelete", "request": { "$ref": "UndeleteBucketRequest" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}:undelete", "description": "Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days." }, "create": { "parameters": { "bucketId": { "location": "query", "type": "string", "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character." }, "parent": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogBucket" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+parent}/buckets", "id": "logging.billingAccounts.locations.buckets.create", "request": { "$ref": "LogBucket" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets", "description": "Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed." } } }, "savedQueries": { "methods": { "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/us-central1\" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character `-` can be used for [LOCATION_ID], for example: \"projects/my-project/locations/-\"", "type": "string", "location": "path" }, "filter": { "type": "string", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the `type` function or a `visibility` token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character. The two supported `type` function calls are: * `type(\"Logging\")` * `type(\"OpsAnalytics\")` The two supported `visibility` tokens are: * `visibility = PRIVATE` * `visibility = SHARED` For example: `type(\"Logging\") AND visibility = PRIVATE` `visibility=SHARED type(\"OpsAnalytics\")` `type(\"OpsAnalytics)\"` `visibility = PRIVATE` `visibility = SHARED`", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSavedQueriesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+parent}/savedQueries", "id": "logging.billingAccounts.locations.savedQueries.list", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries", "description": "Lists the SavedQueries that were created by the user making the request." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "description": "Output only. Resource name of the saved query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support#bucket-regions) After the saved query is created, the location cannot be changed. If the user doesn't provide a [QUERY_ID], the system will generate an alphanumeric ID.", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/savedQueries/[^/]+$" }, "updateMask": { "location": "query", "description": "Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the `saved_query` and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. To update all mutable fields, specify an `update_mask` of `*`. For example, to change the description and query filter text of a saved query, specify an `update_mask` of `\"description, query.filter\"`.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Updates an existing SavedQuery.", "request": { "$ref": "SavedQuery" }, "id": "logging.billingAccounts.locations.savedQueries.patch", "path": "v2/{+name}" }, "get": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the saved query. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/savedQueries/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+name}", "id": "logging.billingAccounts.locations.savedQueries.get", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Returns all data associated with the requested query." }, "delete": { "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the saved query to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/savedQueries/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}", "id": "logging.billingAccounts.locations.savedQueries.delete", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Deletes an existing SavedQuery that was created by the user making the request." }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource in which to create the saved query: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/global\" \"organizations/123456789/locations/us-central1\"", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", "required": true }, "savedQueryId": { "description": "Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name. If the `saved_query_id` is not provided, the system will generate an alphanumeric ID. The `saved_query_id` is limited to 100 characters and can include only the following characters: * upper and lower-case alphanumeric characters, * underscores, * hyphens, * periods. First character has to be alphanumeric.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "POST", "request": { "$ref": "SavedQuery" }, "path": "v2/{+parent}/savedQueries", "id": "logging.billingAccounts.locations.savedQueries.create", "flatPath": "v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries", "description": "Creates a new SavedQuery for the user making the request." } } } } }, "exclusions": { "methods": { "create": { "request": { "$ref": "LogExclusion" }, "id": "logging.billingAccounts.exclusions.create", "path": "v2/{+parent}/exclusions", "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions", "description": "Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "description": "Required. The parent resource in which to create the exclusion: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-logging-project\"` `\"organizations/123456789\"`", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogExclusion" } }, "delete": { "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", "description": "Deletes an exclusion in the _Default sink.", "path": "v2/{+name}", "id": "logging.billingAccounts.exclusions.delete", "parameters": { "name": { "location": "path", "description": "Required. The resource name of an existing exclusion to delete: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "path": "v2/{+name}", "id": "logging.billingAccounts.exclusions.get", "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", "description": "Gets the description of an exclusion in the _Default sink.", "parameters": { "name": { "required": true, "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of an existing exclusion: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource whose exclusions are to be listed. \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+$", "required": true }, "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExclusionsResponse" }, "httpMethod": "GET", "path": "v2/{+parent}/exclusions", "id": "logging.billingAccounts.exclusions.list", "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions", "description": "Lists all the exclusions on the _Default sink in a parent resource." }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", "location": "path", "description": "Required. The resource name of the exclusion to update: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `\"filter,description\"`." } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.billingAccounts.exclusions.patch", "path": "v2/{+name}", "request": { "$ref": "LogExclusion" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", "description": "Changes one or more properties of an existing exclusion in the _Default sink." } } }, "sinks": { "methods": { "list": { "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "description": "BigQuery and GCS exports are not supported. Lists sinks.", "path": "v2/{+parent}/sinks", "id": "logging.billingAccounts.sinks.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "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 `nextPageToken` in the response indicates that more results might be available." }, "parent": { "type": "string", "description": "Required. The parent resource whose sinks are to be listed: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "location": "path", "pattern": "^billingAccounts/[^/]+$", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: * `''` * `'in_scope(\"ALL\")'`, * `'in_scope(\"ANCESTOR\")'`, * `'in_scope(\"DEFAULT\")'`. Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by `parent`. When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSinksResponse" }, "httpMethod": "GET" }, "patch": { "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "request": { "$ref": "LogSink" }, "path": "v2/{+sinkName}", "id": "logging.billingAccounts.sinks.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" }, "sinkName": { "location": "path", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "required": true, "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$" }, "uniqueWriterIdentity": { "type": "boolean", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "location": "query" }, "customWriterIdentity": { "location": "query", "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated." } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PATCH" }, "get": { "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Gets a sink.", "path": "v2/{+sinkName}", "id": "logging.billingAccounts.sinks.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "sinkName": { "required": true, "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the sink: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "GET" }, "update": { "path": "v2/{+sinkName}", "id": "logging.billingAccounts.sinks.update", "request": { "$ref": "LogSink" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" }, "sinkName": { "type": "string", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "location": "path", "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "required": true }, "uniqueWriterIdentity": { "type": "boolean", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "location": "query" }, "customWriterIdentity": { "location": "query", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "delete": { "id": "logging.billingAccounts.sinks.delete", "path": "v2/{+sinkName}", "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.", "httpMethod": "DELETE", "parameters": { "sinkName": { "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "required": true, "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "create": { "path": "v2/{+parent}/sinks", "id": "logging.billingAccounts.sinks.create", "request": { "$ref": "LogSink" }, "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "description": "BigQuery and GCS exports are not supported. Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "parameters": { "parent": { "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource in which to create the sink: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-project\"` `\"organizations/123456789\"`" }, "uniqueWriterIdentity": { "description": "Optional. Determines the kind of IAM identity returned as `writer_identity` in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as `writer_identity` is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of `writer_identity` will be a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see `writer_identity` in LogSink.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "location": "query", "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogSink" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "logs": { "methods": { "list": { "id": "logging.billingAccounts.logs.list", "path": "v2/{+parent}/logs", "flatPath": "v2/billingAccounts/{billingAccountsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "parent": { "required": true, "pattern": "^billingAccounts/[^/]+$", "location": "path", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "type": "string" }, "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 `nextPageToken` in the response indicates that more results might be available." }, "resourceNames": { "location": "query", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" } } } } }, "methods": { "getSettings": { "path": "v2/{+name}/settings", "id": "logging.billingAccounts.getSettings", "flatPath": "v2/billingAccounts/{billingAccountsId}/settings", "description": "Gets the settings for the given resource. Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts. See [View default resource settings for Logging] (https://documentation.s3ns.fr/logging/docs/default-settings#view-org-settings) for more information.", "parameters": { "name": { "pattern": "^billingAccounts/[^/]+$", "required": true, "type": "string", "description": "Required. The resource for which to retrieve settings. \"projects/[PROJECT_ID]/settings\" \"organizations/[ORGANIZATION_ID]/settings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"` Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts.", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "entries": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": {}, "parameterOrder": [], "response": { "$ref": "ListLogEntriesResponse" }, "httpMethod": "POST", "flatPath": "v2/entries:list", "description": "Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see [Exporting Logs](https://documentation.s3ns.fr/logging/routing/overview).", "request": { "$ref": "ListLogEntriesRequest" }, "path": "v2/entries:list", "id": "logging.entries.list" }, "write": { "request": { "$ref": "WriteLogEntriesRequest" }, "path": "v2/entries:write", "id": "logging.entries.write", "flatPath": "v2/entries:write", "description": "Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resource names (projects, organizations, billing accounts or folders), where the resource name for a log entry is determined from its `logName` field.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.write" ], "parameters": {}, "parameterOrder": [], "response": { "$ref": "WriteLogEntriesResponse" }, "httpMethod": "POST" } } }, "folders": { "resources": { "sinks": { "methods": { "create": { "parameters": { "parent": { "pattern": "^folders/[^/]+$", "required": true, "description": "Required. The resource in which to create the sink: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-project\"` `\"organizations/123456789\"`", "type": "string", "location": "path" }, "uniqueWriterIdentity": { "description": "Optional. Determines the kind of IAM identity returned as `writer_identity` in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as `writer_identity` is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of `writer_identity` will be a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see `writer_identity` in LogSink.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "location": "query", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogSink" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/folders/{foldersId}/sinks", "description": "BigQuery and GCS exports are not supported. Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "path": "v2/{+parent}/sinks", "id": "logging.folders.sinks.create", "request": { "$ref": "LogSink" } }, "get": { "parameters": { "sinkName": { "description": "Required. The resource name of the sink: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "location": "path", "pattern": "^folders/[^/]+/sinks/[^/]+$", "required": true } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Gets a sink.", "path": "v2/{+sinkName}", "id": "logging.folders.sinks.get" }, "list": { "flatPath": "v2/folders/{foldersId}/sinks", "description": "BigQuery and GCS exports are not supported. Lists sinks.", "path": "v2/{+parent}/sinks", "id": "logging.folders.sinks.list", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." }, "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 `nextPageToken` in the response indicates that more results might be available." }, "parent": { "location": "path", "description": "Required. The parent resource whose sinks are to be listed: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string", "required": true, "pattern": "^folders/[^/]+$" }, "filter": { "type": "string", "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: * `''` * `'in_scope(\"ALL\")'`, * `'in_scope(\"ANCESTOR\")'`, * `'in_scope(\"DEFAULT\")'`. Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by `parent`. When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSinksResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "parameters": { "sinkName": { "location": "path", "type": "string", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "required": true, "pattern": "^folders/[^/]+/sinks/[^/]+$" }, "uniqueWriterIdentity": { "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "type": "boolean", "location": "query" }, "customWriterIdentity": { "type": "string", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "location": "query" }, "updateMask": { "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+sinkName}", "id": "logging.folders.sinks.patch", "request": { "$ref": "LogSink" }, "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field." }, "update": { "path": "v2/{+sinkName}", "id": "logging.folders.sinks.update", "request": { "$ref": "LogSink" }, "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" }, "sinkName": { "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "location": "path", "pattern": "^folders/[^/]+/sinks/[^/]+$", "required": true }, "uniqueWriterIdentity": { "type": "boolean", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "location": "query" }, "customWriterIdentity": { "location": "query", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "delete": { "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.", "path": "v2/{+sinkName}", "id": "logging.folders.sinks.delete", "parameters": { "sinkName": { "required": true, "pattern": "^folders/[^/]+/sinks/[^/]+$", "location": "path", "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "logs": { "methods": { "list": { "id": "logging.folders.logs.list", "path": "v2/{+parent}/logs", "flatPath": "v2/folders/{foldersId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "httpMethod": "GET", "parameters": { "parent": { "required": true, "pattern": "^folders/[^/]+$", "location": "path", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "resourceNames": { "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "locations": { "resources": { "operations": { "methods": { "get": { "id": "logging.folders.locations.operations.get", "path": "v2/{+name}", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "list": { "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "logging.folders.locations.operations.list", "path": "v2/{+name}/operations", "httpMethod": "GET", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "CancelOperationRequest" }, "path": "v2/{+name}:cancel", "id": "logging.folders.locations.operations.cancel" } } }, "savedQueries": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent resource in which to create the saved query: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/global\" \"organizations/123456789/locations/us-central1\"", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$" }, "savedQueryId": { "description": "Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name. If the `saved_query_id` is not provided, the system will generate an alphanumeric ID. The `saved_query_id` is limited to 100 characters and can include only the following characters: * upper and lower-case alphanumeric characters, * underscores, * hyphens, * periods. First character has to be alphanumeric.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "POST", "request": { "$ref": "SavedQuery" }, "path": "v2/{+parent}/savedQueries", "id": "logging.folders.locations.savedQueries.create", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/savedQueries", "description": "Creates a new SavedQuery for the user making the request." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "location": "path", "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/us-central1\" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character `-` can be used for [LOCATION_ID], for example: \"projects/my-project/locations/-\"", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the `type` function or a `visibility` token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character. The two supported `type` function calls are: * `type(\"Logging\")` * `type(\"OpsAnalytics\")` The two supported `visibility` tokens are: * `visibility = PRIVATE` * `visibility = SHARED` For example: `type(\"Logging\") AND visibility = PRIVATE` `visibility=SHARED type(\"OpsAnalytics\")` `type(\"OpsAnalytics)\"` `visibility = PRIVATE` `visibility = SHARED`", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSavedQueriesResponse" }, "httpMethod": "GET", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/savedQueries", "description": "Lists the SavedQueries that were created by the user making the request.", "path": "v2/{+parent}/savedQueries", "id": "logging.folders.locations.savedQueries.list" }, "patch": { "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "required": true, "type": "string", "description": "Output only. Resource name of the saved query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support#bucket-regions) After the saved query is created, the location cannot be changed. If the user doesn't provide a [QUERY_ID], the system will generate an alphanumeric ID.", "location": "path" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the `saved_query` and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. To update all mutable fields, specify an `update_mask` of `*`. For example, to change the description and query filter text of a saved query, specify an `update_mask` of `\"description, query.filter\"`." } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Updates an existing SavedQuery.", "path": "v2/{+name}", "id": "logging.folders.locations.savedQueries.patch", "request": { "$ref": "SavedQuery" } }, "get": { "path": "v2/{+name}", "id": "logging.folders.locations.savedQueries.get", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Returns all data associated with the requested query.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name of the saved query. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/savedQueries/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "location": "path", "description": "Required. The full resource name of the saved query to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "logging.folders.locations.savedQueries.delete", "path": "v2/{+name}", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Deletes an existing SavedQuery that was created by the user making the request." } } }, "buckets": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "bucketId": { "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "type": "string", "location": "query" }, "parent": { "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogBucket" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets", "description": "Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.", "request": { "$ref": "LogBucket" }, "id": "logging.folders.locations.buckets.create", "path": "v2/{+parent}/buckets" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "type": "string", "description": "Required. The full resource name of the bucket to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Deletes a log bucket. Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.", "id": "logging.folders.locations.buckets.delete", "path": "v2/{+name}" }, "undelete": { "id": "logging.folders.locations.buckets.undelete", "path": "v2/{+name}:undelete", "request": { "$ref": "UndeleteBucketRequest" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}:undelete", "description": "Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the bucket to undelete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", "location": "path", "description": "Required. The resource name of the bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Gets a log bucket.", "id": "logging.folders.locations.buckets.get", "path": "v2/{+name}" }, "list": { "id": "logging.folders.locations.buckets.list", "path": "v2/{+parent}/buckets", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets", "description": "Lists log buckets.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource whose buckets are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBucketsResponse" } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$" }, "updateMask": { "location": "query", "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "request": { "$ref": "LogBucket" }, "id": "logging.folders.locations.buckets.patch", "path": "v2/{+name}", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Updates a log bucket. If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. After a bucket has been created, the bucket's location cannot be changed." } }, "resources": { "views": { "resources": { "logs": { "methods": { "list": { "id": "logging.folders.locations.buckets.views.logs.list", "path": "v2/{+parent}/logs", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" }, "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 `nextPageToken` in the response indicates that more results might be available." }, "resourceNames": { "location": "query", "repeated": true, "type": "string", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list." }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } } }, "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"", "type": "string", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListViewsResponse" }, "id": "logging.folders.locations.buckets.views.list", "path": "v2/{+parent}/views", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Lists views on a log bucket." }, "patch": { "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `view` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}", "id": "logging.folders.locations.buckets.views.patch", "request": { "$ref": "LogView" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Updates a view on a log bucket. This method replaces the value of the `filter` field from the existing view with the corresponding value from the new view. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes." }, "setIamPolicy": { "httpMethod": "POST", "parameters": { "resource": { "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.folders.locations.buckets.views.setIamPolicy", "path": "v2/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy", "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "id": "logging.folders.locations.buckets.views.get", "path": "v2/{+name}", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Gets a view on a log bucket." }, "getIamPolicy": { "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+resource}:getIamPolicy", "id": "logging.folders.locations.buckets.views.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy", "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe." }, "delete": { "path": "v2/{+name}", "id": "logging.folders.locations.buckets.views.delete", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" }, "testIamPermissions": { "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions", "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+resource}:testIamPermissions", "id": "logging.folders.locations.buckets.views.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameters": { "resource": { "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "viewId": { "location": "query", "description": "Required. A client-assigned identifier such as `\"my-view\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "type": "string" }, "parent": { "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The bucket in which to create the view `\"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"` For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogView" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.", "request": { "$ref": "LogView" }, "id": "logging.folders.locations.buckets.views.create", "path": "v2/{+parent}/views" } } } } }, "recentQueries": { "methods": { "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" }, "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `projects/my-project/locations/us-central1` Note: The location portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all recent queries." }, "filter": { "location": "query", "type": "string", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") of the recent queries to list. The only valid value for this field is one of the two allowable `type` function calls, which are the following: * `type(\"Logging\")` * `type(\"OpsAnalytics\")`" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRecentQueriesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/recentQueries", "description": "Lists the RecentQueries that were created by the user making the request.", "path": "v2/{+parent}/recentQueries", "id": "logging.folders.locations.recentQueries.list" } } }, "logScopes": { "methods": { "create": { "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true }, "logScopeId": { "type": "string", "description": "Required. A client-assigned identifier such as `\"log-scope\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.folders.locations.logScopes.create", "path": "v2/{+parent}/logScopes", "request": { "$ref": "LogScope" }, "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes", "description": "Creates a log scope." }, "delete": { "id": "logging.folders.locations.logScopes.delete", "path": "v2/{+name}", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Deletes a log scope.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" } }, "get": { "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Gets a log scope.", "id": "logging.folders.locations.logScopes.get", "path": "v2/{+name}", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\"", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogScopesResponse" }, "id": "logging.folders.locations.logScopes.list", "path": "v2/{+parent}/logScopes", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes", "description": "Lists log scopes." }, "patch": { "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Updates a log scope.", "request": { "$ref": "LogScope" }, "id": "logging.folders.locations.logScopes.patch", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true, "type": "string", "description": "Output only. The resource name of the log scope. Log scopes are only available in the `global` location. For example: `projects/my-project/locations/global/logScopes/my-log-scope`", "location": "path" }, "updateMask": { "location": "query", "description": "Optional. Field mask that specifies the fields in `log_scope` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=description`", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" } } } } }, "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "name": { "pattern": "^folders/[^/]+$", "required": true, "description": "The resource that owns the locations collection, if applicable.", "type": "string", "location": "path" }, "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)." }, "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", "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." } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v2/folders/{foldersId}/locations", "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe.", "id": "logging.folders.locations.list", "path": "v2/{+name}/locations" }, "get": { "path": "v2/{+name}", "id": "logging.folders.locations.get", "flatPath": "v2/folders/{foldersId}/locations/{locationsId}", "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "description": "Resource name for the location.", "type": "string", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "httpMethod": "GET" } } }, "exclusions": { "methods": { "create": { "flatPath": "v2/folders/{foldersId}/exclusions", "description": "Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", "request": { "$ref": "LogExclusion" }, "path": "v2/{+parent}/exclusions", "id": "logging.folders.exclusions.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "pattern": "^folders/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource in which to create the exclusion: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-logging-project\"` `\"organizations/123456789\"`", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogExclusion" }, "httpMethod": "POST" }, "delete": { "parameters": { "name": { "pattern": "^folders/[^/]+/exclusions/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of an existing exclusion to delete: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", "description": "Deletes an exclusion in the _Default sink.", "path": "v2/{+name}", "id": "logging.folders.exclusions.delete" }, "list": { "path": "v2/{+parent}/exclusions", "id": "logging.folders.exclusions.list", "flatPath": "v2/folders/{foldersId}/exclusions", "description": "Lists all the exclusions on the _Default sink in a parent resource.", "parameters": { "parent": { "required": true, "pattern": "^folders/[^/]+$", "location": "path", "description": "Required. The parent resource whose exclusions are to be listed. \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExclusionsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+/exclusions/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the exclusion to update: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`" }, "updateMask": { "description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `\"filter,description\"`.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", "description": "Changes one or more properties of an existing exclusion in the _Default sink.", "id": "logging.folders.exclusions.patch", "path": "v2/{+name}", "request": { "$ref": "LogExclusion" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of an existing exclusion: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "location": "path", "pattern": "^folders/[^/]+/exclusions/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", "description": "Gets the description of an exclusion in the _Default sink.", "id": "logging.folders.exclusions.get", "path": "v2/{+name}" } } } }, "methods": { "getSettings": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^folders/[^/]+$", "required": true, "description": "Required. The resource for which to retrieve settings. \"projects/[PROJECT_ID]/settings\" \"organizations/[ORGANIZATION_ID]/settings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"` Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "id": "logging.folders.getSettings", "path": "v2/{+name}/settings", "flatPath": "v2/folders/{foldersId}/settings", "description": "Gets the settings for the given resource. Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts. See [View default resource settings for Logging] (https://documentation.s3ns.fr/logging/docs/default-settings#view-org-settings) for more information." }, "updateSettings": { "flatPath": "v2/folders/{foldersId}/settings", "description": "Updates the settings for the given resource. This method applies to all feature configurations for organization and folders. UpdateSettings fails when any of the following are true: * The value of `storage_location` either isn't supported by Logging or violates the location OrgPolicy. * The `default_sink_config` field is set, but it has an unspecified filter write mode. * The value of `kms_key_name` is invalid. * The associated service account doesn't have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. * Access to the key is disabled. See [Configure default settings for organizations and folders] (https://documentation.s3ns.fr/logging/docs/default-settings) for more information.", "path": "v2/{+name}/settings", "id": "logging.folders.updateSettings", "request": { "$ref": "Settings" }, "parameters": { "name": { "required": true, "pattern": "^folders/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"`" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask identifying which fields from `settings` should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated. See FieldMask for more information. For example: `\"updateMask=kmsKeyName\"`", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "locations": { "methods": { "get": { "path": "v2/{+name}", "id": "logging.locations.get", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}", "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "location": "path", "description": "Resource name for the location.", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "httpMethod": "GET" }, "list": { "httpMethod": "GET", "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32", "location": "query" }, "name": { "required": true, "pattern": "^[^/]+/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "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": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "type": "string", "location": "query" }, "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." } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/locations", "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe.", "id": "logging.locations.list", "path": "v2/{+name}/locations" } }, "resources": { "operations": { "methods": { "cancel": { "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "CancelOperationRequest" }, "path": "v2/{+name}:cancel", "id": "logging.locations.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "id": "logging.locations.operations.get", "path": "v2/{+name}", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+$" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v2/{+name}/operations", "id": "logging.locations.operations.list" } } }, "buckets": { "resources": { "views": { "methods": { "setIamPolicy": { "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy", "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe.", "request": { "$ref": "SetIamPolicyRequest" }, "path": "v2/{+resource}:setIamPolicy", "id": "logging.locations.buckets.views.setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "httpMethod": "POST" }, "get": { "parameters": { "name": { "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Gets a view on a log bucket.", "path": "v2/{+name}", "id": "logging.locations.buckets.views.get" }, "list": { "parameters": { "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListViewsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+parent}/views", "id": "logging.locations.buckets.views.list", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Lists views on a log bucket." }, "patch": { "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Updates a view on a log bucket. This method replaces the value of the `filter` field from the existing view with the corresponding value from the new view. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.", "request": { "$ref": "LogView" }, "path": "v2/{+name}", "id": "logging.locations.buckets.views.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `view` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "httpMethod": "PATCH" }, "getIamPolicy": { "request": { "$ref": "GetIamPolicyRequest" }, "id": "logging.locations.buckets.views.getIamPolicy", "path": "v2/{+resource}:getIamPolicy", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy", "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "POST", "parameters": { "resource": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "logging.locations.buckets.views.delete", "path": "v2/{+name}", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes." }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "type": "string", "description": "Required. The bucket in which to create the view `\"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"` For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "location": "path" }, "viewId": { "location": "query", "description": "Required. A client-assigned identifier such as `\"my-view\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogView" }, "httpMethod": "POST", "request": { "$ref": "LogView" }, "path": "v2/{+parent}/views", "id": "logging.locations.buckets.views.create", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views." }, "testIamPermissions": { "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions", "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+resource}:testIamPermissions", "id": "logging.locations.buckets.views.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" } } } } }, "methods": { "list": { "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource whose buckets are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBucketsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "id": "logging.locations.buckets.list", "path": "v2/{+parent}/buckets", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets", "description": "Lists log buckets." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "name": { "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true }, "updateMask": { "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "httpMethod": "PATCH", "request": { "$ref": "LogBucket" }, "path": "v2/{+name}", "id": "logging.locations.buckets.patch", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}", "description": "Updates a log bucket. If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. After a bucket has been created, the bucket's location cannot be changed." }, "get": { "parameters": { "name": { "description": "Required. The resource name of the bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+name}", "id": "logging.locations.buckets.get", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}", "description": "Gets a log bucket." }, "delete": { "id": "logging.locations.buckets.delete", "path": "v2/{+name}", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}", "description": "Deletes a log bucket. Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The full resource name of the bucket to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "undelete": { "parameters": { "name": { "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The full resource name of the bucket to undelete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}:undelete", "id": "logging.locations.buckets.undelete", "request": { "$ref": "UndeleteBucketRequest" }, "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets/{bucketsId}:undelete", "description": "Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days." }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "bucketId": { "location": "query", "type": "string", "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character." }, "parent": { "required": true, "pattern": "^[^/]+/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogBucket" }, "httpMethod": "POST", "flatPath": "v2/{v2Id}/{v2Id1}/locations/{locationsId}/buckets", "description": "Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.", "request": { "$ref": "LogBucket" }, "path": "v2/{+parent}/buckets", "id": "logging.locations.buckets.create" } } } } }, "organizations": { "resources": { "locations": { "resources": { "recentQueries": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `projects/my-project/locations/us-central1` Note: The location portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all recent queries.", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true }, "filter": { "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") of the recent queries to list. The only valid value for this field is one of the two allowable `type` function calls, which are the following: * `type(\"Logging\")` * `type(\"OpsAnalytics\")`", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRecentQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/recentQueries", "description": "Lists the RecentQueries that were created by the user making the request.", "id": "logging.organizations.locations.recentQueries.list", "path": "v2/{+parent}/recentQueries" } } }, "logScopes": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "id": "logging.organizations.locations.logScopes.get", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Gets a log scope." }, "list": { "path": "v2/{+parent}/logScopes", "id": "logging.organizations.locations.logScopes.list", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes", "description": "Lists log scopes.", "parameters": { "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\"", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogScopesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "parameters": { "name": { "location": "path", "type": "string", "description": "Output only. The resource name of the log scope. Log scopes are only available in the `global` location. For example: `projects/my-project/locations/global/logScopes/my-log-scope`", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$" }, "updateMask": { "location": "query", "description": "Optional. Field mask that specifies the fields in `log_scope` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=description`", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogScope" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}", "id": "logging.organizations.locations.logScopes.patch", "request": { "$ref": "LogScope" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Updates a log scope." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/logScopes/my-log-scope\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.organizations.locations.logScopes.delete", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", "description": "Deletes a log scope." }, "create": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes", "description": "Creates a log scope.", "request": { "$ref": "LogScope" }, "path": "v2/{+parent}/logScopes", "id": "logging.organizations.locations.logScopes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource in which to create the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`", "type": "string" }, "logScopeId": { "description": "Required. A client-assigned identifier such as `\"log-scope\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogScope" }, "httpMethod": "POST" } } }, "buckets": { "resources": { "views": { "resources": { "logs": { "methods": { "list": { "parameters": { "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "resourceNames": { "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "repeated": true, "type": "string", "location": "query" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "path": "v2/{+parent}/logs", "id": "logging.organizations.locations.buckets.views.logs.list", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." } } } }, "methods": { "list": { "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Lists views on a log bucket.", "id": "logging.organizations.locations.buckets.views.list", "path": "v2/{+parent}/views" }, "patch": { "id": "logging.organizations.locations.buckets.views.patch", "path": "v2/{+name}", "request": { "$ref": "LogView" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Updates a view on a log bucket. This method replaces the value of the `filter` field from the existing view with the corresponding value from the new view. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `view` that need an update. A field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "resource": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field." } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "path": "v2/{+resource}:setIamPolicy", "id": "logging.organizations.locations.buckets.views.setIamPolicy", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy", "description": "The google.iam.v1.IAMPolicy.SetIamPolicy method is not available in this (s3nsapis.fr) universe." }, "get": { "id": "logging.organizations.locations.buckets.views.get", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Gets a view on a log bucket.", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "getIamPolicy": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy", "description": "The google.iam.v1.IAMPolicy.GetIamPolicy method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+resource}:getIamPolicy", "id": "logging.organizations.locations.buckets.views.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "delete": { "id": "logging.organizations.locations.buckets.views.delete", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}", "description": "Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket/views/my-view\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "testIamPermissions": { "httpMethod": "POST", "parameters": { "resource": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://documentation.s3ns.fr/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions", "description": "The google.iam.v1.IAMPolicy.TestIamPermissions method is not available in this (s3nsapis.fr) universe.", "id": "logging.organizations.locations.buckets.views.testIamPermissions", "path": "v2/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" } }, "create": { "id": "logging.organizations.locations.buckets.views.create", "path": "v2/{+parent}/views", "request": { "$ref": "LogView" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views", "description": "Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.", "httpMethod": "POST", "parameters": { "viewId": { "type": "string", "description": "Required. A client-assigned identifier such as `\"my-view\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query" }, "parent": { "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The bucket in which to create the view `\"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\"` For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } } }, "methods": { "create": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets", "description": "Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.", "request": { "$ref": "LogBucket" }, "id": "logging.organizations.locations.buckets.create", "path": "v2/{+parent}/buckets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "bucketId": { "type": "string", "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "location": "query" }, "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogBucket" } }, "get": { "id": "logging.organizations.locations.buckets.get", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Gets a log bucket.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" } }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32" }, "parent": { "location": "path", "description": "Required. The parent resource whose buckets are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBucketsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets", "description": "Lists log buckets.", "id": "logging.organizations.locations.buckets.list", "path": "v2/{+parent}/buckets" }, "patch": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Updates a log bucket. If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. After a bucket has been created, the bucket's location cannot be changed.", "id": "logging.organizations.locations.buckets.patch", "path": "v2/{+name}", "request": { "$ref": "LogBucket" }, "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true }, "updateMask": { "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogBucket" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "delete": { "path": "v2/{+name}", "id": "logging.organizations.locations.buckets.delete", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}", "description": "Deletes a log bucket. Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, "description": "Required. The full resource name of the bucket to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "undelete": { "httpMethod": "POST", "parameters": { "name": { "type": "string", "description": "Required. The full resource name of the bucket to undelete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.organizations.locations.buckets.undelete", "path": "v2/{+name}:undelete", "request": { "$ref": "UndeleteBucketRequest" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}:undelete", "description": "Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days." } } }, "operations": { "methods": { "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "CancelOperationRequest" }, "id": "logging.organizations.locations.operations.cancel", "path": "v2/{+name}:cancel" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "id": "logging.organizations.locations.operations.get", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "list": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "logging.organizations.locations.operations.list", "path": "v2/{+name}/operations", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } }, "savedQueries": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "description": "Required. The full resource name of the saved query to delete. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/savedQueries/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "logging.organizations.locations.savedQueries.delete", "path": "v2/{+name}", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Deletes an existing SavedQuery that was created by the user making the request." }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the saved query. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For example: \"projects/my-project/locations/global/savedQueries/my-saved-query\"" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Returns all data associated with the requested query.", "id": "logging.organizations.locations.savedQueries.get", "path": "v2/{+name}" }, "list": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries", "description": "Lists the SavedQueries that were created by the user making the request.", "path": "v2/{+parent}/savedQueries", "id": "logging.organizations.locations.savedQueries.list", "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 `nextPageToken` in the response indicates that more results might be available." }, "parent": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource to which the listed queries belong. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/us-central1\" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character `-` can be used for [LOCATION_ID], for example: \"projects/my-project/locations/-\"", "type": "string" }, "filter": { "location": "query", "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the `type` function or a `visibility` token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character. The two supported `type` function calls are: * `type(\"Logging\")` * `type(\"OpsAnalytics\")` The two supported `visibility` tokens are: * `visibility = PRIVATE` * `visibility = SHARED` For example: `type(\"Logging\") AND visibility = PRIVATE` `visibility=SHARED type(\"OpsAnalytics\")` `type(\"OpsAnalytics)\"` `visibility = PRIVATE` `visibility = SHARED`", "type": "string" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSavedQueriesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/savedQueries/[^/]+$", "required": true, "description": "Output only. Resource name of the saved query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support#bucket-regions) After the saved query is created, the location cannot be changed. If the user doesn't provide a [QUERY_ID], the system will generate an alphanumeric ID.", "type": "string", "location": "path" }, "updateMask": { "description": "Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the `saved_query` and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. To update all mutable fields, specify an `update_mask` of `*`. For example, to change the description and query filter text of a saved query, specify an `update_mask` of `\"description, query.filter\"`.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "SavedQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "id": "logging.organizations.locations.savedQueries.patch", "path": "v2/{+name}", "request": { "$ref": "SavedQuery" }, "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}", "description": "Updates an existing SavedQuery." }, "create": { "request": { "$ref": "SavedQuery" }, "path": "v2/{+parent}/savedQueries", "id": "logging.organizations.locations.savedQueries.create", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries", "description": "Creates a new SavedQuery for the user making the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource in which to create the saved query: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/global\" \"organizations/123456789/locations/us-central1\"", "type": "string", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$" }, "savedQueryId": { "description": "Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name. If the `saved_query_id` is not provided, the system will generate an alphanumeric ID. The `saved_query_id` is limited to 100 characters and can include only the following characters: * upper and lower-case alphanumeric characters, * underscores, * hyphens, * periods. First character has to be alphanumeric.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SavedQuery" }, "httpMethod": "POST" } } } }, "methods": { "list": { "parameters": { "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." }, "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" }, "name": { "location": "path", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^organizations/[^/]+$" }, "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": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/locations", "description": "The google.cloud.location.Locations.ListLocations method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+name}/locations", "id": "logging.organizations.locations.list" }, "get": { "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}", "description": "The google.cloud.location.Locations.GetLocation method is not available in this (s3nsapis.fr) universe.", "path": "v2/{+name}", "id": "logging.organizations.locations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Resource name for the location." } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "httpMethod": "GET" } } }, "exclusions": { "methods": { "delete": { "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", "description": "Deletes an exclusion in the _Default sink.", "id": "logging.organizations.exclusions.delete", "path": "v2/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^organizations/[^/]+/exclusions/[^/]+$", "required": true, "description": "Required. The resource name of an existing exclusion to delete: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] }, "get": { "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", "description": "Gets the description of an exclusion in the _Default sink.", "id": "logging.organizations.exclusions.get", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The resource name of an existing exclusion: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "type": "string", "required": true, "pattern": "^organizations/[^/]+/exclusions/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" }, "parent": { "location": "path", "description": "Required. The parent resource whose exclusions are to be listed. \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "type": "string", "required": true, "pattern": "^organizations/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExclusionsResponse" }, "httpMethod": "GET", "flatPath": "v2/organizations/{organizationsId}/exclusions", "description": "Lists all the exclusions on the _Default sink in a parent resource.", "path": "v2/{+parent}/exclusions", "id": "logging.organizations.exclusions.list" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^organizations/[^/]+/exclusions/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the exclusion to update: \"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\" \"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\" \"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\" For example: `\"projects/my-project/exclusions/my-exclusion\"`", "location": "path" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request. For example, to change the filter and description of an exclusion, specify an `update_mask` of `\"filter,description\"`.", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LogExclusion" }, "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", "description": "Changes one or more properties of an existing exclusion in the _Default sink.", "request": { "$ref": "LogExclusion" }, "id": "logging.organizations.exclusions.patch", "path": "v2/{+name}" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource in which to create the exclusion: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-logging-project\"` `\"organizations/123456789\"`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogExclusion" }, "request": { "$ref": "LogExclusion" }, "id": "logging.organizations.exclusions.create", "path": "v2/{+parent}/exclusions", "flatPath": "v2/organizations/{organizationsId}/exclusions", "description": "Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." } } }, "sinks": { "methods": { "list": { "flatPath": "v2/organizations/{organizationsId}/sinks", "description": "BigQuery and GCS exports are not supported. Lists sinks.", "path": "v2/{+parent}/sinks", "id": "logging.organizations.sinks.list", "parameters": { "pageToken": { "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "location": "query" }, "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 `nextPageToken` in the response indicates that more results might be available." }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource whose sinks are to be listed: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\"", "required": true, "pattern": "^organizations/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: * `''` * `'in_scope(\"ALL\")'`, * `'in_scope(\"ANCESTOR\")'`, * `'in_scope(\"DEFAULT\")'`. Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by `parent`. When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListSinksResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] }, "patch": { "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "request": { "$ref": "LogSink" }, "id": "logging.organizations.sinks.patch", "path": "v2/{+sinkName}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "PATCH", "parameters": { "sinkName": { "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/sinks/[^/]+$", "required": true }, "uniqueWriterIdentity": { "location": "query", "type": "boolean", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false." }, "customWriterIdentity": { "location": "query", "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`", "location": "query" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" } }, "get": { "parameters": { "sinkName": { "location": "path", "type": "string", "description": "Required. The resource name of the sink: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "required": true, "pattern": "^organizations/[^/]+/sinks/[^/]+$" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Gets a sink.", "path": "v2/{+sinkName}", "id": "logging.organizations.sinks.get" }, "update": { "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes: `destination,filter,includeChildren` At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=filter`" }, "sinkName": { "pattern": "^organizations/[^/]+/sinks/[^/]+$", "required": true, "type": "string", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "location": "path" }, "uniqueWriterIdentity": { "location": "query", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of `writer_identity` in the updated sink depends on both the old and new values of this field: * If the old and new values of this field are both false or both true, then there is no change to the sink's `writer_identity`. * If the old value is false and the new value is true, then `writer_identity` is changed to a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) owned by Cloud Logging. * It is an error if the old value is true and the new value is set to false or defaulted to false.", "type": "boolean" }, "customWriterIdentity": { "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string", "location": "query" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "LogSink" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Updates a sink. This method replaces the values of the `destination` and `filter` fields of the existing sink with the corresponding values from the new sink. The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.", "path": "v2/{+sinkName}", "id": "logging.organizations.sinks.update", "request": { "$ref": "LogSink" } }, "delete": { "id": "logging.organizations.sinks.delete", "path": "v2/{+sinkName}", "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", "description": "BigQuery and GCS exports are not supported. Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "httpMethod": "DELETE", "parameters": { "sinkName": { "location": "path", "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: \"projects/[PROJECT_ID]/sinks/[SINK_ID]\" \"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\" \"folders/[FOLDER_ID]/sinks/[SINK_ID]\" For example: `\"projects/my-project/sinks/my-sink\"`", "type": "string", "required": true, "pattern": "^organizations/[^/]+/sinks/[^/]+$" } }, "parameterOrder": [ "sinkName" ], "response": { "$ref": "Empty" } }, "create": { "path": "v2/{+parent}/sinks", "id": "logging.organizations.sinks.create", "request": { "$ref": "LogSink" }, "flatPath": "v2/organizations/{organizationsId}/sinks", "description": "BigQuery and GCS exports are not supported. Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "parameters": { "parent": { "location": "path", "description": "Required. The resource in which to create the sink: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" For examples: `\"projects/my-project\"` `\"organizations/123456789\"`", "type": "string", "required": true, "pattern": "^organizations/[^/]+$" }, "uniqueWriterIdentity": { "location": "query", "type": "boolean", "description": "Optional. Determines the kind of IAM identity returned as `writer_identity` in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as `writer_identity` is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of `writer_identity` will be a [service agent](https://documentation.s3ns.fr/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see `writer_identity` in LogSink." }, "customWriterIdentity": { "description": "Optional. The service account provided by the caller that will be used to write the log entries. The format must be `serviceAccount:some@email`. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LogSink" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ] } } }, "logs": { "methods": { "list": { "flatPath": "v2/organizations/{organizationsId}/logs", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "id": "logging.organizations.logs.list", "path": "v2/{+parent}/logs", "httpMethod": "GET", "parameters": { "resourceNames": { "repeated": true, "type": "string", "description": "Optional. List of resource names to list logs for: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` To support legacy queries, it could also be: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` The resource name in the `parent` field is added to this list.", "location": "query" }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "location": "query" }, "parent": { "required": true, "pattern": "^organizations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name to list logs for: * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]`" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListLogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ] } } } }, "methods": { "getSettings": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource for which to retrieve settings. \"projects/[PROJECT_ID]/settings\" \"organizations/[ORGANIZATION_ID]/settings\" \"billingAccounts/[BILLING_ACCOUNT_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"` Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts.", "required": true, "pattern": "^organizations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "flatPath": "v2/organizations/{organizationsId}/settings", "description": "Gets the settings for the given resource. Note: Settings can be retrieved for Cloud de Confiance Cloud projects, folders, organizations, and billing accounts. See [View default resource settings for Logging] (https://documentation.s3ns.fr/logging/docs/default-settings#view-org-settings) for more information.", "id": "logging.organizations.getSettings", "path": "v2/{+name}/settings" }, "updateSettings": { "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example: `\"organizations/12345/settings\"`" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask identifying which fields from `settings` should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated. See FieldMask for more information. For example: `\"updateMask=kmsKeyName\"`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Settings" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], "path": "v2/{+name}/settings", "id": "logging.organizations.updateSettings", "request": { "$ref": "Settings" }, "flatPath": "v2/organizations/{organizationsId}/settings", "description": "Updates the settings for the given resource. This method applies to all feature configurations for organization and folders. UpdateSettings fails when any of the following are true: * The value of `storage_location` either isn't supported by Logging or violates the location OrgPolicy. * The `default_sink_config` field is set, but it has an unspecified filter write mode. * The value of `kms_key_name` is invalid. * The associated service account doesn't have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. * Access to the key is disabled. See [Configure default settings for organizations and folders] (https://documentation.s3ns.fr/logging/docs/default-settings) for more information." } } }, "monitoredResourceDescriptors": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], "parameters": { "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call." } }, "parameterOrder": [], "response": { "$ref": "ListMonitoredResourceDescriptorsResponse" }, "httpMethod": "GET", "flatPath": "v2/monitoredResourceDescriptors", "description": "Lists the descriptors for monitored resource types used by Logging.", "path": "v2/monitoredResourceDescriptors", "id": "logging.monitoredResourceDescriptors.list" } } } }, "documentationLink": "https://documentation.s3ns.fr/logging", "id": "logging:v2", "parameters": { "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" }, "alt": { "description": "Data format for response.", "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "enum": [ "json", "media", "proto" ], "default": "json" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ] }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "oauth_token": { "location": "query", "type": "string", "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" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." } }, "discoveryVersion": "v1", "version": "v2", "basePath": "", "version_module": true, "protocol": "rest", "name": "logging", "title": "Cloud Logging API", "kind": "discovery#restDescription", "description": "Writes log entries and manages your Cloud Logging configuration.", "schemas": { "ListLogEntriesResponse": { "id": "ListLogEntriesResponse", "type": "object", "description": "Result returned from `ListLogEntries`.", "properties": { "entries": { "description": "A list of log entries. If `entries` is empty, `nextPageToken` may still be returned, indicating that more entries may exist. See `nextPageToken` for more information.", "items": { "$ref": "LogEntry" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "If there might be more results than those appearing in this response, then `nextPageToken` is included. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`. If a value for `next_page_token` appears and the `entries` field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for `page_token` to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search." } } }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "properties": { "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } }, "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object" }, "DefaultSinkConfig": { "type": "object", "description": "Describes the custom `_Default` sink configuration that is used to override the built-in `_Default` sink configuration in newly created resource containers, such as projects or folders.", "properties": { "exclusions": { "type": "array", "description": "Optional. Specifies the set of exclusions to be added to the `_Default` sink in newly created resource containers.", "items": { "$ref": "LogExclusion" } }, "mode": { "type": "string", "enumDescriptions": [ "The filter's write mode is unspecified. This mode must not be used.", "The contents of `filter` will be appended to the built-in `_Default` sink filter. Using the append mode with an empty filter will keep the sink inclusion filter unchanged.", "The contents of `filter` will overwrite the built-in `_Default` sink filter." ], "description": "Required. Determines the behavior to apply to the built-in `_Default` sink inclusion filter. Exclusions are always appended, as built-in `_Default` sinks have no exclusions.", "enum": [ "FILTER_WRITE_MODE_UNSPECIFIED", "APPEND", "OVERWRITE" ] }, "filter": { "type": "string", "description": "Optional. An [advanced logs filter](https://documentation.s3ns.fr/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: `logName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR` To match all logs, don't add exclusions and use the following line as the value of `filter`: `logName:*` Cannot be empty or unset when the value of `mode` is `OVERWRITE`." } }, "id": "DefaultSinkConfig" }, "SummaryField": { "description": "A field from the LogEntry that is [added to the summary line](https://documentation.s3ns.fr/logging/docs/view/logs-explorer-interface#add-summary-fields) for a query in the Logs Explorer.", "properties": { "field": { "description": "Optional. The field from the LogEntry to include in the summary line, for example `resource.type` or `jsonPayload.name`.", "type": "string" } }, "type": "object", "id": "SummaryField" }, "ListSinksResponse": { "type": "object", "description": "Result returned from `ListSinks`.", "properties": { "sinks": { "type": "array", "description": "A list of sinks.", "items": { "$ref": "LogSink" } }, "nextPageToken": { "type": "string", "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`." } }, "id": "ListSinksResponse" }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}", "properties": { "type": { "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.", "type": "string" }, "labels": { "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "id": "MonitoredResource" }, "Policy": { "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Cloud de Confiance groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Cloud de Confiance Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://documentation.s3ns.fr/iam/docs/).", "properties": { "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Cloud de Confiance groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" }, "type": "array" }, "etag": { "type": "string", "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost." }, "version": { "type": "integer", "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies)." } }, "type": "object" }, "ListLogEntriesRequest": { "description": "The parameters to `ListLogEntries`.", "properties": { "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return from this request. Default is 50. If the value is negative, the request is rejected. The presence of `next_page_token` in the response indicates that more results might be available." }, "projectIds": { "deprecated": true, "type": "array", "description": "Optional. Deprecated. Use `resource_names` instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: `\"my-project-1A\"`.", "items": { "type": "string" } }, "resourceNames": { "description": "Required. Names of one or more parent resources from which to retrieve log entries. Resources may either be resource containers or specific `LogViews`. For the case of resource containers, all logs ingested into that container will be returned regardless of which `LogBuckets` they are actually stored in - i.e. these queries may fan out to multiple regions. In the event of region unavailability, specify a specific set of `LogViews` that do not include the unavailable region. * `projects/[PROJECT_ID]` * `organizations/[ORGANIZATION_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]` * `folders/[FOLDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` Projects listed in the `project_ids` field are added to this list. A maximum of 100 resources may be specified in a single request.", "items": { "type": "string" }, "type": "array" }, "pageToken": { "type": "string", "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." }, "filter": { "description": "Optional. A filter that chooses which log entries to return. For more information, see [Logging query language] (https://documentation.s3ns.fr/logging/docs/view/logging-query-language). Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in `resource_names`. Referencing a parent resource that is not listed in `resource_names` will cause the filter to return no results. The maximum length of a filter is 20,000 characters. To make queries faster, you can make the filter more selective by using restrictions on [indexed fields] (https://documentation.s3ns.fr/logging/docs/view/logging-query-language#indexed-fields) as well as limit the time range of the query by adding range restrictions on the `timestamp` field.", "type": "string" }, "orderBy": { "description": "Optional. How the results should be sorted. Presently, the only permitted values are `\"timestamp asc\"` (default) and `\"timestamp desc\"`. The first option returns entries in order of increasing values of `LogEntry.timestamp` (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their `insert_id` values. We recommend setting the `order_by` field to `\"timestamp desc\"` when listing recently ingested log entries. If not set, the default value of `\"timestamp asc\"` may take a long time to fetch matching logs that are only recently ingested.", "type": "string" } }, "type": "object", "id": "ListLogEntriesRequest" }, "ListLogsResponse": { "id": "ListLogsResponse", "description": "Result returned from ListLogs.", "properties": { "logNames": { "type": "array", "description": "A list of log names. For example, `\"projects/my-project/logs/syslog\"` or `\"organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity\"`.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "If there might be more results than those appearing in this response, then `nextPageToken` is included. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`." } }, "type": "object" }, "UndeleteBucketRequest": { "description": "The parameters to `UndeleteBucket`.", "properties": {}, "type": "object", "id": "UndeleteBucketRequest" }, "RequestLog": { "id": "RequestLog", "type": "object", "description": "Complete log information about a single HTTP request to an App Engine application.", "properties": { "appId": { "description": "Application that handled this request.", "type": "string" }, "endTime": { "description": "Time when the request finished.", "type": "string", "format": "google-datetime" }, "latency": { "description": "Latency of the request.", "type": "string", "format": "google-duration" }, "megaCycles": { "description": "Number of CPU megacycles used to process request.", "type": "string", "format": "int64" }, "taskQueueName": { "description": "Queue name of the request, in the case of an offline request.", "type": "string" }, "appEngineRelease": { "description": "App Engine release version.", "type": "string" }, "referrer": { "description": "Referrer URL of request.", "type": "string" }, "moduleId": { "type": "string", "description": "Module of the application that handled this request." }, "line": { "type": "array", "description": "A list of log lines emitted by the application while serving this request.", "items": { "$ref": "LogLine" } }, "httpVersion": { "description": "HTTP version of request. Example: `\"HTTP/1.1\"`.", "type": "string" }, "method": { "type": "string", "description": "Request method. Example: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`, `\"DELETE\"`." }, "instanceId": { "type": "string", "description": "An identifier for the instance that handled the request." }, "ip": { "type": "string", "description": "Origin IP address." }, "host": { "description": "Internet host and port number of the resource being requested.", "type": "string" }, "sourceReference": { "type": "array", "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", "items": { "$ref": "SourceReference" } }, "pendingTime": { "description": "Time this request spent in the pending request queue.", "type": "string", "format": "google-duration" }, "urlMapEntry": { "description": "File or class that handled the request.", "type": "string" }, "instanceIndex": { "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.", "type": "integer", "format": "int32" }, "requestId": { "type": "string", "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier." }, "traceSampled": { "description": "If true, the value in the 'trace_id' field was sampled for storage in a trace backend.", "type": "boolean" }, "first": { "description": "Whether this is the first `RequestLog` entry for this request. If an active request has several `RequestLog` entries written to Stackdriver Logging, then this field will be set for one of them.", "type": "boolean" }, "startTime": { "description": "Time when the request started.", "type": "string", "format": "google-datetime" }, "taskName": { "description": "Task name of the request, in the case of an offline request.", "type": "string" }, "nickname": { "description": "The logged-in user who made the request. Most likely, this is the part of the user's email before the `@` sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API. This field will be populated starting with App Engine 1.9.21.", "type": "string" }, "traceId": { "description": "Stackdriver Trace identifier for this request.", "type": "string" }, "resource": { "type": "string", "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the `#` character, is not included." }, "wasLoadingRequest": { "description": "Whether this was a loading request for the instance.", "type": "boolean" }, "userAgent": { "type": "string", "description": "User agent that made the request." }, "status": { "description": "HTTP response status code. Example: 200, 404.", "type": "integer", "format": "int32" }, "spanId": { "type": "string", "description": "Stackdriver Trace span identifier for this request." }, "cost": { "description": "An indication of the relative cost of serving this request.", "type": "number", "format": "double" }, "responseSize": { "description": "Size in bytes sent back to client by request.", "type": "string", "format": "int64" }, "versionId": { "type": "string", "description": "Version of the application that handled this request." }, "finished": { "description": "Whether this request is finished or active.", "type": "boolean" } } }, "LogSplit": { "type": "object", "description": "Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Cloud de Confiance Cloud Logging size limit and is split across multiple log entries.", "properties": { "uid": { "type": "string", "description": "A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries." }, "totalSplits": { "description": "The total number of log entries that the original LogEntry was split into.", "type": "integer", "format": "int32" }, "index": { "description": "The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries.", "type": "integer", "format": "int32" } }, "id": "LogSplit" }, "HttpRequest": { "id": "HttpRequest", "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", "properties": { "requestMethod": { "type": "string", "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`." }, "status": { "type": "integer", "format": "int32", "description": "The response code indicating the status of response. Examples: 200, 404." }, "userAgent": { "type": "string", "description": "The user agent sent by the client. Example: `\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`." }, "responseSize": { "type": "string", "format": "int64", "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body." }, "referer": { "type": "string", "description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://datatracker.ietf.org/doc/html/rfc2616#section-14.36)." }, "cacheHit": { "type": "boolean", "description": "Whether or not an entity was served from cache (with or without validation)." }, "cacheFillBytes": { "type": "string", "format": "int64", "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted." }, "requestSize": { "type": "string", "format": "int64", "description": "The size of the HTTP request message in bytes, including the request headers and the request body." }, "remoteIp": { "type": "string", "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. This field can include port information. Examples: `\"192.168.1.1\"`, `\"10.0.0.1:80\"`, `\"FE80::0202:B3FF:FE1E:8329\"`." }, "latency": { "description": "The request processing latency on the server, from the time the request was received until the response was sent. For WebSocket connections, this field refers to the entire time duration of the connection.", "type": "string", "format": "google-duration" }, "protocol": { "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\"", "type": "string" }, "cacheValidatedWithOriginServer": { "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.", "type": "boolean" }, "requestUrl": { "type": "string", "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `\"http://example.com/some/info?color=red\"`." }, "serverIp": { "type": "string", "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `\"192.168.1.1\"`, `\"10.0.0.1:80\"`, `\"FE80::0202:B3FF:FE1E:8329\"`." }, "cacheLookup": { "description": "Whether or not a cache lookup was attempted.", "type": "boolean" } }, "type": "object" }, "AppHubWorkload": { "id": "AppHubWorkload", "type": "object", "description": "Metadata associated with an App Hub workload.", "properties": { "id": { "description": "Workload Id. Example: \"my-workload\"", "type": "string" }, "environmentType": { "type": "string", "description": "Workload environment type Example: \"DEV\"" }, "criticalityType": { "type": "string", "description": "Workload criticality type Example: \"CRITICAL\"" } } }, "Location": { "id": "Location", "description": "A resource that represents a Cloud de Confiance Cloud location.", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "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." } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." } }, "type": "object" }, "GetIamPolicyRequest": { "id": "GetIamPolicyRequest", "type": "object", "description": "Request message for `GetIamPolicy` method.", "properties": { "options": { "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.", "$ref": "GetPolicyOptions" } } }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "type": "object" }, "WriteLogEntriesRequest": { "description": "The parameters to WriteLogEntries.", "properties": { "entries": { "description": "Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's `log_name`, `resource`, and `labels` fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type. If the `timestamp` or `insert_id` fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the `entries.list` method. Log entries with timestamps that are more than the [logs retention period](https://documentation.s3ns.fr/logging/quotas) in the past or more than 24 hours in the future will not be available when calling `entries.list`. However, those log entries can still be [exported with LogSinks](https://documentation.s3ns.fr/logging/docs/api/tasks/exporting-logs). To improve throughput and to avoid exceeding the [quota limit](https://documentation.s3ns.fr/logging/quotas) for calls to `entries.write`, you should try to include several log entries in this list, rather than calling this method for each individual log entry.", "items": { "$ref": "LogEntry" }, "type": "array" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Default labels that are added to the `labels` field of all log entries in `entries`. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry." }, "dryRun": { "type": "boolean", "description": "Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data." }, "logName": { "type": "string", "description": "Optional. A default log resource name that is assigned to all log entries in `entries` that do not specify a value for `log_name`: * `projects/[PROJECT_ID]/logs/[LOG_ID]` * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]` * `folders/[FOLDER_ID]/logs/[LOG_ID]` `[LOG_ID]` must be URL-encoded. For example: \"projects/my-project-id/logs/syslog\" \"organizations/123/logs/cloudaudit.googleapis.com%2Factivity\" The permission `logging.logEntries.create` is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in `logName` or in an individual log entry." }, "partialSuccess": { "description": "Optional. Whether a batch's valid entries should be written even if some other entry failed due to a permanent error such as INVALID_ARGUMENT or PERMISSION_DENIED. If any entry failed, then the response status is the response status of one of the failed entries. The response will include error details in `WriteLogEntriesPartialErrors.log_entry_errors` keyed by the entries' zero-based index in the `entries`. Failed requests for which no entries are written will not include per-entry errors.", "type": "boolean" }, "resource": { "description": "Optional. A default monitored resource object that is assigned to all log entries in `entries` that do not specify a value for `resource`. Example: { \"type\": \"gce_instance\", \"labels\": { \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }} See LogEntry.", "$ref": "MonitoredResource" } }, "type": "object", "id": "WriteLogEntriesRequest" }, "CreateBucketRequest": { "id": "CreateBucketRequest", "description": "The parameters to `CreateBucket`.", "properties": { "parent": { "type": "string", "description": "Required. The resource in which to create the log bucket: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global\"`" }, "bucket": { "$ref": "LogBucket", "description": "Required. The new bucket. The region specified in the new bucket must be compliant with any Location Restriction Org Policy. The name field in the bucket is ignored." }, "bucketId": { "description": "Required. A client-assigned identifier such as `\"my-bucket\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.", "type": "string" } }, "type": "object" }, "Expr": { "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "properties": { "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "title": { "type": "string", "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression." } }, "id": "Expr" }, "SourceLocation": { "id": "SourceLocation", "type": "object", "description": "Specifies a location in a source code file.", "properties": { "file": { "type": "string", "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name." }, "line": { "description": "Line within the source file.", "type": "string", "format": "int64" }, "functionName": { "type": "string", "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python)." } } }, "LogExclusion": { "type": "object", "description": "Specifies a set of log entries that are filtered out by a sink. If your Cloud de Confiance Cloud resource receives a large volume of log entries, you can use exclusions to reduce your chargeable logs. Note that exclusions on organization-level and folder-level sinks don't apply to child resources. Note also that you cannot modify the _Required sink or exclude logs from it.", "properties": { "name": { "description": "Optional. A client-assigned identifier, such as `\"load-balancer-exclusion\"`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", "type": "string" }, "filter": { "description": "Required. An [advanced logs filter](https://documentation.s3ns.fr/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the [sample function](https://documentation.s3ns.fr/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries. For example, the following query matches 99% of low-severity log entries from Cloud de Confiance Cloud Storage buckets: `resource.type=gcs_bucket severity", "type": "string" }, "description": { "description": "Optional. A description of this exclusion.", "type": "string" }, "disabled": { "description": "Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.", "type": "boolean" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The last update timestamp of the exclusion. This field may not be present for older exclusions.", "readOnly": true }, "createTime": { "description": "Output only. The creation timestamp of the exclusion. This field may not be present for older exclusions.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "LogExclusion" }, "WriteLogEntriesResponse": { "type": "object", "description": "Result returned from WriteLogEntries.", "properties": {}, "id": "WriteLogEntriesResponse" }, "LocationMetadata": { "description": "Cloud Logging specific location metadata.", "properties": { "logAnalyticsEnabled": { "description": "Indicates whether or not Log Analytics features are supported in the given location.", "type": "boolean" } }, "type": "object", "id": "LocationMetadata" }, "ListSavedQueriesResponse": { "description": "The response from ListSavedQueries.", "properties": { "savedQueries": { "description": "A list of saved queries.", "items": { "$ref": "SavedQuery" }, "type": "array" }, "nextPageToken": { "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`.", "type": "string" }, "unreachable": { "description": "The unreachable resources. It can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachabe. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: \"projects/my-project/locations/global/savedQueries/12345678\" \"projects/my-project/locations/global\" If there are unreachable resources, the response will first return pages that contain saved queries, and then return pages that contain the unreachable resources.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "ListSavedQueriesResponse" }, "SavedQuery": { "type": "object", "description": "Describes a query that has been saved by a user.", "properties": { "updateTime": { "description": "Output only. The timestamp when the saved query was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "Output only. Resource name of the saved query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support#bucket-regions) After the saved query is created, the location cannot be changed. If the user doesn't provide a [QUERY_ID], the system will generate an alphanumeric ID.", "readOnly": true, "type": "string" }, "description": { "description": "Optional. A human readable description of the saved query.", "type": "string" }, "loggingQuery": { "$ref": "LoggingQuery", "description": "Logging query that can be executed in Logs Explorer or via Logging API." }, "createTime": { "description": "Output only. The timestamp when the saved query was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. The user specified title for the SavedQuery.", "type": "string" }, "visibility": { "description": "Required. The visibility status of this query, which determines its ownership.", "enum": [ "VISIBILITY_UNSPECIFIED", "PRIVATE", "SHARED" ], "type": "string", "enumDescriptions": [ "The saved query visibility is unspecified. A `CreateSavedQuery` request with an unspecified visibility will be rejected.", "The saved query is only visible to the user that created it.", "The saved query is visible to anyone in the project." ] } }, "id": "SavedQuery" }, "LoggingQuery": { "type": "object", "description": "Describes a Cloud Logging query that can be run in Logs Explorer UI or via the logging API. In addition to the query itself, additional information may be stored to capture the display configuration and other UI state used in association with analysis of query results.", "properties": { "summaryFieldStart": { "type": "integer", "format": "int32", "description": "Characters will be counted from the start of the string." }, "summaryFields": { "description": "Optional. The set of summary fields to display for this saved query.", "items": { "$ref": "SummaryField" }, "type": "array" }, "summaryFieldEnd": { "description": "Characters will be counted from the end of the string.", "type": "integer", "format": "int32" }, "filter": { "description": "Required. An [advanced query using the Logging Query Language](https://documentation.s3ns.fr/logging/docs/view/logging-query-language). The maximum length of the filter is 20000 characters.", "type": "string" } }, "id": "LoggingQuery" }, "LogLine": { "type": "object", "description": "Application log line emitted while processing a request.", "properties": { "time": { "type": "string", "format": "google-datetime", "description": "Approximate time when this log entry was made." }, "logMessage": { "description": "App-provided log message.", "type": "string" }, "severity": { "type": "string", "enumDescriptions": [ "(0) The log entry has no assigned severity level.", "(100) Debug or trace information.", "(200) Routine information, such as ongoing status or performance.", "(300) Normal but significant events, such as start up, shut down, or a configuration change.", "(400) Warning events might cause problems.", "(500) Error events are likely to cause problems.", "(600) Critical events cause more severe problems or outages.", "(700) A person must take an action immediately.", "(800) One or more systems are unusable." ], "description": "Severity of this log entry.", "enum": [ "DEFAULT", "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "CRITICAL", "ALERT", "EMERGENCY" ] }, "sourceLocation": { "$ref": "SourceLocation", "description": "Where in the source code this log message was written." } }, "id": "LogLine" }, "UpdateBucketRequest": { "id": "UpdateBucketRequest", "description": "The parameters to `UpdateBucket`.", "properties": { "updateMask": { "description": "Required. Field mask that specifies the fields in `bucket` that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated. For a detailed `FieldMask` definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask For example: `updateMask=retention_days`", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Required. The full resource name of the bucket to update. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" For example: `\"projects/my-project/locations/global/buckets/my-bucket\"`", "type": "string" }, "bucket": { "$ref": "LogBucket", "description": "Required. The updated bucket." } }, "type": "object" }, "AppHubService": { "id": "AppHubService", "description": "Metadata associated with an App Hub service.", "properties": { "id": { "type": "string", "description": "Service Id. Example: \"my-service\"" }, "environmentType": { "description": "Service environment type Example: \"DEV\"", "type": "string" }, "criticalityType": { "type": "string", "description": "Service criticality type Example: \"CRITICAL\"" } }, "type": "object" }, "TestIamPermissionsRequest": { "id": "TestIamPermissionsRequest", "type": "object", "description": "Request message for `TestIamPermissions` method.", "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://documentation.s3ns.fr/iam/docs/overview#permissions).", "items": { "type": "string" } } } }, "Operation": { "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "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}`." }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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`." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." } }, "id": "Operation" }, "AppHub": { "id": "AppHub", "description": "Metadata associated with App Hub.", "properties": { "application": { "description": "Metadata associated with the application.", "$ref": "AppHubApplication" }, "service": { "$ref": "AppHubService", "description": "Metadata associated with the service." }, "workload": { "$ref": "AppHubWorkload", "description": "Metadata associated with the workload." } }, "type": "object" }, "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://documentation.s3ns.fr/apis/design/errors).", "properties": { "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "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" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "type": "object", "id": "Status" }, "ListRecentQueriesResponse": { "id": "ListRecentQueriesResponse", "description": "The response from ListRecentQueries.", "properties": { "nextPageToken": { "type": "string", "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`." }, "unreachable": { "type": "array", "description": "The unreachable resources. Each resource can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachable. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]\" \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example: `\"projects/my-project/locations/global/recentQueries/12345678\"` `\"projects/my-project/locations/global\"` If there are unreachable resources, the response will first return pages that contain recent queries, and then return pages that contain the unreachable resources.", "items": { "type": "string" } }, "recentQueries": { "description": "A list of recent queries.", "items": { "$ref": "RecentQuery" }, "type": "array" } }, "type": "object" }, "SetIamPolicyRequest": { "type": "object", "description": "Request message for `SetIamPolicy` method.", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud de Confiance Cloud services (such as Projects) might reject them.", "$ref": "Policy" } }, "id": "SetIamPolicyRequest" }, "LogEntry": { "type": "object", "description": "An individual entry in a log.", "properties": { "severity": { "description": "Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.", "enum": [ "DEFAULT", "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "CRITICAL", "ALERT", "EMERGENCY" ], "type": "string", "enumDescriptions": [ "(0) The log entry has no assigned severity level.", "(100) Debug or trace information.", "(200) Routine information, such as ongoing status or performance.", "(300) Normal but significant events, such as start up, shut down, or a configuration change.", "(400) Warning events might cause problems.", "(500) Error events are likely to cause problems.", "(600) Critical events cause more severe problems or outages.", "(700) A person must take an action immediately.", "(800) One or more systems are unusable." ] }, "traceSampled": { "type": "boolean", "description": "Optional. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to [the sampled flag in the W3C trace-context specification](https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled `trace` value is still useful as a request correlation identifier. The default is False." }, "insertId": { "type": "string", "description": "Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same `timestamp`, and with the same `insert_id` to be duplicates which are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs. If the `insert_id` is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field. In queries, the `insert_id` is also used to order log entries that have the same `log_name` and `timestamp` values." }, "errorGroups": { "description": "Output only. The [Error Reporting](https://documentation.s3ns.fr/error-reporting) error groups associated with this LogEntry. Error Reporting sets the values for this field during error group creation. For more information, see [View error details]( https://documentation.s3ns.fr/error-reporting/docs/viewing-errors#view_error_details) This field isn't available during [log routing](https://documentation.s3ns.fr/logging/docs/routing/overview)", "readOnly": true, "items": { "$ref": "LogErrorGroup" }, "type": "array" }, "labels": { "description": "Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined. User-defined labels are arbitrary key, value pairs that you can use to classify logs. System-defined labels are defined by cloud services for platform logs. They have two components - a service namespace component and the attribute name. For example: `compute.googleapis.com/resource_name`. Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.", "type": "object", "additionalProperties": { "type": "string" } }, "protoPayload": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The log entry payload, represented as a protocol buffer. Some Cloud de Confiance Cloud Platform services use this field for their log entry payloads. The following protocol buffer types are supported; user-defined types are not supported: \"type.googleapis.com/google.cloud.audit.AuditLog\" \"type.googleapis.com/google.appengine.logging.v1.RequestLog\"" }, "jsonPayload": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "The log entry payload, represented as a structure that is expressed as a JSON object." }, "sourceLocation": { "$ref": "LogEntrySourceLocation", "description": "Optional. Source code location information associated with the log entry, if any." }, "spanId": { "description": "Optional. The ID of the [Cloud Trace](https://documentation.s3ns.fr/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of \"projects/some-project/traces/some-trace/spans/some-span-id\", then the `span_id` field is \"some-span-id\". A [Span](https://documentation.s3ns.fr/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace. Applications that are [instrumented for tracing](https://documentation.s3ns.fr/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies. The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random. Example values: - `000000000000004a` - `7a2190356c3fc94b` - `0000f00300090021` - `d39223e101960076`", "type": "string" }, "apphubDestination": { "$ref": "AppHub", "description": "Output only. AppHub application metadata associated with the destination application. This is only populated if the log represented \"edge\"-like data (such as for VPC flow logs) with a destination.", "readOnly": true }, "otel": { "description": "Optional. The structured OpenTelemetry protocol payload. Contains the OpenTelemetry Resource, Instrumentation Scope, and Entities attributes for this log as they are defined in the OTLP specification, and any other fields that do not have a direct analog in the LogEntry. See https://opentelemetry.io/docs/specs/otel/logs/data-model/", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "textPayload": { "type": "string", "description": "The log entry payload, represented as a Unicode string (UTF-8)." }, "timestamp": { "type": "string", "format": "google-datetime", "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. Incoming log entries must have timestamps that don't exceed the [logs retention period](https://documentation.s3ns.fr/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging." }, "metadata": { "deprecated": true, "$ref": "MonitoredResourceMetadata", "description": "Output only. Deprecated. This field is not used by Logging. Any value written to it is cleared.", "readOnly": true }, "operation": { "description": "Optional. Information about an operation associated with the log entry, if applicable.", "$ref": "LogEntryOperation" }, "resource": { "$ref": "MonitoredResource", "description": "Required. The monitored resource that produced this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error." }, "trace": { "description": "Optional. The REST resource name of the trace being written to [Cloud Trace](https://documentation.s3ns.fr/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project \"my-trace-project\" and if the service that is creating the log entry receives a trace header that includes the trace ID \"12345\", then the service should use \"projects/my-trace-project/traces/12345\". The `trace` field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace.", "type": "string" }, "receiveTimestamp": { "type": "string", "format": "google-datetime", "description": "Output only. The time the log entry was received by Logging.", "readOnly": true }, "apphub": { "$ref": "AppHub", "description": "Output only. AppHub application metadata associated with this LogEntry. May be empty if there is no associated AppHub application or multiple associated applications (such as for VPC flow logs)", "readOnly": true }, "apphubSource": { "description": "Output only. AppHub application metadata associated with the source application. This is only populated if the log represented \"edge\"-like data (such as for VPC flow logs) with a source.", "readOnly": true, "$ref": "AppHub" }, "httpRequest": { "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.", "$ref": "HttpRequest" }, "logName": { "type": "string", "description": "Required. The resource name of the log to which this log entry belongs: \"projects/[PROJECT_ID]/logs/[LOG_ID]\" \"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\" \"folders/[FOLDER_ID]/logs/[LOG_ID]\" A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the `log_name` field will contain PROJECT_ID in queries and exports. `[LOG_ID]` must be URL-encoded within `log_name`. Example: `\"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\"`. `[LOG_ID]` must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period. For backward compatibility, if `log_name` begins with a forward-slash, such as `/projects/...`, then the log entry is processed as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results." }, "split": { "description": "Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.", "$ref": "LogSplit" } }, "id": "LogEntry" }, "ListMonitoredResourceDescriptorsResponse": { "description": "Result returned from ListMonitoredResourceDescriptors.", "properties": { "resourceDescriptors": { "description": "A list of resource descriptors.", "items": { "$ref": "MonitoredResourceDescriptor" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "If there might be more results than those appearing in this response, then `nextPageToken` is included. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`." } }, "type": "object", "id": "ListMonitoredResourceDescriptorsResponse" }, "MonitoredResourceDescriptor": { "type": "object", "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Cloud de Confiance Compute Engine VM instances has a type of `\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.", "properties": { "labels": { "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Cloud de Confiance Cloud SQL database is identified by values for the labels `\"database_id\"` and `\"zone\"`.", "items": { "$ref": "LabelDescriptor" }, "type": "array" }, "displayName": { "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `\"Cloud de Confiance Cloud SQL Database\"`.", "type": "string" }, "launchStage": { "description": "Optional. The launch stage of the monitored resource definition.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ], "type": "string", "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our Terms of Service(https://documentation.s3ns.fr/terms/) and the Cloud de Confiance Platform Subject to the Deprecation Policy(https://documentation.s3ns.fr/terms/deprecation) documentation." ] }, "name": { "type": "string", "description": "Optional. The resource name of the monitored resource descriptor: `\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `\"monitoredResourceDescriptors/{type}\"`." }, "type": { "type": "string", "description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Cloud de Confiance Cloud SQL. For a list of types, see [Monitored resource types](https://documentation.s3ns.fr/monitoring/api/resources) and [Logging resource types](https://documentation.s3ns.fr/logging/docs/api/v2/resource-list)." }, "description": { "type": "string", "description": "Optional. A detailed description of the monitored resource type that might be used in documentation." } }, "id": "MonitoredResourceDescriptor" }, "Settings": { "id": "Settings", "description": "Describes the settings associated with a project, folder, organization, or billing account.", "properties": { "disableDefaultSink": { "description": "Optional. If set to true, the `_Default` sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The `_Default` sink can be re-enabled manually if needed.", "type": "boolean" }, "kmsKeyName": { "type": "string", "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\"` To enable CMEK, set this field to a valid `kms_key_name` for which the associated service account has the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://documentation.s3ns.fr/logging/docs/routing/managed-encryption) for more information." }, "kmsServiceAccountId": { "type": "string", "description": "Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK, you must first assign the role `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that will be used to access your Cloud KMS key. Use GetSettings to obtain the service account ID. See [Enabling CMEK for Log Router](https://documentation.s3ns.fr/logging/docs/routing/managed-encryption) for more information.", "readOnly": true }, "name": { "type": "string", "description": "Output only. The resource name of the settings.", "readOnly": true }, "loggingServiceAccountId": { "type": "string", "description": "Output only. The service account for the given resource container, such as project or folder. Log sinks use this service account as their `writer_identity` if no custom service account is provided in the request when calling the create sink method.", "readOnly": true }, "storageLocation": { "type": "string", "description": "Optional. The storage location for the `_Default` and `_Required` log buckets of newly created projects and folders, unless the storage location is explicitly provided. Example value: `europe-west1`. Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets." }, "defaultSinkConfig": { "description": "Optional. Overrides the built-in configuration for `_Default` sink.", "$ref": "DefaultSinkConfig" } }, "type": "object" }, "LogView": { "type": "object", "description": "Describes a view over log entries in a bucket.", "properties": { "createTime": { "description": "Output only. The creation timestamp of the view.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The last update timestamp of the view.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "description": "Optional. Describes this view.", "type": "string" }, "name": { "type": "string", "description": "Output only. The resource name of the view. For example: `projects/my-project/locations/global/buckets/my-bucket/views/my-view`", "readOnly": true }, "filter": { "type": "string", "description": "Optional. Filter that restricts which log entries in a bucket are visible in this view. Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: * `SOURCE()`, which specifies a project, folder, organization, or billing account of origin. * `resource.type`, which specifies the resource type. * `LOG_ID()`, which identifies the log. They can also use the negations of these qualifiers with the NOT operator. For example: SOURCE(\"projects/myproject\") AND resource.type = \"gce_instance\" AND NOT LOG_ID(\"stdout\")" } }, "id": "LogView" }, "ListLogScopesResponse": { "id": "ListLogScopesResponse", "description": "The response from `ListLogScopes`. Every project has a `_Default` log scope that cannot be modified or deleted.", "properties": { "logScopes": { "description": "A list of log scopes.", "items": { "$ref": "LogScope" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`." } }, "type": "object" }, "AppHubApplication": { "description": "Resource identifiers associated with an AppHub application AppHub resources are of the form projects//locations//applications/ projects//locations//applications//services/ projects//locations//applications//workloads/ These resources can be reconstructed from the components below.", "properties": { "location": { "description": "Location associated with the Application. Example: \"us-east1\"", "type": "string" }, "id": { "description": "Application Id. Example: \"my-app\"", "type": "string" }, "container": { "description": "Resource container that owns the application. Example: \"projects/management_project\"", "type": "string" } }, "type": "object", "id": "AppHubApplication" }, "BucketMetadata": { "id": "BucketMetadata", "description": "Metadata for LongRunningUpdateBucket Operations.", "properties": { "startTime": { "description": "The create time of an operation.", "type": "string", "format": "google-datetime" }, "state": { "enum": [ "OPERATION_STATE_UNSPECIFIED", "OPERATION_STATE_SCHEDULED", "OPERATION_STATE_WAITING_FOR_PERMISSIONS", "OPERATION_STATE_RUNNING", "OPERATION_STATE_SUCCEEDED", "OPERATION_STATE_FAILED", "OPERATION_STATE_CANCELLED", "OPERATION_STATE_PENDING" ], "description": "Output only. State of an operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "Should not be used.", "The operation is scheduled.", "Waiting for necessary permissions.", "The operation is running.", "The operation was completed successfully.", "The operation failed.", "The operation was cancelled by the user.", "The operation is waiting for quota." ] }, "createBucketRequest": { "$ref": "CreateBucketRequest", "description": "LongRunningCreateBucket RPC request." }, "endTime": { "description": "The end time of an operation.", "type": "string", "format": "google-datetime" }, "updateBucketRequest": { "$ref": "UpdateBucketRequest", "description": "LongRunningUpdateBucket RPC request." } }, "type": "object" }, "IndexConfig": { "description": "Configuration for an indexed field.", "properties": { "fieldPath": { "type": "string", "description": "Required. The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://documentation.s3ns.fr/logging/docs/analyze/custom-index) for details. For example: `jsonPayload.request.status`" }, "type": { "type": "string", "enumDescriptions": [ "The index's type is unspecified.", "The index is a string-type index.", "The index is a integer-type index." ], "description": "Required. The type of data in this index.", "enum": [ "INDEX_TYPE_UNSPECIFIED", "INDEX_TYPE_STRING", "INDEX_TYPE_INTEGER" ] }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when the index was last modified. This is used to return the timestamp, and will be ignored if supplied during update.", "readOnly": true } }, "type": "object", "id": "IndexConfig" }, "LogEntryOperation": { "id": "LogEntryOperation", "description": "Additional information about a potentially long-running operation with which a log entry is associated.", "properties": { "id": { "type": "string", "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation." }, "producer": { "description": "Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", "type": "string" }, "first": { "type": "boolean", "description": "Optional. Set this to True if this is the first log entry in the operation." }, "last": { "type": "boolean", "description": "Optional. Set this to True if this is the last log entry in the operation." } }, "type": "object" }, "TestIamPermissionsResponse": { "type": "object", "description": "Response message for `TestIamPermissions` method.", "properties": { "permissions": { "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" } } }, "id": "TestIamPermissionsResponse" }, "LogSink": { "id": "LogSink", "type": "object", "description": "Describes a sink used to export log entries to one of the following destinations: * a Cloud Logging log bucket, * a Cloud Storage bucket, * a BigQuery dataset, * a Pub/Sub topic, * a Cloud project. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.", "properties": { "outputVersionFormat": { "deprecated": true, "type": "string", "enumDescriptions": [ "An unspecified format version that will default to V2.", "`LogEntry` version 2 format.", "`LogEntry` version 1 format." ], "description": "Deprecated. This field is unused.", "enum": [ "VERSION_FORMAT_UNSPECIFIED", "V2", "V1" ] }, "createTime": { "description": "Output only. The creation timestamp of the sink. This field may not be present for older sinks.", "readOnly": true, "type": "string", "format": "google-datetime" }, "exclusions": { "description": "Optional. Log entries that match any of these exclusion filters will not be exported. If a log entry is matched by both `filter` and one of `exclusions` it will not be exported.", "items": { "$ref": "LogExclusion" }, "type": "array" }, "name": { "description": "Optional. The client-assigned sink identifier, unique within the project. For example: `\"my-syslog-errors-to-pubsub\"`. Sink identifiers are limited to 100 characters and can include only the following characters: * upper and lower-case alphanumeric characters, * underscores, * hyphens, * periods. First character has to be alphanumeric.", "type": "string" }, "destination": { "description": "Required. The export destination: \"storage.googleapis.com/[GCS_BUCKET]\" \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\" \"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\" \"logging.googleapis.com/projects/[PROJECT_ID]\" \"logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" The sink's `writer_identity`, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see [Exporting Logs with Sinks](https://documentation.s3ns.fr/logging/docs/routing/overview).", "type": "string" }, "filter": { "type": "string", "description": "Optional. An [advanced logs filter](https://documentation.s3ns.fr/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: `logName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR`" }, "writerIdentity": { "description": "Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying `custom_writer_identity` or set automatically by sinks.create and sinks.update based on the value of `unique_writer_identity` in those methods. Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see [Granting Access for a Resource](https://documentation.s3ns.fr/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity. Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required.", "readOnly": true, "type": "string" }, "description": { "description": "Optional. A description of this sink. The maximum length of the description is 8000 characters.", "type": "string" }, "interceptChildren": { "description": "Optional. This field applies only to sinks owned by organizations and folders. When the value of 'intercept_children' is true, the following restrictions apply: * The sink must have the `include_children` flag set to true. * The sink destination must be a Cloud project. Also, the following behaviors apply: * Any logs matched by the sink won't be included by non-`_Required` sinks owned by child resources. * The sink appears in the results of a `ListSinks` call from a child resource if the value of the `filter` field in its request is either `'in_scope(\"ALL\")'` or `'in_scope(\"ANCESTOR\")'`.", "type": "boolean" }, "disabled": { "type": "boolean", "description": "Optional. If set to true, then this sink is disabled and it does not export any log entries." }, "updateTime": { "description": "Output only. The last update timestamp of the sink. This field may not be present for older sinks.", "readOnly": true, "type": "string", "format": "google-datetime" }, "includeChildren": { "type": "boolean", "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter `resource.type=gce_instance` would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND resource.type=gce_instance" }, "resourceName": { "description": "Output only. The resource name of the sink. \"projects/[PROJECT_ID]/sinks/[SINK_NAME] \"organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] \"folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME", "readOnly": true, "type": "string" } } }, "LogErrorGroup": { "id": "LogErrorGroup", "type": "object", "description": "Contains metadata that associates the LogEntry to Error Reporting error groups.", "properties": { "id": { "description": "The id is a unique identifier for a particular error group; it is the last part of the error group resource name: `/project/[PROJECT_ID]/errors/[ERROR_GROUP_ID]`. Example: `COShysOX0r_51QE`. The id is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Cloud de Confiance Cloud Privacy Notice](https://documentation.s3ns.fr/terms/cloud-privacy-notice).", "type": "string" } } }, "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": { "type": "string", "description": "The standard List next-page token." } } }, "ListExclusionsResponse": { "description": "Result returned from `ListExclusions`.", "properties": { "nextPageToken": { "type": "string", "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`." }, "exclusions": { "type": "array", "description": "A list of exclusions.", "items": { "$ref": "LogExclusion" } } }, "type": "object", "id": "ListExclusionsResponse" }, "ListBucketsResponse": { "id": "ListBucketsResponse", "type": "object", "description": "The response from ListBuckets.", "properties": { "buckets": { "type": "array", "description": "A list of buckets.", "items": { "$ref": "LogBucket" } }, "nextPageToken": { "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`.", "type": "string" } } }, "SourceReference": { "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", "properties": { "repository": { "type": "string", "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"" }, "revisionId": { "type": "string", "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"" } }, "type": "object", "id": "SourceReference" }, "ListViewsResponse": { "type": "object", "description": "The response from ListViews.", "properties": { "nextPageToken": { "description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`.", "type": "string" }, "views": { "description": "A list of views.", "items": { "$ref": "LogView" }, "type": "array" } }, "id": "ListViewsResponse" }, "MonitoredResourceMetadata": { "id": "MonitoredResourceMetadata", "type": "object", "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.", "properties": { "systemLabels": { "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Cloud de Confiance, including \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { \"name\": \"my-test-instance\", \"security_group\": [\"a\", \"b\", \"c\"], \"spot_instance\": false }", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "userLabels": { "description": "Output only. A map of user-defined metadata labels.", "type": "object", "additionalProperties": { "type": "string" } } } }, "CmekSettings": { "id": "CmekSettings", "type": "object", "description": "Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource. Note: CMEK for the Log Router can currently only be configured for Cloud de Confiance Cloud organizations. Once configured, it applies to all projects and folders in the Cloud de Confiance Cloud organization. See [Enabling CMEK for Log Router](https://documentation.s3ns.fr/logging/docs/routing/managed-encryption) for more information.", "properties": { "kmsKeyName": { "type": "string", "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\"` To enable CMEK for the Log Router, set this field to a valid `kms_key_name` for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the `kms_key_name` to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See [Enabling CMEK for Log Router](https://documentation.s3ns.fr/logging/docs/routing/managed-encryption) for more information." }, "name": { "type": "string", "description": "Output only. The resource name of the CMEK settings.", "readOnly": true }, "kmsKeyVersionName": { "description": "Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: \"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 is a read-only field used to convey the specific configured CryptoKeyVersion of `kms_key` that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. If this field is populated, the `kms_key` is tied to a specific CryptoKeyVersion. ", "readOnly": true, "type": "string" }, "serviceAccountId": { "type": "string", "description": "Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID. See [Enabling CMEK for Log Router](https://documentation.s3ns.fr/logging/docs/routing/managed-encryption) for more information.", "readOnly": true } } }, "GetPolicyOptions": { "type": "object", "description": "Encapsulates settings provided to GetIamPolicy.", "properties": { "requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" } }, "id": "GetPolicyOptions" }, "RecentQuery": { "id": "RecentQuery", "description": "Describes a recent query executed on the Logs Explorer or Log Analytics page within the last ~ 30 days.", "properties": { "loggingQuery": { "$ref": "LoggingQuery", "description": "Logging query that can be executed in Logs Explorer or via Logging API." }, "lastRunTime": { "description": "Output only. The timestamp when this query was last run.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "Output only. Resource name of the recent query. In the format: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]\" For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support) The [QUERY_ID] is a system generated alphanumeric ID.", "readOnly": true, "type": "string" } }, "type": "object" }, "LogEntrySourceLocation": { "id": "LogEntrySourceLocation", "description": "Additional information about the source code location that produced the log entry.", "properties": { "file": { "type": "string", "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name." }, "line": { "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", "type": "string", "format": "int64" }, "function": { "type": "string", "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python)." } }, "type": "object" }, "LogBucket": { "type": "object", "description": "Describes a repository in which log entries are stored.", "properties": { "restrictedFields": { "type": "array", "description": "Optional. Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: `textPayload`, `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`. Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)", "items": { "type": "string" } }, "lifecycleState": { "description": "Output only. The bucket lifecycle state.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state. This is only used/useful for distinguishing unset values.", "The normal and active state.", "The resource has been marked for deletion by the user. For some resources (e.g. buckets), this can be reversed by an un-delete operation.", "The resource has been marked for an update by the user. It will remain in this state until the update is complete.", "The resource has been marked for creation by the user. It will remain in this state until the creation is complete.", "The resource is in an INTERNAL error state." ], "enum": [ "LIFECYCLE_STATE_UNSPECIFIED", "ACTIVE", "DELETE_REQUESTED", "UPDATING", "CREATING", "FAILED" ] }, "indexConfigs": { "type": "array", "description": "Optional. A list of indexed fields and related configuration data.", "items": { "$ref": "IndexConfig" } }, "cmekSettings": { "$ref": "CmekSettings", "description": "Optional. The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The last update timestamp of the bucket.", "readOnly": true }, "locked": { "description": "Optional. Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.", "type": "boolean" }, "description": { "description": "Optional. Describes this bucket.", "type": "string" }, "name": { "description": "Output only. The resource name of the bucket. For example: `projects/my-project/locations/global/buckets/my-bucket` For a list of supported locations, see [Supported Regions](https://documentation.s3ns.fr/logging/docs/region-support) For the location of `global` it is unspecified where log entries are actually stored. After a bucket has been created, the location cannot be changed.", "readOnly": true, "type": "string" }, "retentionDays": { "type": "integer", "format": "int32", "description": "Optional. Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.", "readOnly": true } }, "id": "LogBucket" }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "type": "object", "id": "CancelOperationRequest" }, "LogScope": { "id": "LogScope", "type": "object", "description": "Describes a group of resources to read log entries from.", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The last update timestamp of the log scope.", "readOnly": true }, "resourceNames": { "type": "array", "description": "Required. Names of one or more parent resources (`organizations` and `folders` are not supported.): * `projects/[PROJECT_ID]` May alternatively be one or more views: * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]` A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Output only. The resource name of the log scope. Log scopes are only available in the `global` location. For example: `projects/my-project/locations/global/logScopes/my-log-scope`", "readOnly": true }, "description": { "type": "string", "description": "Optional. Describes this log scope. The maximum length of the description is 8000 characters." }, "createTime": { "description": "Output only. The creation timestamp of the log scope.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "LabelDescriptor": { "id": "LabelDescriptor", "description": "A description of a label.", "properties": { "key": { "description": "The label key.", "type": "string" }, "valueType": { "type": "string", "enumDescriptions": [ "A variable-length string. This is the default.", "Boolean; true or false.", "A 64-bit signed integer." ], "description": "The type of data that can be assigned to the label.", "enum": [ "STRING", "BOOL", "INT64" ] }, "description": { "description": "A human-readable description for the label.", "type": "string" } }, "type": "object" }, "Binding": { "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "properties": { "members": { "description": "Specifies the principals requesting access for a Cloud de Confiance Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Cloud de Confiance account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Cloud de Confiance account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Cloud de Confiance account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Cloud de Confiance service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://documentation.s3ns.fr/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Cloud de Confiance group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Cloud de Confiance group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://documentation.s3ns.fr/iam/help/conditions/resource-policies)." }, "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://documentation.s3ns.fr/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://documentation.s3ns.fr/iam/docs/understanding-roles)." } }, "type": "object" } }, "canonicalName": "Logging", "baseUrl": "https://logging.s3nsapis.fr/", "rootUrl": "https://logging.s3nsapis.fr/", "icons": { "x16": "", "x32": "" }, "revision": "20260403", "ownerDomain": "google.com", "servicePath": "", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/logging.admin": { "description": "Administrate log data for your projects" }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud services and see the email address of your Google Account" }, "https://www.googleapis.com/auth/logging.read": { "description": "View log data for your projects" }, "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." }, "https://www.googleapis.com/auth/logging.write": { "description": "Submit log data for your projects" } } } }, "ownerName": "Google" }