com.google.monitoring.v3

Interface NotificationChannelOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NotificationChannel, NotificationChannel.Builder

public interface NotificationChannelOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Configuration fields that define the channel and its behavior.
boolean	containsUserLabels(String key) User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field.
MutationRecord	getCreationRecord() Record of the creation of this channel.
MutationRecordOrBuilder	getCreationRecordOrBuilder() Record of the creation of this channel.
String	getDescription() An optional human-readable description of this notification channel.
com.google.protobuf.ByteString	getDescriptionBytes() An optional human-readable description of this notification channel.
String	getDisplayName() An optional human-readable name for this notification channel.
com.google.protobuf.ByteString	getDisplayNameBytes() An optional human-readable name for this notification channel.
com.google.protobuf.BoolValue	getEnabled() Whether notifications are forwarded to the described channel.
com.google.protobuf.BoolValueOrBuilder	getEnabledOrBuilder() Whether notifications are forwarded to the described channel.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Configuration fields that define the channel and its behavior.
Map<String,String>	getLabelsMap() Configuration fields that define the channel and its behavior.
String	getLabelsOrDefault(String key, String defaultValue) Configuration fields that define the channel and its behavior.
String	getLabelsOrThrow(String key) Configuration fields that define the channel and its behavior.
MutationRecord	getMutationRecords(int index) Records of the modification of this channel.
int	getMutationRecordsCount() Records of the modification of this channel.
List<MutationRecord>	getMutationRecordsList() Records of the modification of this channel.
MutationRecordOrBuilder	getMutationRecordsOrBuilder(int index) Records of the modification of this channel.
List<? extends MutationRecordOrBuilder>	getMutationRecordsOrBuilderList() Records of the modification of this channel.
String	getName() The full REST resource name for this channel.
com.google.protobuf.ByteString	getNameBytes() The full REST resource name for this channel.
String	getType() The type of the notification channel.
com.google.protobuf.ByteString	getTypeBytes() The type of the notification channel.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field.
Map<String,String>	getUserLabelsMap() User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field.
String	getUserLabelsOrDefault(String key, String defaultValue) User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field.
String	getUserLabelsOrThrow(String key) User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field.
NotificationChannel.VerificationStatus	getVerificationStatus() Indicates whether this channel has been verified or not.
int	getVerificationStatusValue() Indicates whether this channel has been verified or not.
boolean	hasCreationRecord() Record of the creation of this channel.
boolean	hasEnabled() Whether notifications are forwarded to the described channel.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getType

String getType()

 The type of the notification channel. This field matches the
 value of the
 [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type]
 field.
 

string type = 1;

Returns:

The type.

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 The type of the notification channel. This field matches the
 value of the
 [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type]
 field.
 

string type = 1;

Returns:

The bytes for type.

getName

String getName()

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

     projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

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

string name = 6;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

     projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

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

string name = 6;

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 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.
 

string display_name = 3;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 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.
 

string display_name = 3;

Returns:

The bytes for displayName.

getDescription

String getDescription()

 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 exceed 1024 Unicode characters.
 

string description = 4;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 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 exceed 1024 Unicode characters.
 

string description = 4;

Returns:

The bytes for description.

getLabelsCount

int getLabelsCount()

 Configuration fields that define the channel and its behavior. The
 permissible and required labels are specified in the
 [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.
 

map<string, string> labels = 5;

containsLabels

boolean containsLabels(String key)

 Configuration fields that define the channel and its behavior. The
 permissible and required labels are specified in the
 [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.
 

map<string, string> labels = 5;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Configuration fields that define the channel and its behavior. The
 permissible and required labels are specified in the
 [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.
 

map<string, string> labels = 5;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 Configuration fields that define the channel and its behavior. The
 permissible and required labels are specified in the
 [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.
 

map<string, string> labels = 5;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Configuration fields that define the channel and its behavior. The
 permissible and required labels are specified in the
 [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.
 

map<string, string> labels = 5;

getUserLabelsCount

int getUserLabelsCount()

 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.
 

map<string, string> user_labels = 8;

containsUserLabels

boolean containsUserLabels(String key)

 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.
 

map<string, string> user_labels = 8;

getUserLabels

@Deprecated
Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

getUserLabelsMap

Map<String,String> getUserLabelsMap()

 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.
 

map<string, string> user_labels = 8;

getUserLabelsOrDefault

String getUserLabelsOrDefault(String key,
                              String defaultValue)

 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.
 

map<string, string> user_labels = 8;

getUserLabelsOrThrow

String getUserLabelsOrThrow(String key)

 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.
 

map<string, string> user_labels = 8;

getVerificationStatusValue

int getVerificationStatusValue()

 Indicates whether this channel has been verified or not. On a
 [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
 or
 [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.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`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
 operation. To change the value of this field, you must call
 [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
 

.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

Returns:

The enum numeric value on the wire for verificationStatus.

getVerificationStatus

NotificationChannel.VerificationStatus getVerificationStatus()

 Indicates whether this channel has been verified or not. On a
 [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
 or
 [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.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`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
 operation. To change the value of this field, you must call
 [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
 

.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

Returns:

The verificationStatus.

hasEnabled

boolean hasEnabled()

 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.
 

.google.protobuf.BoolValue enabled = 11;

Returns:

Whether the enabled field is set.

getEnabled

com.google.protobuf.BoolValue getEnabled()

 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.
 

.google.protobuf.BoolValue enabled = 11;

Returns:

The enabled.

getEnabledOrBuilder

com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()

 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.
 

.google.protobuf.BoolValue enabled = 11;

hasCreationRecord

boolean hasCreationRecord()

 Record of the creation of this channel.
 

.google.monitoring.v3.MutationRecord creation_record = 12;

Returns:

Whether the creationRecord field is set.

getCreationRecord

MutationRecord getCreationRecord()

 Record of the creation of this channel.
 

.google.monitoring.v3.MutationRecord creation_record = 12;

Returns:

The creationRecord.

getCreationRecordOrBuilder

MutationRecordOrBuilder getCreationRecordOrBuilder()

 Record of the creation of this channel.
 

.google.monitoring.v3.MutationRecord creation_record = 12;

getMutationRecordsList

List<MutationRecord> getMutationRecordsList()

 Records of the modification of this channel.
 

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

getMutationRecords

MutationRecord getMutationRecords(int index)

 Records of the modification of this channel.
 

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

getMutationRecordsCount

int getMutationRecordsCount()

 Records of the modification of this channel.
 

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

getMutationRecordsOrBuilderList

List<? extends MutationRecordOrBuilder> getMutationRecordsOrBuilderList()

 Records of the modification of this channel.
 

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

getMutationRecordsOrBuilder

MutationRecordOrBuilder getMutationRecordsOrBuilder(int index)

 Records of the modification of this channel.
 

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;