REST Resource: projects.snoozes

Resource: Snooze

A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.

JSON representation 
{
  "name": string,
  "criteria": {
    object (Criteria)
  },
  "interval": {
    object (TimeInterval)
  },
  "displayName": string
}
Fields
name

string

Required. The name of the Snooze. The format is:

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

The ID of the Snooze will be generated by the system.
criteria

object (Criteria)

Required. This defines the criteria for applying the Snooze. See Criteria for more information.
interval

object (TimeInterval)

Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
displayName

string

Required. A display name for the Snooze. This can be, at most, 512 unicode characters.

Criteria

Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.

JSON representation 
{
  "policies": [
    string
  ]
}
Fields
policies[]

string

The specific AlertPolicy names for the alert that should be snoozed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]

There is a limit of 16 policies per snooze. This limit is checked during snooze creation.

TimeInterval

Describes a time interval:

  • Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric.
  • Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future.
    • For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval.
    • For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.
    • For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval.
    • The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.
JSON representation 
{
  "endTime": string,
  "startTime": string
}
Fields
endTime

string (Timestamp format)

Required. The end of the time interval.

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

string (Timestamp format)

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

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

Methods

create

 Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened.

get

 Retrieves a Snooze by name.

list

 Lists the Snoozes associated with a project.

patch

 Updates a Snooze, identified by its name, with the parameters in the given Snooze object.