Represents a Dashboard.
Package
@google-cloud/monitoring-dashboardsConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.dashboard.v1.IDashboard);Constructs a new Dashboard.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDashboard
Properties to set |
Properties
columnLayout
public columnLayout?: (google.monitoring.dashboard.v1.IColumnLayout|null);Dashboard columnLayout.
dashboardFilters
public dashboardFilters: google.monitoring.dashboard.v1.IDashboardFilter[];Dashboard dashboardFilters.
displayName
public displayName: string;Dashboard displayName.
etag
public etag: string;Dashboard etag.
gridLayout
public gridLayout?: (google.monitoring.dashboard.v1.IGridLayout|null);Dashboard gridLayout.
labels
public labels: { [k: string]: string };Dashboard labels.
layout
public layout?: ("gridLayout"|"mosaicLayout"|"rowLayout"|"columnLayout");Dashboard layout.
mosaicLayout
public mosaicLayout?: (google.monitoring.dashboard.v1.IMosaicLayout|null);Dashboard mosaicLayout.
name
public name: string;Dashboard name.
rowLayout
public rowLayout?: (google.monitoring.dashboard.v1.IRowLayout|null);Dashboard rowLayout.
Methods
create(properties)
public static create(properties?: google.monitoring.dashboard.v1.IDashboard): google.monitoring.dashboard.v1.Dashboard;Creates a new Dashboard instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDashboard
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Dashboard | Dashboard instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.Dashboard;Decodes a Dashboard message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Dashboard | Dashboard |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.Dashboard;Decodes a Dashboard message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Dashboard | Dashboard |
encode(message, writer)
public static encode(message: google.monitoring.dashboard.v1.IDashboard, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Dashboard message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDashboard
Dashboard 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.dashboard.v1.IDashboard, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Dashboard message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDashboard
Dashboard 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.dashboard.v1.Dashboard;Creates a Dashboard 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 |
google.monitoring.dashboard.v1.Dashboard | Dashboard |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Dashboard
| 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 Dashboard to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.dashboard.v1.Dashboard, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Dashboard message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.monitoring.dashboard.v1.Dashboard
Dashboard |
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 Dashboard message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|