AlertPolicy

google.monitoring.v3. AlertPolicy

Represents an AlertPolicy.

Constructor

new AlertPolicy(propertiesopt)

Constructs a new AlertPolicy.

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

Properties to set

Implements:
  • IAlertPolicy

Classes

Condition
Documentation

Members

ConditionCombinerType

ConditionCombinerType enum.

Properties:
Name Type Description
COMBINE_UNSPECIFIED number

COMBINE_UNSPECIFIED value

AND number

AND value

OR number

OR value

AND_WITH_MATCHING_RESOURCE number

AND_WITH_MATCHING_RESOURCE value

combiner

AlertPolicy combiner.

conditions

AlertPolicy conditions.

creationRecord

AlertPolicy creationRecord.

displayName

AlertPolicy displayName.

documentation

AlertPolicy documentation.

enabled

AlertPolicy enabled.

mutationRecord

AlertPolicy mutationRecord.

name

AlertPolicy name.

notificationChannels

AlertPolicy notificationChannels.

userLabels

AlertPolicy userLabels.

validity

AlertPolicy validity.

Methods

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

Creates a new AlertPolicy instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.monitoring.v3.AlertPolicy

AlertPolicy instance

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

Decodes an AlertPolicy 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.AlertPolicy

AlertPolicy

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.AlertPolicy}

Decodes an AlertPolicy 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.AlertPolicy

AlertPolicy

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 AlertPolicy message. Does not implicitly verify messages.

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

AlertPolicy 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 AlertPolicy message, length delimited. Does not implicitly verify messages.

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

AlertPolicy 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.AlertPolicy}

Creates an AlertPolicy 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.AlertPolicy

AlertPolicy

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

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

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

AlertPolicy

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an AlertPolicy 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 AlertPolicy to JSON.

Returns:
Type Description
Object.<string, *>

JSON object