# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::UpdateSnoozeRequest (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.0 1.7.1 1.6.1 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.0 0.16.0 0.15.2 0.14.0 0.13.0 0.12.1 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::UpdateSnoozeRequest.

The message definition for updating a `Snooze`. The field, `snooze.name`
identifies the `Snooze` to be updated. The remainder of `snooze` gives the
content the `Snooze` in question will be assigned.

What fields can be updated depends on the start time and end time of the
`Snooze`.

- end time is in the past: These `Snooze`s are considered read-only and cannot be updated.
- start time is in the past and end time is in the future: `display_name` and `interval.end_time` can be updated.
- start time is in the future: `display_name`, `interval.start_time` and `interval.end_time` can be updated.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #snooze

    def snooze() -> ::Google::Cloud::Monitoring::V3::Snooze

**Returns**

- ([::Google::Cloud::Monitoring::V3::Snooze](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present.

### #snooze=

    def snooze=(value) -> ::Google::Cloud::Monitoring::V3::Snooze

**Parameter**

- **value** ([::Google::Cloud::Monitoring::V3::Snooze](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present.
**Returns**

- ([::Google::Cloud::Monitoring::V3::Snooze](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present.

### #update_mask

    def update_mask() -> ::Google::Protobuf::FieldMask

**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-FieldMask)) --- Required. The fields to update.


  For each field listed in `update_mask`:
  - If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a value for that field, the value of the field in the existing `Snooze` will be set to the value of the field in the supplied `Snooze`.
  - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.

  Fields not listed retain their existing value.

  The following are the field names that are accepted in `update_mask`:
  - `display_name`
  - `interval.start_time`
  - `interval.end_time`

  That said, the start time and end time of the `Snooze` determines which
  fields can legally be updated. Before attempting an update, users should
  consult the documentation for `UpdateSnoozeRequest`, which talks about
  which fields can be updated.

### #update_mask=

    def update_mask=(value) -> ::Google::Protobuf::FieldMask

**Parameter**

- **value** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-FieldMask)) --- Required. The fields to update.


  For each field listed in `update_mask`:
  - If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a value for that field, the value of the field in the existing `Snooze` will be set to the value of the field in the supplied `Snooze`.
  - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.

  Fields not listed retain their existing value.

  The following are the field names that are accepted in `update_mask`:
  - `display_name`
  - `interval.start_time`
  - `interval.end_time`

  That said, the start time and end time of the `Snooze` determines which
  fields can legally be updated. Before attempting an update, users should
  consult the documentation for `UpdateSnoozeRequest`, which talks about
  which fields can be updated.
**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-FieldMask)) --- Required. The fields to update.


  For each field listed in `update_mask`:
  - If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a value for that field, the value of the field in the existing `Snooze` will be set to the value of the field in the supplied `Snooze`.
  - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.

  Fields not listed retain their existing value.

  The following are the field names that are accepted in `update_mask`:
  - `display_name`
  - `interval.start_time`
  - `interval.end_time`

  That said, the start time and end time of the `Snooze` determines which
  fields can legally be updated. Before attempting an update, users should
  consult the documentation for `UpdateSnoozeRequest`, which talks about
  which fields can be updated.