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 Snoozes 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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::UpdateSnoozeRequest (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.6.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.5.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.5.1/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.4.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.3.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.2.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.1.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.0.1/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.18.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.17.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.16.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.15.2](/ruby/docs/reference/google-cloud-monitoring-v3/0.15.2/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.14.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.13.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.12.1/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.11.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.10.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.9.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.8.0/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.7.1/Google-Cloud-Monitoring-V3-UpdateSnoozeRequest) \nReference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::UpdateSnoozeRequest.\n\nThe message definition for updating a `Snooze`. The field, `snooze.name`\nidentifies the `Snooze` to be updated. The remainder of `snooze` gives the\ncontent the `Snooze` in question will be assigned.\n\nWhat fields can be updated depends on the start time and end time of the\n`Snooze`.\n\n- end time is in the past: These `Snooze`s are considered read-only and cannot be updated.\n- start time is in the past and end time is in the future: `display_name` and `interval.end_time` can be updated.\n- start time is in the future: `display_name`, `interval.start_time` and `interval.end_time` can be updated. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #snooze\n\n def snooze() -\u003e ::Google::Cloud::Monitoring::V3::Snooze\n\n**Returns**\n\n- ([::Google::Cloud::Monitoring::V3::Snooze](./Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present.\n\n### #snooze=\n\n def snooze=(value) -\u003e ::Google::Cloud::Monitoring::V3::Snooze\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Monitoring::V3::Snooze](./Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present. \n**Returns**\n\n- ([::Google::Cloud::Monitoring::V3::Snooze](./Google-Cloud-Monitoring-V3-Snooze)) --- Required. The `Snooze` to update. Must have the name field present.\n\n### #update_mask\n\n def update_mask() -\u003e ::Google::Protobuf::FieldMask\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Required. The fields to update.\n\n\n For each field listed in `update_mask`:\n - 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`.\n - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.\n\n Fields not listed retain their existing value.\n\n The following are the field names that are accepted in `update_mask`:\n - `display_name`\n - `interval.start_time`\n - `interval.end_time`\n\n That said, the start time and end time of the `Snooze` determines which\n fields can legally be updated. Before attempting an update, users should\n consult the documentation for `UpdateSnoozeRequest`, which talks about\n which fields can be updated.\n\n### #update_mask=\n\n def update_mask=(value) -\u003e ::Google::Protobuf::FieldMask\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Required. The fields to update.\n\n\n For each field listed in `update_mask`:\n - 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`.\n - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.\n\n Fields not listed retain their existing value.\n\n The following are the field names that are accepted in `update_mask`:\n - `display_name`\n - `interval.start_time`\n - `interval.end_time`\n\n That said, the start time and end time of the `Snooze` determines which\n fields can legally be updated. Before attempting an update, users should\n consult the documentation for `UpdateSnoozeRequest`, which talks about\nwhich fields can be updated. \n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Required. The fields to update.\n\n\n For each field listed in `update_mask`:\n - 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`.\n - If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value.\n\n Fields not listed retain their existing value.\n\n The following are the field names that are accepted in `update_mask`:\n - `display_name`\n - `interval.start_time`\n - `interval.end_time`\n\n That said, the start time and end time of the `Snooze` determines which\n fields can legally be updated. Before attempting an update, users should\n consult the documentation for `UpdateSnoozeRequest`, which talks about\n which fields can be updated."]]
