REST Resource: billingAccounts.locations.savedQueries

Resource: SavedQuery

Describes a query that has been saved by a user.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "visibility": enum (Visibility),

  // Union field query_oneof can be only one of the following:
  "loggingQuery": {
    object (LoggingQuery)
  },
  "opsAnalyticsQuery": {
    object (OpsAnalyticsQuery)
  }
  // End of list of possible types for union field query_oneof.
}
Fields
name

string

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

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

string

Required. The user specified title for the SavedQuery.
description

string

Optional. A human readable description of the saved query.
createTime

string (Timestamp format)

Output only. The timestamp when the saved query was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The timestamp when the saved query was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
visibility

enum (Visibility)

Required. The visibility status of this query, which determines its ownership.
Union field query_oneof. The query that is saved. query_oneof can be only one of the following:
loggingQuery

object (LoggingQuery)

Logging query that can be executed in Logs Explorer or via Logging API.
opsAnalyticsQuery

object (OpsAnalyticsQuery)

Analytics query that can be executed in Log Analytics.

LoggingQuery

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.

JSON representation 
{
  "filter": string,
  "summaryFields": [
    {
      object (SummaryField)
    }
  ],

  // Union field summary_field_width can be only one of the following:
  "summaryFieldStart": integer,
  "summaryFieldEnd": integer
  // End of list of possible types for union field summary_field_width.
}
Fields
filter

string

Required. An advanced query using the Logging Query Language. The maximum length of the filter is 20000 characters.
summaryFields[]

object (SummaryField)

Optional. The set of summary fields to display for this saved query.
Union field summary_field_width. The user's setting for number of characters to display for each summary field. In the Logs Explorer page of Google Cloud console, negative values are ignored and the default (0) means there is no truncation. summary_field_width can be only one of the following:
summaryFieldStart

integer

Characters will be counted from the start of the string.
summaryFieldEnd

integer

Characters will be counted from the end of the string.

SummaryField

A field from the LogEntry that is added to the summary line for a query in the Logs Explorer.

JSON representation 
{
  "field": string
}
Fields
field

string

Optional. The field from the LogEntry to include in the summary line, for example resource.type or jsonPayload.name.

OpsAnalyticsQuery

Describes an analytics query that can be run in the Log Analytics page of Google Cloud console.

Preview: This is a preview feature and may be subject to change before final release.

JSON representation 
{
  "sqlQueryText": string
}
Fields
sqlQueryText

string

Required. A logs analytics SQL query, which generally follows BigQuery format.

This is the SQL query that appears in the Log Analytics UI's query editor.

Visibility

Saved query visibility.

Enums
VISIBILITY_UNSPECIFIED The saved query visibility is unspecified. A savedQueries.create request with an unspecified visibility will be rejected.
PRIVATE The saved query is only visible to the user that created it.
SHARED The saved query is visible to anyone in the project.

Methods

create

 Creates a new SavedQuery for the user making the request.

delete

 Deletes an existing SavedQuery that was created by the user making the request.

list

 Lists the SavedQueries that were created by the user making the request.