Represents a NotificationChannel.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.INotificationChannel);
Constructs a new NotificationChannel.
Parameter | |
---|---|
Name | Description |
properties |
INotificationChannel
Properties to set |
Properties
creationRecord
public creationRecord?: (google.monitoring.v3.IMutationRecord|null);
NotificationChannel creationRecord.
description
public description: string;
NotificationChannel description.
displayName
public displayName: string;
NotificationChannel displayName.
enabled
public enabled?: (google.protobuf.IBoolValue|null);
NotificationChannel enabled.
labels
public labels: { [k: string]: string };
NotificationChannel labels.
mutationRecords
public mutationRecords: google.monitoring.v3.IMutationRecord[];
NotificationChannel mutationRecords.
name
public name: string;
NotificationChannel name.
type
public type: string;
NotificationChannel type.
userLabels
public userLabels: { [k: string]: string };
NotificationChannel userLabels.
verificationStatus
public verificationStatus: (google.monitoring.v3.NotificationChannel.VerificationStatus|keyof typeof google.monitoring.v3.NotificationChannel.VerificationStatus);
NotificationChannel verificationStatus.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.INotificationChannel): google.monitoring.v3.NotificationChannel;
Creates a new NotificationChannel instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
INotificationChannel
Properties to set |
Returns | |
---|---|
Type | Description |
NotificationChannel | NotificationChannel instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.NotificationChannel;
Decodes a NotificationChannel message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
NotificationChannel | NotificationChannel |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.NotificationChannel;
Decodes a NotificationChannel message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
NotificationChannel | NotificationChannel |
encode(message, writer)
public static encode(message: google.monitoring.v3.INotificationChannel, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified NotificationChannel message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
INotificationChannel
NotificationChannel message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.monitoring.v3.INotificationChannel, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified NotificationChannel message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
INotificationChannel
NotificationChannel message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.monitoring.v3.NotificationChannel;
Creates a NotificationChannel message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
NotificationChannel | NotificationChannel |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for NotificationChannel
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this NotificationChannel to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.NotificationChannel, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a NotificationChannel message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
NotificationChannel
NotificationChannel |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a NotificationChannel message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|