Class protos.google.monitoring.dashboard.v1.Widget

Represents a Widget.

Package

@google-cloud/monitoring-dashboards

Constructors

(constructor)(properties)

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

Constructs a new Widget.

Parameter
NameDescription
properties IWidget

Properties to set

Properties

alertChart

public alertChart?: (google.monitoring.dashboard.v1.IAlertChart|null);

Widget alertChart.

blank

public blank?: (google.protobuf.IEmpty|null);

Widget blank.

content

public content?: ("xyChart"|"scorecard"|"text"|"blank"|"alertChart");

Widget content.

scorecard

public scorecard?: (google.monitoring.dashboard.v1.IScorecard|null);

Widget scorecard.

text

public text?: (google.monitoring.dashboard.v1.IText|null);

Widget text.

title

public title: string;

Widget title.

xyChart

public xyChart?: (google.monitoring.dashboard.v1.IXyChart|null);

Widget xyChart.

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.IWidget): google.monitoring.dashboard.v1.Widget;

Creates a new Widget instance using the specified properties.

Parameter
NameDescription
properties IWidget

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.Widget

Widget instance

decode(reader, length)

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

Decodes a Widget 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.Widget

Widget

decodeDelimited(reader)

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

Decodes a Widget 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.Widget

Widget

encode(message, writer)

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

Encodes the specified Widget message. Does not implicitly messages.

Parameters
NameDescription
message IWidget

Widget 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.IWidget, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IWidget

Widget 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.Widget;

Creates a Widget 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.Widget

Widget

toJSON()

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

Converts this Widget to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

Widget

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 Widget 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