Constructor
new Dashboard(propertiesopt)
Constructs a new Dashboard.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.monitoring.dashboard.v1.IDashboard |
<optional> |
Properties to set |
- Implements:
-
- IDashboard
Members
columnLayout
Dashboard columnLayout.
dashboardFilters
Dashboard dashboardFilters.
displayName
Dashboard displayName.
etag
Dashboard etag.
gridLayout
Dashboard gridLayout.
labels
Dashboard labels.
layout
Dashboard layout.
mosaicLayout
Dashboard mosaicLayout.
name
Dashboard name.
rowLayout
Dashboard rowLayout.
Methods
toJSON() → {Object.<string, *>}
Converts this Dashboard to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.monitoring.dashboard.v1.Dashboard}
Creates a new Dashboard instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.monitoring.dashboard.v1.IDashboard |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Dashboard |
Dashboard instance |
(static) decode(reader, lengthopt) → {google.monitoring.dashboard.v1.Dashboard}
Decodes a Dashboard message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Dashboard |
Dashboard |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.monitoring.dashboard.v1.Dashboard}
Decodes a Dashboard message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Dashboard |
Dashboard |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Dashboard message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.monitoring.dashboard.v1.IDashboard |
Dashboard message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Dashboard message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.monitoring.dashboard.v1.IDashboard |
Dashboard message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.monitoring.dashboard.v1.Dashboard}
Creates a Dashboard message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Dashboard |
Dashboard |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Dashboard
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Dashboard message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.monitoring.dashboard.v1.Dashboard |
Dashboard |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Dashboard message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|