Cloud Logging API (logging:v2)

2024-09-12

15 new methods

Additions

    Methods
  • logging.projects.locations.logScopes.list

      Path: v2/{+parent}/logScopes

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/logScopes

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]"

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          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.

          Location: query

          Type: integer

          Format: int32

      Parameter Order: parent

      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
    • Description: Lists log scopes.

  • logging.projects.locations.logScopes.get

  • logging.projects.locations.logScopes.create

      Path: v2/{+parent}/logScopes

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/logScopes

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Creates a log scope.

  • logging.projects.locations.logScopes.patch

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope

          Pattern: ^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          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.FieldMaskFor example: updateMask=description

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Updates a log scope.

  • logging.projects.locations.logScopes.delete

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope"

          Pattern: ^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Deletes a log scope.

  • logging.organizations.locations.logScopes.list

      Path: v2/{+parent}/logScopes

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/logScopes

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]"

          Pattern: ^organizations/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          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.

          Location: query

          Type: integer

          Format: int32

      Parameter Order: parent

      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
    • Description: Lists log scopes.

  • logging.organizations.locations.logScopes.get

  • logging.organizations.locations.logScopes.create

      Path: v2/{+parent}/logScopes

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/logScopes

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"

          Pattern: ^organizations/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Creates a log scope.

  • logging.organizations.locations.logScopes.patch

      Path: v2/{+name}

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope

          Pattern: ^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          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.FieldMaskFor example: updateMask=description

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Updates a log scope.

  • logging.organizations.locations.logScopes.delete

      Path: v2/{+name}

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope"

          Pattern: ^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Deletes a log scope.

  • logging.folders.locations.logScopes.list

      Path: v2/{+parent}/logScopes

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/logScopes

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]"

          Pattern: ^folders/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          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.

          Location: query

          Type: integer

          Format: int32

      Parameter Order: parent

      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
    • Description: Lists log scopes.

  • logging.folders.locations.logScopes.get

  • logging.folders.locations.logScopes.create

      Path: v2/{+parent}/logScopes

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/logScopes

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"

          Pattern: ^folders/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          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.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Creates a log scope.

  • logging.folders.locations.logScopes.patch

      Path: v2/{+name}

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope

          Pattern: ^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          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.FieldMaskFor example: updateMask=description

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Updates a log scope.

  • logging.folders.locations.logScopes.delete

      Path: v2/{+name}

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope"

          Pattern: ^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/logging.admin
    • Description: Deletes a log scope.