Class protos.google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit (5.2.0)

Represents a NotificationRateLimit.

Package

@google-cloud/monitoring

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.v3.AlertPolicy.AlertStrategy.INotificationRateLimit);

Constructs a new NotificationRateLimit.

Parameter
Name Description
properties INotificationRateLimit

Properties to set

Properties

period

public period?: (google.protobuf.IDuration|null);

NotificationRateLimit period.

Methods

create(properties)

public static create(properties?: google.monitoring.v3.AlertPolicy.AlertStrategy.INotificationRateLimit): google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit;

Creates a new NotificationRateLimit instance using the specified properties.

Parameter
Name Description
properties INotificationRateLimit

Properties to set

Returns
Type Description
NotificationRateLimit

NotificationRateLimit instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit;

Decodes a NotificationRateLimit 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
NotificationRateLimit

NotificationRateLimit

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
NotificationRateLimit

NotificationRateLimit

encode(message, writer)

public static encode(message: google.monitoring.v3.AlertPolicy.AlertStrategy.INotificationRateLimit, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified NotificationRateLimit message. Does not implicitly messages.

Parameters
Name Description
message INotificationRateLimit

NotificationRateLimit 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.AlertPolicy.AlertStrategy.INotificationRateLimit, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message INotificationRateLimit

NotificationRateLimit 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.AlertPolicy.AlertStrategy.NotificationRateLimit;

Creates a NotificationRateLimit 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
NotificationRateLimit

NotificationRateLimit

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for NotificationRateLimit

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 NotificationRateLimit to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message NotificationRateLimit

NotificationRateLimit

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 NotificationRateLimit message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not