- 3.54.0 (latest)
- 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 static final class NotificationChannel.Builder extends GeneratedMessageV3.Builder<NotificationChannel.Builder> implements NotificationChannelOrBuilder 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.
Protobuf type google.monitoring.v3.NotificationChannel
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NotificationChannel.BuilderImplements
NotificationChannelOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllMutationRecords(Iterable<? extends MutationRecord> values)
public NotificationChannel.Builder addAllMutationRecords(Iterable<? extends MutationRecord> values)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.monitoring.v3.MutationRecord> |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
addMutationRecords(MutationRecord value)
public NotificationChannel.Builder addMutationRecords(MutationRecord value)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
addMutationRecords(MutationRecord.Builder builderForValue)
public NotificationChannel.Builder addMutationRecords(MutationRecord.Builder builderForValue)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
addMutationRecords(int index, MutationRecord value)
public NotificationChannel.Builder addMutationRecords(int index, MutationRecord value)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
addMutationRecords(int index, MutationRecord.Builder builderForValue)
public NotificationChannel.Builder addMutationRecords(int index, MutationRecord.Builder builderForValue)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
addMutationRecordsBuilder()
public MutationRecord.Builder addMutationRecordsBuilder()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
MutationRecord.Builder | |
addMutationRecordsBuilder(int index)
public MutationRecord.Builder addMutationRecordsBuilder(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.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public NotificationChannel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
build()
public NotificationChannel build()| Returns | |
|---|---|
| Type | Description |
NotificationChannel | |
buildPartial()
public NotificationChannel buildPartial()| Returns | |
|---|---|
| Type | Description |
NotificationChannel | |
clear()
public NotificationChannel.Builder clear()| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearCreationRecord()
public NotificationChannel.Builder clearCreationRecord()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearDescription()
public NotificationChannel.Builder clearDescription()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 |
NotificationChannel.Builder | This builder for chaining. |
clearDisplayName()
public NotificationChannel.Builder clearDisplayName()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 |
NotificationChannel.Builder | This builder for chaining. |
clearEnabled()
public NotificationChannel.Builder clearEnabled()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 |
NotificationChannel.Builder | |
clearField(Descriptors.FieldDescriptor field)
public NotificationChannel.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearLabels()
public NotificationChannel.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearMutationRecords()
public NotificationChannel.Builder clearMutationRecords()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearName()
public NotificationChannel.Builder clearName()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 | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public NotificationChannel.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearType()
public NotificationChannel.Builder clearType()The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
string type = 1;
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
clearUserLabels()
public NotificationChannel.Builder clearUserLabels()| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
clearVerificationStatus()
public NotificationChannel.Builder clearVerificationStatus() 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.Builder | This builder for chaining. |
clone()
public NotificationChannel.Builder clone()| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
containsLabels(String key)
public 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 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 MutationRecord getCreationRecord()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
MutationRecord | The creationRecord. |
getCreationRecordBuilder()
public MutationRecord.Builder getCreationRecordBuilder()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
MutationRecord.Builder | |
getCreationRecordOrBuilder()
public MutationRecordOrBuilder getCreationRecordOrBuilder()Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder | |
getDefaultInstanceForType()
public NotificationChannel getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
NotificationChannel | |
getDescription()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDisplayName()
public 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 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 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. |
getEnabledBuilder()
public BoolValue.Builder getEnabledBuilder()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 |
Builder | |
getEnabledOrBuilder()
public 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 Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public 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 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 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 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 | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutableUserLabels() (deprecated)
public Map<String,String> getMutableUserLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutationRecords(int index)
public 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 | |
getMutationRecordsBuilder(int index)
public MutationRecord.Builder getMutationRecordsBuilder(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.Builder | |
getMutationRecordsBuilderList()
public List<MutationRecord.Builder> getMutationRecordsBuilderList()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getMutationRecordsCount()
public int getMutationRecordsCount()Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns | |
|---|---|
| Type | Description |
int | |
getMutationRecordsList()
public 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 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 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 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 | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getType()
public 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 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 Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getUserLabelsCount()
public 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreationRecord(MutationRecord value)
public NotificationChannel.Builder mergeCreationRecord(MutationRecord value)Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
mergeEnabled(BoolValue value)
public NotificationChannel.Builder mergeEnabled(BoolValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | BoolValue |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
mergeFrom(NotificationChannel other)
public NotificationChannel.Builder mergeFrom(NotificationChannel other)| Parameter | |
|---|---|
| Name | Description |
other | NotificationChannel |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public NotificationChannel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public NotificationChannel.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final NotificationChannel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
putAllLabels(Map<String,String> values)
public NotificationChannel.Builder putAllLabels(Map<String,String> values) 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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
putAllUserLabels(Map<String,String> values)
public NotificationChannel.Builder putAllUserLabels(Map<String,String> values) 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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
putLabels(String key, String value)
public NotificationChannel.Builder putLabels(String key, String value) 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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
putUserLabels(String key, String value)
public NotificationChannel.Builder putUserLabels(String key, String value) 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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
removeLabels(String key)
public NotificationChannel.Builder removeLabels(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 |
NotificationChannel.Builder | |
removeMutationRecords(int index)
public NotificationChannel.Builder removeMutationRecords(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 |
NotificationChannel.Builder | |
removeUserLabels(String key)
public NotificationChannel.Builder removeUserLabels(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 |
NotificationChannel.Builder | |
setCreationRecord(MutationRecord value)
public NotificationChannel.Builder setCreationRecord(MutationRecord value)Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setCreationRecord(MutationRecord.Builder builderForValue)
public NotificationChannel.Builder setCreationRecord(MutationRecord.Builder builderForValue)Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setDescription(String value)
public NotificationChannel.Builder setDescription(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public NotificationChannel.Builder setDescriptionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setDisplayName(String value)
public NotificationChannel.Builder setDisplayName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public NotificationChannel.Builder setDisplayNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setEnabled(BoolValue value)
public NotificationChannel.Builder setEnabled(BoolValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | BoolValue |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setEnabled(BoolValue.Builder builderForValue)
public NotificationChannel.Builder setEnabled(BoolValue.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public NotificationChannel.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setMutationRecords(int index, MutationRecord value)
public NotificationChannel.Builder setMutationRecords(int index, MutationRecord value)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setMutationRecords(int index, MutationRecord.Builder builderForValue)
public NotificationChannel.Builder setMutationRecords(int index, MutationRecord.Builder builderForValue)Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setName(String value)
public NotificationChannel.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public NotificationChannel.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public NotificationChannel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setType(String value)
public NotificationChannel.Builder setType(String value)The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
string type = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe type to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setTypeBytes(ByteString value)
public NotificationChannel.Builder setTypeBytes(ByteString value)The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
string type = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for type to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final NotificationChannel.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | |
setVerificationStatus(NotificationChannel.VerificationStatus value)
public NotificationChannel.Builder setVerificationStatus(NotificationChannel.VerificationStatus value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | NotificationChannel.VerificationStatusThe verificationStatus to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |
setVerificationStatusValue(int value)
public NotificationChannel.Builder setVerificationStatusValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for verificationStatus to set. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel.Builder | This builder for chaining. |