Google Cloud Logging Settings API

openapi: 3.2.0
info:
  title: Cloud Logging API V2 Settings API
  version: v2
  description: Generated from Google's published Discovery document for Cloud Logging API (logging v2, revision 20261106). 4 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://logging.googleapis.com
tags:
- name: Settings
paths:
  /v2/{v2Id}/{v2Id1}/settings:
    get:
      operationId: logging.getSettings
      summary: Get settings v2
      description: 'Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://docs.cloud.google.com/logging/docs/default-settings#view-org-settings) for more information.'
      parameters:
      - name: v2Id
        in: path
        required: true
        description: Resource name segment (v2Id).
        schema:
          type: string
      - name: v2Id1
        in: path
        required: true
        description: Resource name segment (v2Id1).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - 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
      - apiKey: []
      tags:
      - Settings
    patch:
      operationId: logging.updateSettings
      summary: Update settings v2
      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://docs.cloud.google.com/logging/docs/default-settings) for more information.'
      parameters:
      - name: v2Id
        in: path
        required: true
        description: Resource name segment (v2Id).
        schema:
          type: string
      - name: v2Id1
        in: path
        required: true
        description: Resource name segment (v2Id1).
        schema:
          type: string
      - name: updateMask
        in: query
        required: false
        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"'
        schema:
          type: string
          format: google-fieldmask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Settings'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/logging.admin
      - apiKey: []
      tags:
      - Settings
components:
  schemas:
    Settings:
      type: object
      properties:
        loggingServiceAccountId:
          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.
          type: string
          readOnly: true
        storageLocation:
          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.'
          type: string
        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
        name:
          type: string
          description: Output only. The resource name of the settings.
          readOnly: true
        kmsKeyName:
          description: 'Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"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 Configure CMEK for Cloud Logging (https://docs.cloud.google.com/logging/docs/routing/managed-encryption) for more information.'
          type: string
        defaultSinkConfig:
          $ref: '#/components/schemas/DefaultSinkConfig'
          description: Optional. Overrides the built-in configuration for _Default sink.
        kmsServiceAccountId:
          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 Configure CMEK for Cloud Logging (https://docs.cloud.google.com/logging/docs/routing/managed-encryption) for more information.
          type: string
          readOnly: true
      description: Describes the settings associated with a project, folder, organization, or billing account.
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    LogExclusion:
      type: object
      properties:
        filter:
          description: Required. An advanced logs filter (https://docs.cloud.google.com/logging/docs/view/building-queries#queries-by-expression) that matches the log entries to be excluded. By using the sample function (https://docs.cloud.google.com/logging/docs/view/logging-query-language#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 Google Cloud Storage buckets:resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)
          type: string
        updateTime:
          type: string
          description: Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.
          format: google-datetime
          readOnly: true
        disabled:
          type: boolean
          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.
        name:
          type: string
          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.
        createTime:
          format: google-datetime
          type: string
          readOnly: true
          description: Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.
        description:
          description: Optional. A description of this exclusion.
          type: string
      description: Specifies a set of log entries that are filtered out by a sink. If your Google 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.
    DefaultSinkConfig:
      type: object
      properties:
        mode:
          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.
          type: string
          enum:
          - FILTER_WRITE_MODE_UNSPECIFIED
          - APPEND
          - OVERWRITE
        exclusions:
          type: array
          description: Optional. Specifies the set of exclusions to be added to the _Default sink in newly created resource containers.
          items:
            $ref: '#/components/schemas/LogExclusion'
        filter:
          description: Optional. An advanced logs filter (https://docs.cloud.google.com/logging/docs/view/building-queries#queries-by-expression). 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>=ERRORTo 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.
          type: string
      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.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/logging.admin: Administrate log data for your projects
            https://www.googleapis.com/auth/logging.read: View log data for your projects
            https://www.googleapis.com/auth/cloud-platform.read-only: View your data across Google Cloud services and see the email address of your Google Account
            https://www.googleapis.com/auth/logging.write: Submit log data for your projects
externalDocs:
  url: https://cloud.google.com/logging/docs/
x-provenance:
  method: harvested
  publisher: Google
  source: https://logging.googleapis.com/$discovery/rest?version=v2
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)