Class: Google::Cloud::Monitoring::V3::NotificationChannel

Inherits:

Object

Object
Google::Cloud::Monitoring::V3::NotificationChannel

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/monitoring/v3/notification.rb

Overview

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

Defined Under Namespace

Modules: VerificationStatus Classes: LabelsEntry, UserLabelsEntry

Instance Attribute Summary collapse

#creation_record ⇒ ::Google::Cloud::Monitoring::V3::MutationRecord
Record of the creation of this channel.
#description ⇒ ::String
An optional human-readable description of this notification channel.
#display_name ⇒ ::String
An optional human-readable name for this notification channel.
#enabled ⇒ ::Google::Protobuf::BoolValue
Whether notifications are forwarded to the described channel.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Configuration fields that define the channel and its behavior.
#mutation_records ⇒ ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>
Records of the modification of this channel.
#name ⇒ ::String
Identifier.
#type ⇒ ::String
The type of the notification channel.
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
#verification_status ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus
Indicates whether this channel has been verified or not.

Instance Attribute Details

#creation_record ⇒ `::Google::Cloud::Monitoring::V3::MutationRecord`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#description ⇒ `::String`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#display_name ⇒ `::String`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#enabled ⇒ `::Google::Protobuf::BoolValue`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#mutation_records ⇒ `::Array<::Google::Cloud::Monitoring::V3::MutationRecord>`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#name ⇒ `::String`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#type ⇒ `::String`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#user_labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

#verification_status ⇒ `::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus`

# File 'proto_docs/google/monitoring/v3/notification.rb', line 149

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
  # or an
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
  # operation.
  module VerificationStatus
    # Sentinel value used to indicate that the state is unknown, omitted, or
    # is not applicable (as in the case of channels that neither support
    # nor require verification in order to function).
    VERIFICATION_STATUS_UNSPECIFIED = 0

    # The channel has yet to be verified and requires verification to function.
    # Note that this state also applies to the case where the verification
    # process has been initiated by sending a verification code but where
    # the verification code has not been submitted to complete the process.
    UNVERIFIED = 1

    # It has been proven that notifications can be received on this
    # notification channel and that someone on the project has access
    # to messages that are delivered to that channel.
    VERIFIED = 2
  end
end

Class: Google::Cloud::Monitoring::V3::NotificationChannel

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#creation_record ⇒ ::Google::Cloud::Monitoring::V3::MutationRecord

#description ⇒ ::String

#display_name ⇒ ::String

#enabled ⇒ ::Google::Protobuf::BoolValue

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#mutation_records ⇒ ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>

#name ⇒ ::String

#type ⇒ ::String

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#verification_status ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus