Cloud Logging API (logging:v2)

2024-06-28

8 new methods | 4 updated methods

Additions

    Methods
  • logging.projects.locations.savedQueries.get

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: GET

      Parameters:

        name

          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"

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: 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
    • Description: Returns all data associated with the requested query.

  • logging.projects.locations.savedQueries.patch

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: PATCH

      Parameters:

        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://cloud.google.com/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.

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

          Location: path

          Required: Yes

          Type: string

        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".

          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 an existing SavedQuery.

  • logging.organizations.locations.savedQueries.get

      Path: v2/{+name}

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: GET

      Parameters:

        name

          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"

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: 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
    • Description: Returns all data associated with the requested query.

  • logging.organizations.locations.savedQueries.patch

      Path: v2/{+name}

      Flat Path: v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: PATCH

      Parameters:

        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://cloud.google.com/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.

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

          Location: path

          Required: Yes

          Type: string

        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".

          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 an existing SavedQuery.

  • logging.folders.locations.savedQueries.get

      Path: v2/{+name}

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: GET

      Parameters:

        name

          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"

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: 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
    • Description: Returns all data associated with the requested query.

  • logging.folders.locations.savedQueries.patch

      Path: v2/{+name}

      Flat Path: v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: PATCH

      Parameters:

        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://cloud.google.com/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.

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

          Location: path

          Required: Yes

          Type: string

        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".

          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 an existing SavedQuery.

  • logging.billingAccounts.locations.savedQueries.get

      Path: v2/{+name}

      Flat Path: v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: GET

      Parameters:

        name

          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"

          Pattern: ^billingAccounts/[^/]+/locations/[^/]+/savedQueries/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: 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
    • Description: Returns all data associated with the requested query.

  • logging.billingAccounts.locations.savedQueries.patch

      Path: v2/{+name}

      Flat Path: v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}

      HTTP Method: PATCH

      Parameters:

        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://cloud.google.com/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.

          Pattern: ^billingAccounts/[^/]+/locations/[^/]+/savedQueries/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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".

          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 an existing SavedQuery.

Updates

    Methods
  • logging.projects.locations.recentQueries.list

      Parameters:

        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")

          Location: query

          Type: string

  • logging.organizations.locations.recentQueries.list

      Parameters:

        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")

          Location: query

          Type: string

  • logging.folders.locations.recentQueries.list

      Parameters:

        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")

          Location: query

          Type: string

  • logging.billingAccounts.locations.recentQueries.list

      Parameters:

        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")

          Location: query

          Type: string