Represents an AlertPolicy.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.IAlertPolicy);
Constructs a new AlertPolicy.
Parameter | |
---|---|
Name | Description |
properties |
IAlertPolicy
Properties to set |
Properties
combiner
public combiner: (google.monitoring.v3.AlertPolicy.ConditionCombinerType|keyof typeof google.monitoring.v3.AlertPolicy.ConditionCombinerType);
AlertPolicy combiner.
conditions
public conditions: google.monitoring.v3.AlertPolicy.ICondition[];
AlertPolicy conditions.
creationRecord
public creationRecord?: (google.monitoring.v3.IMutationRecord|null);
AlertPolicy creationRecord.
displayName
public displayName: string;
AlertPolicy displayName.
documentation
public documentation?: (google.monitoring.v3.AlertPolicy.IDocumentation|null);
AlertPolicy documentation.
enabled
public enabled?: (google.protobuf.IBoolValue|null);
AlertPolicy enabled.
mutationRecord
public mutationRecord?: (google.monitoring.v3.IMutationRecord|null);
AlertPolicy mutationRecord.
name
public name: string;
AlertPolicy name.
notificationChannels
public notificationChannels: string[];
AlertPolicy notificationChannels.
userLabels
public userLabels: { [k: string]: string };
AlertPolicy userLabels.
validity
public validity?: (google.rpc.IStatus|null);
AlertPolicy validity.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.IAlertPolicy): google.monitoring.v3.AlertPolicy;
Creates a new AlertPolicy instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAlertPolicy
Properties to set |
Returns | |
---|---|
Type | Description |
AlertPolicy | AlertPolicy instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.AlertPolicy;
Decodes an AlertPolicy 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 |
AlertPolicy | AlertPolicy |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.AlertPolicy;
Decodes an AlertPolicy message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
AlertPolicy | AlertPolicy |
encode(message, writer)
public static encode(message: google.monitoring.v3.IAlertPolicy, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AlertPolicy message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAlertPolicy
AlertPolicy 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.IAlertPolicy, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AlertPolicy message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAlertPolicy
AlertPolicy 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;
Creates an AlertPolicy 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 |
AlertPolicy | AlertPolicy |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for AlertPolicy
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 AlertPolicy to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.AlertPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AlertPolicy message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
AlertPolicy
AlertPolicy |
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 an AlertPolicy message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|