Class protos.google.monitoring.dashboard.v1.Threshold

Represents a Threshold.

Package

@google-cloud/monitoring-dashboards

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.dashboard.v1.IThreshold);

Constructs a new Threshold.

Parameter
NameDescription
properties IThreshold

Properties to set

Properties

color

public color: (google.monitoring.dashboard.v1.Threshold.Color|keyof typeof google.monitoring.dashboard.v1.Threshold.Color);

Threshold color.

direction

public direction: (google.monitoring.dashboard.v1.Threshold.Direction|keyof typeof google.monitoring.dashboard.v1.Threshold.Direction);

Threshold direction.

label

public label: string;

Threshold label.

value

public value: number;

Threshold value.

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.IThreshold): google.monitoring.dashboard.v1.Threshold;

Creates a new Threshold instance using the specified properties.

Parameter
NameDescription
properties IThreshold

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.Threshold

Threshold instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.Threshold;

Decodes a Threshold message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.monitoring.dashboard.v1.Threshold

Threshold

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.Threshold;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.dashboard.v1.Threshold

Threshold

encode(message, writer)

public static encode(message: google.monitoring.dashboard.v1.IThreshold, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Threshold message. Does not implicitly messages.

Parameters
NameDescription
message IThreshold

Threshold message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.monitoring.dashboard.v1.IThreshold, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IThreshold

Threshold message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.Threshold;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.monitoring.dashboard.v1.Threshold

Threshold

toJSON()

public toJSON(): { [k: string]: any };

Converts this Threshold to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.monitoring.dashboard.v1.Threshold, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.monitoring.dashboard.v1.Threshold

Threshold

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Threshold message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not