NotificationChannel

google.monitoring.v3. NotificationChannel

Represents a NotificationChannel.

Constructor

new NotificationChannel(propertiesopt)

Constructs a new NotificationChannel.

Parameters:
Name Type Attributes Description
properties google.monitoring.v3.INotificationChannel <optional>

Properties to set

Implements:
  • INotificationChannel

Members

VerificationStatus

VerificationStatus enum.

Properties:
Name Type Description
VERIFICATION_STATUS_UNSPECIFIED number

VERIFICATION_STATUS_UNSPECIFIED value

UNVERIFIED number

UNVERIFIED value

VERIFIED number

VERIFIED value

description

NotificationChannel description.

displayName

NotificationChannel displayName.

enabled

NotificationChannel enabled.

labels

NotificationChannel labels.

name

NotificationChannel name.

type

NotificationChannel type.

userLabels

NotificationChannel userLabels.

verificationStatus

NotificationChannel verificationStatus.

Methods

(static) create(propertiesopt) → {google.monitoring.v3.NotificationChannel}

Creates a new NotificationChannel instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.monitoring.v3.INotificationChannel <optional>

Properties to set

Returns:
Type Description
google.monitoring.v3.NotificationChannel

NotificationChannel instance

(static) decode(reader, lengthopt) → {google.monitoring.v3.NotificationChannel}

Decodes a NotificationChannel message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.monitoring.v3.NotificationChannel

NotificationChannel

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.monitoring.v3.NotificationChannel}

Decodes a NotificationChannel message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.monitoring.v3.NotificationChannel

NotificationChannel

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified NotificationChannel message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.monitoring.v3.INotificationChannel

NotificationChannel message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified NotificationChannel message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.monitoring.v3.INotificationChannel

NotificationChannel message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.monitoring.v3.NotificationChannel}

Creates a NotificationChannel message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.monitoring.v3.NotificationChannel

NotificationChannel

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a NotificationChannel message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.monitoring.v3.NotificationChannel

NotificationChannel

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a NotificationChannel message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this NotificationChannel to JSON.

Returns:
Type Description
Object.<string, *>

JSON object