Class: Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy

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

Overview

Control over how the notification channels in notification_channels are notified when this alert fires.

Defined Under Namespace

Modules: NotificationPrompt Classes: NotificationChannelStrategy, NotificationRateLimit

Instance Attribute Summary collapse

Instance Attribute Details

#auto_close ⇒ ::Google::Protobuf::Duration

Returns If an alerting policy that was active has no data for this long, any open incidents will close.

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 765

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

  # Control over the rate of notifications sent to this alerting policy's
  # notification channels.
  # @!attribute [rw] period
  #   @return [::Google::Protobuf::Duration]
  #     Not more than one notification per `period`.
  class NotificationRateLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control over how the notification channels in `notification_channels`
  # are notified when this alert fires, on a per-channel basis.
  # @!attribute [rw] notification_channel_names
  #   @return [::Array<::String>]
  #     The full REST resource name for the notification channels that these
  #     settings apply to. Each of these correspond to the name field in one
  #     of the NotificationChannel objects referenced in the
  #     notification_channels field of this AlertPolicy.
  #     The format is:
  #
  #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
  # @!attribute [rw] renotify_interval
  #   @return [::Google::Protobuf::Duration]
  #     The frequency at which to send reminder notifications for open
  #     incidents.
  class NotificationChannelStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control when notifications will be sent out.
  module NotificationPrompt
    # No strategy specified. Treated as error.
    NOTIFICATION_PROMPT_UNSPECIFIED = 0

    # Notify when an incident is opened.
    OPENED = 1

    # Notify when an incident is closed.
    CLOSED = 3
  end
end

#notification_channel_strategy ⇒ ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationChannelStrategy>

Returns Control how notifications will be sent out, on a per-channel basis.

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 765

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

  # Control over the rate of notifications sent to this alerting policy's
  # notification channels.
  # @!attribute [rw] period
  #   @return [::Google::Protobuf::Duration]
  #     Not more than one notification per `period`.
  class NotificationRateLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control over how the notification channels in `notification_channels`
  # are notified when this alert fires, on a per-channel basis.
  # @!attribute [rw] notification_channel_names
  #   @return [::Array<::String>]
  #     The full REST resource name for the notification channels that these
  #     settings apply to. Each of these correspond to the name field in one
  #     of the NotificationChannel objects referenced in the
  #     notification_channels field of this AlertPolicy.
  #     The format is:
  #
  #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
  # @!attribute [rw] renotify_interval
  #   @return [::Google::Protobuf::Duration]
  #     The frequency at which to send reminder notifications for open
  #     incidents.
  class NotificationChannelStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control when notifications will be sent out.
  module NotificationPrompt
    # No strategy specified. Treated as error.
    NOTIFICATION_PROMPT_UNSPECIFIED = 0

    # Notify when an incident is opened.
    OPENED = 1

    # Notify when an incident is closed.
    CLOSED = 3
  end
end

#notification_prompts ⇒ ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationPrompt>

Returns For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 765

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

  # Control over the rate of notifications sent to this alerting policy's
  # notification channels.
  # @!attribute [rw] period
  #   @return [::Google::Protobuf::Duration]
  #     Not more than one notification per `period`.
  class NotificationRateLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control over how the notification channels in `notification_channels`
  # are notified when this alert fires, on a per-channel basis.
  # @!attribute [rw] notification_channel_names
  #   @return [::Array<::String>]
  #     The full REST resource name for the notification channels that these
  #     settings apply to. Each of these correspond to the name field in one
  #     of the NotificationChannel objects referenced in the
  #     notification_channels field of this AlertPolicy.
  #     The format is:
  #
  #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
  # @!attribute [rw] renotify_interval
  #   @return [::Google::Protobuf::Duration]
  #     The frequency at which to send reminder notifications for open
  #     incidents.
  class NotificationChannelStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control when notifications will be sent out.
  module NotificationPrompt
    # No strategy specified. Treated as error.
    NOTIFICATION_PROMPT_UNSPECIFIED = 0

    # Notify when an incident is opened.
    OPENED = 1

    # Notify when an incident is closed.
    CLOSED = 3
  end
end

#notification_rate_limit ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationRateLimit

Returns Required for log-based alerting policies, i.e. policies with a LogMatch condition.

This limit is not implemented for alerting policies that do not have a LogMatch condition.

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 765

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

  # Control over the rate of notifications sent to this alerting policy's
  # notification channels.
  # @!attribute [rw] period
  #   @return [::Google::Protobuf::Duration]
  #     Not more than one notification per `period`.
  class NotificationRateLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control over how the notification channels in `notification_channels`
  # are notified when this alert fires, on a per-channel basis.
  # @!attribute [rw] notification_channel_names
  #   @return [::Array<::String>]
  #     The full REST resource name for the notification channels that these
  #     settings apply to. Each of these correspond to the name field in one
  #     of the NotificationChannel objects referenced in the
  #     notification_channels field of this AlertPolicy.
  #     The format is:
  #
  #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
  # @!attribute [rw] renotify_interval
  #   @return [::Google::Protobuf::Duration]
  #     The frequency at which to send reminder notifications for open
  #     incidents.
  class NotificationChannelStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Control when notifications will be sent out.
  module NotificationPrompt
    # No strategy specified. Treated as error.
    NOTIFICATION_PROMPT_UNSPECIFIED = 0

    # Notify when an incident is opened.
    OPENED = 1

    # Notify when an incident is closed.
    CLOSED = 3
  end
end