Stackdriver Monitoring V3 Client - Class Snooze (1.11.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class 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.

Generated from protobuf message google.monitoring.v3.Snooze

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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`	`Google\Cloud\Monitoring\V3\Snooze\Criteria` Required. This defines the criteria for applying the `Snooze`. See `Criteria` for more information.
`↳ interval`	`Google\Cloud\Monitoring\V3\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.
`↳ display_name`	`string` Required. A display name for the `Snooze`. This can be, at most, 512 unicode characters.

getName

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.

Returns
Type	Description
`string`

setName

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCriteria

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

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Snooze\Criteria\|null`

hasCriteria

clearCriteria

setCriteria

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

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Snooze\Criteria`

Returns
Type	Description
`$this`

getInterval

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.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\TimeInterval\|null`

hasInterval

clearInterval

setInterval

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.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\TimeInterval`

Returns
Type	Description
`$this`

getDisplayName

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

Returns
Type	Description
`string`

setDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`