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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/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

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Returns An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceeed 1024 Unicode characters.

Returns:

  • (String) —

    An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceeed 1024 Unicode characters.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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

Returns An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

Returns:

  • (String) —

    An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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

Returns Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.

Returns:

  • (Google::Protobuf::BoolValue) —

    Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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 ⇒ Hash{String => String}

Returns Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor#labels of the +NotificationChannelDescriptor+ corresponding to the +type+ field.

Returns:

  • (Hash{String => String}) —

    Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor#labels of the +NotificationChannelDescriptor+ corresponding to the +type+ field.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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

Returns The full REST resource name for this channel. The syntax is:

projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]

The +[CHANNEL_ID]+ is automatically assigned by the server on creation.

Returns:

  • (String) —

    The full REST resource name for this channel. The syntax is:

    projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]

    The +[CHANNEL_ID]+ is automatically assigned by the server on creation.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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

Returns The type of the notification channel. This field matches the value of the NotificationChannelDescriptor#type field.

Returns:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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 ⇒ Hash{String => String}

Returns User-supplied key/value data that does not need to conform to the corresponding +NotificationChannelDescriptor+'s schema, unlike the +labels+ field. This field is intended to be used for organizing and identifying the +NotificationChannel+ objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns:

  • (Hash{String => String}) —

    User-supplied key/value data that does not need to conform to the corresponding +NotificationChannelDescriptor+'s schema, unlike the +labels+ field. This field is intended to be used for organizing and identifying the +NotificationChannel+ objects.

    The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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::Monitoring::V3::NotificationChannel::VerificationStatus

Returns Indicates whether this channel has been verified or not. On a +ListNotificationChannels+ or +GetNotificationChannel+ operation, this field is expected to be populated.

If the value is +UNVERIFIED+, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.

If the channel is neither +VERIFIED+ nor +UNVERIFIED+, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.

This field cannot be modified using a standard +UpdateNotificationChannel+ operation. To change the value of this field, you must call +VerifyNotificationChannel+.

Returns:

  • (Google::Monitoring::V3::NotificationChannel::VerificationStatus) —

    Indicates whether this channel has been verified or not. On a +ListNotificationChannels+ or +GetNotificationChannel+ operation, this field is expected to be populated.

    If the value is +UNVERIFIED+, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.

    If the channel is neither +VERIFIED+ nor +UNVERIFIED+, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.

    This field cannot be modified using a standard +UpdateNotificationChannel+ operation. To change the value of this field, you must call +VerifyNotificationChannel+.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 125

class NotificationChannel
  # Indicates whether the channel has been verified or not. It is illegal
  # to specify this field in a
  # {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel +CreateNotificationChannel+}
  # or an
  # {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel +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