Class: Google::Cloud::Monitoring::V3::Snooze

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/snooze.rb

Overview

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.

Defined Under Namespace

Classes: Criteria

Instance Attribute Summary collapse

Instance Attribute Details

#criteria ⇒ ::Google::Cloud::Monitoring::V3::Snooze::Criteria

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

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/monitoring/v3/snooze.rb', line 50

class Snooze
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
  # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
  # whose names are supplied.
  # @!attribute [rw] policies
  #   @return [::Array<::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.
  #     Exactly 1 alert policy is required if `filter` is specified at the same
  #     time.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to match on Alert fields when silencing the
  #     alerts. It follows the standard https://google.aip.dev/160 syntax.
  #     A filter string used to apply the snooze to specific incidents
  #     that have matching filter values.
  #     Filters can be defined for snoozes that apply to one alerting
  #     policy.
  #     Filters must be a string formatted as one or more resource labels with
  #     specific label values. If multiple resource labels are used, then they
  #     must be connected with an AND operator. For example, the following filter
  #     applies the snooze to incidents that have an instance ID of
  #     `1234567890` and a zone of `us-central1-a`:
  #
  #         resource.labels.instance_id="1234567890" AND
  #         resource.labels.zone="us-central1-a"
  class Criteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/monitoring/v3/snooze.rb', line 50

class Snooze
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
  # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
  # whose names are supplied.
  # @!attribute [rw] policies
  #   @return [::Array<::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.
  #     Exactly 1 alert policy is required if `filter` is specified at the same
  #     time.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to match on Alert fields when silencing the
  #     alerts. It follows the standard https://google.aip.dev/160 syntax.
  #     A filter string used to apply the snooze to specific incidents
  #     that have matching filter values.
  #     Filters can be defined for snoozes that apply to one alerting
  #     policy.
  #     Filters must be a string formatted as one or more resource labels with
  #     specific label values. If multiple resource labels are used, then they
  #     must be connected with an AND operator. For example, the following filter
  #     applies the snooze to incidents that have an instance ID of
  #     `1234567890` and a zone of `us-central1-a`:
  #
  #         resource.labels.instance_id="1234567890" AND
  #         resource.labels.zone="us-central1-a"
  class Criteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#interval ⇒ ::Google::Cloud::Monitoring::V3::TimeInterval

Returns 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:

  • (::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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/monitoring/v3/snooze.rb', line 50

class Snooze
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
  # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
  # whose names are supplied.
  # @!attribute [rw] policies
  #   @return [::Array<::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.
  #     Exactly 1 alert policy is required if `filter` is specified at the same
  #     time.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to match on Alert fields when silencing the
  #     alerts. It follows the standard https://google.aip.dev/160 syntax.
  #     A filter string used to apply the snooze to specific incidents
  #     that have matching filter values.
  #     Filters can be defined for snoozes that apply to one alerting
  #     policy.
  #     Filters must be a string formatted as one or more resource labels with
  #     specific label values. If multiple resource labels are used, then they
  #     must be connected with an AND operator. For example, the following filter
  #     applies the snooze to incidents that have an instance ID of
  #     `1234567890` and a zone of `us-central1-a`:
  #
  #         resource.labels.instance_id="1234567890" AND
  #         resource.labels.zone="us-central1-a"
  class Criteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. Identifier. 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:

  • (::String) —

    Required. Identifier. 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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'proto_docs/google/monitoring/v3/snooze.rb', line 50

class Snooze
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
  # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
  # whose names are supplied.
  # @!attribute [rw] policies
  #   @return [::Array<::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.
  #     Exactly 1 alert policy is required if `filter` is specified at the same
  #     time.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Optional. The filter string to match on Alert fields when silencing the
  #     alerts. It follows the standard https://google.aip.dev/160 syntax.
  #     A filter string used to apply the snooze to specific incidents
  #     that have matching filter values.
  #     Filters can be defined for snoozes that apply to one alerting
  #     policy.
  #     Filters must be a string formatted as one or more resource labels with
  #     specific label values. If multiple resource labels are used, then they
  #     must be connected with an AND operator. For example, the following filter
  #     applies the snooze to incidents that have an instance ID of
  #     `1234567890` and a zone of `us-central1-a`:
  #
  #         resource.labels.instance_id="1234567890" AND
  #         resource.labels.zone="us-central1-a"
  class Criteria
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end