- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public interface NotificationChannelOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key) 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.
map<string, string> labels = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsUserLabels(String key)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreationRecord()
public abstract MutationRecord getCreationRecord()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
MutationRecord |
The creationRecord. |
getCreationRecordOrBuilder()
public abstract MutationRecordOrBuilder getCreationRecordOrBuilder()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder |
|
getDescription()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEnabled()
public abstract 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 | |
|---|---|
| Type | Description |
BoolValue |
The enabled. |
getEnabledOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
BoolValueOrBuilder |
|
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount() 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.
map<string, string> labels = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap() 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.
map<string, string> labels = 5;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract 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
of the NotificationChannelDescriptor corresponding to the type field.
map<string, string> labels = 5;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key) 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.
map<string, string> labels = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMutationRecords(int index)
public abstract MutationRecord getMutationRecords(int index)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MutationRecord |
|
getMutationRecordsCount()
public abstract int getMutationRecordsCount()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMutationRecordsList()
public abstract List<MutationRecord> getMutationRecordsList()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
List<MutationRecord> |
|
getMutationRecordsOrBuilder(int index)
public abstract MutationRecordOrBuilder getMutationRecordsOrBuilder(int index)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder |
|
getMutationRecordsOrBuilderList()
public abstract List<? extends MutationRecordOrBuilder> getMutationRecordsOrBuilderList()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.monitoring.v3.MutationRecordOrBuilder> |
|
getName()
public abstract String getName()Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getType()
public abstract String getType()The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
string type = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The type. |
getTypeBytes()
public abstract ByteString getTypeBytes()The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
string type = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for type. |
getUserLabels() (deprecated)
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUserLabelsMap()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsOrDefault(String key, String defaultValue)
public abstract 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserLabelsOrThrow(String key)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getVerificationStatus()
public abstract NotificationChannel.VerificationStatus getVerificationStatus() 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.
.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.VerificationStatus |
The verificationStatus. |
getVerificationStatusValue()
public abstract int getVerificationStatusValue() 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.
.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for verificationStatus. |
hasCreationRecord()
public abstract boolean hasCreationRecord()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creationRecord field is set. |
hasEnabled()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the enabled field is set. |