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

(static) ConditionCombinerType :number

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 :google.monitoring.v3.AlertPolicy.ConditionCombinerType

AlertPolicy combiner.

conditions :Array.<google.monitoring.v3.AlertPolicy.ICondition>

AlertPolicy conditions.

creationRecord :google.monitoring.v3.IMutationRecord|null|undefined

AlertPolicy creationRecord.

displayName :string

AlertPolicy displayName.

documentation :google.monitoring.v3.AlertPolicy.IDocumentation|null|undefined

AlertPolicy documentation.

enabled :google.protobuf.IBoolValue|null|undefined

AlertPolicy enabled.

mutationRecord :google.monitoring.v3.IMutationRecord|null|undefined

AlertPolicy mutationRecord.

name :string

AlertPolicy name.

notificationChannels :Array.<string>

AlertPolicy notificationChannels.

userLabels :Object.<string, string>

AlertPolicy userLabels.

validity :google.rpc.IStatus|null|undefined

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

(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

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

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

(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

(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

(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

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

Verifies an AlertPolicy message.

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

Plain object to verify

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

Converts this AlertPolicy to JSON.