Class protos.google.monitoring.v3.NotificationChannel

Represents a NotificationChannel.

Package

@google-cloud/monitoring

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.v3.INotificationChannel);

Constructs a new NotificationChannel.

Parameter
NameDescription
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
NameDescription
properties INotificationChannel

Properties to set

Returns
TypeDescription
google.monitoring.v3.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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.monitoring.v3.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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.v3.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
NameDescription
message INotificationChannel

NotificationChannel message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
message INotificationChannel

NotificationChannel message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.monitoring.v3.NotificationChannel

NotificationChannel

toJSON()

public toJSON(): { [k: string]: any };

Converts this NotificationChannel to JSON.

Returns
TypeDescription
{ [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
NameDescription
message google.monitoring.v3.NotificationChannel

NotificationChannel

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a NotificationChannel message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not