Monitoring API, gRPC: DashboardService
- Calls DashboardService
- Get
- GetDashboardRequest
- Dashboard
- Widget
- LayoutPosition
- TextWidget
- TitleWidget
- ChartWidget
- Queries
- Target
- VisualizationSettings
- ColorSchemeSettings
- AutomaticColorScheme
- StandardColorScheme
- GradientColorScheme
- HeatmapSettings
- Yaxis
- YaxisSettings
- SeriesOverrides
- SeriesOverrideSettings
- NameHidingSettings
- Downsampling
- Parametrization
- Parameter
- LabelValuesParameter
- CustomParameter
- TextParameter
- IntegerParameter
- DoubleParameter
- TextValuesParameter
- List
- ListDashboardsRequest
- ListDashboardsResponse
- Dashboard
- Widget
- LayoutPosition
- TextWidget
- TitleWidget
- ChartWidget
- Queries
- Target
- VisualizationSettings
- ColorSchemeSettings
- AutomaticColorScheme
- StandardColorScheme
- GradientColorScheme
- HeatmapSettings
- Yaxis
- YaxisSettings
- SeriesOverrides
- SeriesOverrideSettings
- NameHidingSettings
- Downsampling
- Parametrization
- Parameter
- LabelValuesParameter
- CustomParameter
- TextParameter
- IntegerParameter
- DoubleParameter
- TextValuesParameter
- Create
- CreateDashboardRequest
- Widget
- LayoutPosition
- TextWidget
- TitleWidget
- ChartWidget
- Queries
- Target
- VisualizationSettings
- ColorSchemeSettings
- AutomaticColorScheme
- StandardColorScheme
- GradientColorScheme
- HeatmapSettings
- Yaxis
- YaxisSettings
- SeriesOverrides
- SeriesOverrideSettings
- NameHidingSettings
- Downsampling
- Parametrization
- Parameter
- LabelValuesParameter
- CustomParameter
- TextParameter
- IntegerParameter
- DoubleParameter
- TextValuesParameter
- Operation
- CreateDashboardMetadata
- Dashboard
- Update
- UpdateDashboardRequest
- Widget
- LayoutPosition
- TextWidget
- TitleWidget
- ChartWidget
- Queries
- Target
- VisualizationSettings
- ColorSchemeSettings
- AutomaticColorScheme
- StandardColorScheme
- GradientColorScheme
- HeatmapSettings
- Yaxis
- YaxisSettings
- SeriesOverrides
- SeriesOverrideSettings
- NameHidingSettings
- Downsampling
- Parametrization
- Parameter
- LabelValuesParameter
- CustomParameter
- TextParameter
- IntegerParameter
- DoubleParameter
- TextValuesParameter
- Operation
- UpdateDashboardMetadata
- Dashboard
- Delete
- ListOperations
A set of methods for managing dashboards.
Call | Description |
---|---|
Get | Returns the specified dashboard. |
List | Retrieves the list of dashboards in the specified folder. |
Create | Creates a new dashboard in the specified folder. |
Update | Updates the specified dashboard. |
Delete | Deletes the specified dashboard. |
ListOperations | Lists operations for the specified dashboard. |
Calls DashboardService
Get
Returns the specified dashboard.
rpc Get (GetDashboardRequest) returns (Dashboard)
GetDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. Required. Dashboard ID. The maximum string length in characters is 50. |
Dashboard
Field | Description |
---|---|
id | string Dashboard ID. |
container | oneof: folder_id Container id |
folder_id | string Folder ID. |
created_at | google.protobuf.Timestamp Creation timestamp. |
modified_at | google.protobuf.Timestamp Modification timestamp. |
created_by | string ID of the user who created the dashboard. |
modified_by | string ID of the user who modified the dashboard. |
name | string Dashboard name. |
description | string Dashboard description. |
labels | map<string,string> Resource labels as key:value pairs. |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
etag | string Dashboard etag. |
Widget
Field | Description |
---|---|
position | LayoutPosition Required. Widget layout position. |
widget | oneof: text , title or chart Required. Widget data. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
chart | ChartWidget Chart widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 Required. X-axis top-left corner coordinate. |
y | int64 Required. Y-axis top-left corner coordinate. |
w | int64 Required. Weight. |
h | int64 Required. Height. |
TextWidget
Field | Description |
---|---|
text | string Text. |
TitleWidget
Field | Description |
---|---|
text | string Title text. |
size | enum TitleSize Title size.
|
ChartWidget
Field | Description |
---|---|
id | string Required. Chart ID. |
queries | Queries Queries. |
visualization_settings | VisualizationSettings Visualization settings. |
series_overrides[] | SeriesOverrides Override settings. |
name_hiding_settings | NameHidingSettings Name hiding settings. |
description | string Chart description in dashboard (not enabled in UI). |
title | string Chart widget title. |
display_legend | bool Enable legend under chart. |
freeze | enum FreezeDuration Fixed time interval for chart.
|
Queries
Field | Description |
---|---|
targets[] | Target Required. List of targets. |
downsampling | Downsampling Required. Downsampling settings. |
Target
Field | Description |
---|---|
query | string Required. Query. |
text_mode | bool Text mode. |
hidden | bool Checks that target is visible or invisible. |
VisualizationSettings
Field | Description |
---|---|
type | enum VisualizationType Visualization type.
|
normalize | bool Normalize. |
interpolate | enum Interpolate Interpolate.
|
aggregation | enum SeriesAggregation Aggregation.
|
color_scheme_settings | ColorSchemeSettings Color scheme settings. |
heatmap_settings | HeatmapSettings Heatmap settings. |
yaxis_settings | YaxisSettings Y axis settings. |
title | string Inside chart title. |
show_labels | bool Show chart labels. |
ColorSchemeSettings
Field | Description |
---|---|
scheme | oneof: automatic , standard or gradient |
automatic | AutomaticColorScheme Automatic color scheme. |
standard | StandardColorScheme Standard color scheme. |
gradient | GradientColorScheme Gradient color scheme. |
AutomaticColorScheme
StandardColorScheme
GradientColorScheme
Field | Description |
---|---|
green_value | string Gradient green value. |
yellow_value | string Gradient yellow value. |
red_value | string Gradient red value. |
violet_value | string Gradient violet_value. |
HeatmapSettings
Field | Description |
---|---|
green_value | string Heatmap green value. |
yellow_value | string Heatmap yellow value. |
red_value | string Heatmap red value. |
violet_value | string Heatmap violet_value. |
Yaxis
Field | Description |
---|---|
type | enum YaxisType Type.
|
title | string Title or empty. |
min | string Min value in extended number format or empty. |
max | string Max value in extended number format or empty. |
unit_format | enum UnitFormat Unit format.
|
precision | google.protobuf.Int64Value Tick value precision (null as default, 0-7 in other cases). |
YaxisSettings
Field | Description |
---|---|
left | Yaxis Left Y axis settings. |
right | Yaxis Right Y axis settings. |
SeriesOverrides
Field | Description |
---|---|
type | oneof: name or target_index Required. Series selection type. |
name | string Series name. |
target_index | string Target index. |
settings | SeriesOverrideSettings Required. Override settings. |
SeriesOverrideSettings
Field | Description |
---|---|
name | string Series name or empty. |
color | string Series color or empty. |
type | enum SeriesVisualizationType Type.
|
stack_name | string Stack name or empty. |
grow_down | bool Stack grow down. |
yaxis_position | enum YaxisPosition Yaxis position.
|
NameHidingSettings
Field | Description |
---|---|
positive | bool True if we want to show concrete series names only, false if we want to hide concrete series names. |
names[] | string Series names to show or hide. |
Downsampling
Field | Description |
---|---|
mode | oneof: max_points , grid_interval or disabled List of available gap filling policy for downsampling. |
max_points | int64 Maximum number of points to be returned. |
grid_interval | int64 Time interval (grid) for downsampling in milliseconds. Points in the specified range are aggregated into one time point. |
disabled | bool Disable downsampling. |
grid_aggregation | enum GridAggregation Function that is used for downsampling.
|
gap_filling | enum GapFilling Parameters for filling gaps in data.
|
Parametrization
Field | Description |
---|---|
parameters[] | Parameter Parameters. |
selectors | string Predefined selectors. |
Parameter
Field | Description |
---|---|
name | string Parameter identifier. |
title | string UI-visible title of the parameter. |
data | oneof: label_values , custom , text , integer_parameter , double_parameter or text_values Parameter data. |
label_values | LabelValuesParameter Label values parameter. |
custom | CustomParameter Custom parameter. |
text | TextParameter Text parameter. |
integer_parameter | IntegerParameter Integer parameter. |
double_parameter | DoubleParameter Double parameter. |
text_values | TextValuesParameter Integer parameter. |
hidden | bool UI-visibility. |
description | string Parameter description. |
LabelValuesParameter
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Folder ID. |
selectors | string Required. Selectors to select metric label values. |
label_key | string Required. Label key to list label values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
CustomParameter
Field | Description |
---|---|
values[] | string Required. List of parameter values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
TextParameter
Field | Description |
---|---|
default_value | string Default value. |
IntegerParameter
Field | Description |
---|---|
default_value | int64 Default value. |
unit_format | enum UnitFormat Parameter unit.
|
DoubleParameter
Field | Description |
---|---|
default_value | double Default value. |
unit_format | enum UnitFormat Parameter unit.
|
TextValuesParameter
Field | Description |
---|---|
default_values[] | string Default value. |
List
Retrieves the list of dashboards in the specified folder.
rpc List (ListDashboardsRequest) returns (ListDashboardsResponse)
ListDashboardsRequest
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Required. Folder ID. The maximum string length in characters is 50. |
page_size | int64 The maximum number of dashboards to return. If unspecified, at most 100 dashboards will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the [ListDashboardResponse.next_page_token] returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
ListDashboardsResponse
Field | Description |
---|---|
dashboards[] | Dashboard List of dashboards. |
next_page_token | string Token to retrieve the next page of results, or empty if there are no more results in the list. |
Dashboard
Field | Description |
---|---|
id | string Dashboard ID. |
container | oneof: folder_id Container id |
folder_id | string Folder ID. |
created_at | google.protobuf.Timestamp Creation timestamp. |
modified_at | google.protobuf.Timestamp Modification timestamp. |
created_by | string ID of the user who created the dashboard. |
modified_by | string ID of the user who modified the dashboard. |
name | string Dashboard name. |
description | string Dashboard description. |
labels | map<string,string> Resource labels as key:value pairs. |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
etag | string Dashboard etag. |
Widget
Field | Description |
---|---|
position | LayoutPosition Required. Widget layout position. |
widget | oneof: text , title or chart Required. Widget data. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
chart | ChartWidget Chart widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 Required. X-axis top-left corner coordinate. |
y | int64 Required. Y-axis top-left corner coordinate. |
w | int64 Required. Weight. |
h | int64 Required. Height. |
TextWidget
Field | Description |
---|---|
text | string Text. |
TitleWidget
Field | Description |
---|---|
text | string Title text. |
size | enum TitleSize Title size.
|
ChartWidget
Field | Description |
---|---|
id | string Required. Chart ID. |
queries | Queries Queries. |
visualization_settings | VisualizationSettings Visualization settings. |
series_overrides[] | SeriesOverrides Override settings. |
name_hiding_settings | NameHidingSettings Name hiding settings. |
description | string Chart description in dashboard (not enabled in UI). |
title | string Chart widget title. |
display_legend | bool Enable legend under chart. |
freeze | enum FreezeDuration Fixed time interval for chart.
|
Queries
Field | Description |
---|---|
targets[] | Target Required. List of targets. |
downsampling | Downsampling Required. Downsampling settings. |
Target
Field | Description |
---|---|
query | string Required. Query. |
text_mode | bool Text mode. |
hidden | bool Checks that target is visible or invisible. |
VisualizationSettings
Field | Description |
---|---|
type | enum VisualizationType Visualization type.
|
normalize | bool Normalize. |
interpolate | enum Interpolate Interpolate.
|
aggregation | enum SeriesAggregation Aggregation.
|
color_scheme_settings | ColorSchemeSettings Color scheme settings. |
heatmap_settings | HeatmapSettings Heatmap settings. |
yaxis_settings | YaxisSettings Y axis settings. |
title | string Inside chart title. |
show_labels | bool Show chart labels. |
ColorSchemeSettings
Field | Description |
---|---|
scheme | oneof: automatic , standard or gradient |
automatic | AutomaticColorScheme Automatic color scheme. |
standard | StandardColorScheme Standard color scheme. |
gradient | GradientColorScheme Gradient color scheme. |
AutomaticColorScheme
StandardColorScheme
GradientColorScheme
Field | Description |
---|---|
green_value | string Gradient green value. |
yellow_value | string Gradient yellow value. |
red_value | string Gradient red value. |
violet_value | string Gradient violet_value. |
HeatmapSettings
Field | Description |
---|---|
green_value | string Heatmap green value. |
yellow_value | string Heatmap yellow value. |
red_value | string Heatmap red value. |
violet_value | string Heatmap violet_value. |
Yaxis
Field | Description |
---|---|
type | enum YaxisType Type.
|
title | string Title or empty. |
min | string Min value in extended number format or empty. |
max | string Max value in extended number format or empty. |
unit_format | enum UnitFormat Unit format.
|
precision | google.protobuf.Int64Value Tick value precision (null as default, 0-7 in other cases). |
YaxisSettings
Field | Description |
---|---|
left | Yaxis Left Y axis settings. |
right | Yaxis Right Y axis settings. |
SeriesOverrides
Field | Description |
---|---|
type | oneof: name or target_index Required. Series selection type. |
name | string Series name. |
target_index | string Target index. |
settings | SeriesOverrideSettings Required. Override settings. |
SeriesOverrideSettings
Field | Description |
---|---|
name | string Series name or empty. |
color | string Series color or empty. |
type | enum SeriesVisualizationType Type.
|
stack_name | string Stack name or empty. |
grow_down | bool Stack grow down. |
yaxis_position | enum YaxisPosition Yaxis position.
|
NameHidingSettings
Field | Description |
---|---|
positive | bool True if we want to show concrete series names only, false if we want to hide concrete series names. |
names[] | string Series names to show or hide. |
Downsampling
Field | Description |
---|---|
mode | oneof: max_points , grid_interval or disabled List of available gap filling policy for downsampling. |
max_points | int64 Maximum number of points to be returned. |
grid_interval | int64 Time interval (grid) for downsampling in milliseconds. Points in the specified range are aggregated into one time point. |
disabled | bool Disable downsampling. |
grid_aggregation | enum GridAggregation Function that is used for downsampling.
|
gap_filling | enum GapFilling Parameters for filling gaps in data.
|
Parametrization
Field | Description |
---|---|
parameters[] | Parameter Parameters. |
selectors | string Predefined selectors. |
Parameter
Field | Description |
---|---|
name | string Parameter identifier. |
title | string UI-visible title of the parameter. |
data | oneof: label_values , custom , text , integer_parameter , double_parameter or text_values Parameter data. |
label_values | LabelValuesParameter Label values parameter. |
custom | CustomParameter Custom parameter. |
text | TextParameter Text parameter. |
integer_parameter | IntegerParameter Integer parameter. |
double_parameter | DoubleParameter Double parameter. |
text_values | TextValuesParameter Integer parameter. |
hidden | bool UI-visibility. |
description | string Parameter description. |
LabelValuesParameter
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Folder ID. |
selectors | string Required. Selectors to select metric label values. |
label_key | string Required. Label key to list label values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
CustomParameter
Field | Description |
---|---|
values[] | string Required. List of parameter values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
TextParameter
Field | Description |
---|---|
default_value | string Default value. |
IntegerParameter
Field | Description |
---|---|
default_value | int64 Default value. |
unit_format | enum UnitFormat Parameter unit.
|
DoubleParameter
Field | Description |
---|---|
default_value | double Default value. |
unit_format | enum UnitFormat Parameter unit.
|
TextValuesParameter
Field | Description |
---|---|
default_values[] | string Default value. |
Create
Creates a new dashboard in the specified folder.
rpc Create (CreateDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateDashboardMetadata
Operation.response:Dashboard
CreateDashboardRequest
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Required. Folder ID. The maximum string length in characters is 50. |
name | string Required. Dashboard name. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Dashboard description. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
Widget
Field | Description |
---|---|
position | LayoutPosition Required. Widget layout position. |
widget | oneof: text , title or chart Required. Widget data. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
chart | ChartWidget Chart widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 Required. X-axis top-left corner coordinate. |
y | int64 Required. Y-axis top-left corner coordinate. |
w | int64 Required. Weight. |
h | int64 Required. Height. |
TextWidget
Field | Description |
---|---|
text | string Text. |
TitleWidget
Field | Description |
---|---|
text | string Title text. |
size | enum TitleSize Title size.
|
ChartWidget
Field | Description |
---|---|
id | string Required. Chart ID. |
queries | Queries Queries. |
visualization_settings | VisualizationSettings Visualization settings. |
series_overrides[] | SeriesOverrides Override settings. |
name_hiding_settings | NameHidingSettings Name hiding settings. |
description | string Chart description in dashboard (not enabled in UI). |
title | string Chart widget title. |
display_legend | bool Enable legend under chart. |
freeze | enum FreezeDuration Fixed time interval for chart.
|
Queries
Field | Description |
---|---|
targets[] | Target Required. List of targets. |
downsampling | Downsampling Required. Downsampling settings. |
Target
Field | Description |
---|---|
query | string Required. Query. |
text_mode | bool Text mode. |
hidden | bool Checks that target is visible or invisible. |
VisualizationSettings
Field | Description |
---|---|
type | enum VisualizationType Visualization type.
|
normalize | bool Normalize. |
interpolate | enum Interpolate Interpolate.
|
aggregation | enum SeriesAggregation Aggregation.
|
color_scheme_settings | ColorSchemeSettings Color scheme settings. |
heatmap_settings | HeatmapSettings Heatmap settings. |
yaxis_settings | YaxisSettings Y axis settings. |
title | string Inside chart title. |
show_labels | bool Show chart labels. |
ColorSchemeSettings
Field | Description |
---|---|
scheme | oneof: automatic , standard or gradient |
automatic | AutomaticColorScheme Automatic color scheme. |
standard | StandardColorScheme Standard color scheme. |
gradient | GradientColorScheme Gradient color scheme. |
AutomaticColorScheme
StandardColorScheme
GradientColorScheme
Field | Description |
---|---|
green_value | string Gradient green value. |
yellow_value | string Gradient yellow value. |
red_value | string Gradient red value. |
violet_value | string Gradient violet_value. |
HeatmapSettings
Field | Description |
---|---|
green_value | string Heatmap green value. |
yellow_value | string Heatmap yellow value. |
red_value | string Heatmap red value. |
violet_value | string Heatmap violet_value. |
Yaxis
Field | Description |
---|---|
type | enum YaxisType Type.
|
title | string Title or empty. |
min | string Min value in extended number format or empty. |
max | string Max value in extended number format or empty. |
unit_format | enum UnitFormat Unit format.
|
precision | google.protobuf.Int64Value Tick value precision (null as default, 0-7 in other cases). |
YaxisSettings
Field | Description |
---|---|
left | Yaxis Left Y axis settings. |
right | Yaxis Right Y axis settings. |
SeriesOverrides
Field | Description |
---|---|
type | oneof: name or target_index Required. Series selection type. |
name | string Series name. |
target_index | string Target index. |
settings | SeriesOverrideSettings Required. Override settings. |
SeriesOverrideSettings
Field | Description |
---|---|
name | string Series name or empty. |
color | string Series color or empty. |
type | enum SeriesVisualizationType Type.
|
stack_name | string Stack name or empty. |
grow_down | bool Stack grow down. |
yaxis_position | enum YaxisPosition Yaxis position.
|
NameHidingSettings
Field | Description |
---|---|
positive | bool True if we want to show concrete series names only, false if we want to hide concrete series names. |
names[] | string Series names to show or hide. |
Downsampling
Field | Description |
---|---|
mode | oneof: max_points , grid_interval or disabled List of available gap filling policy for downsampling. |
max_points | int64 Maximum number of points to be returned. |
grid_interval | int64 Time interval (grid) for downsampling in milliseconds. Points in the specified range are aggregated into one time point. |
disabled | bool Disable downsampling. |
grid_aggregation | enum GridAggregation Function that is used for downsampling.
|
gap_filling | enum GapFilling Parameters for filling gaps in data.
|
Parametrization
Field | Description |
---|---|
parameters[] | Parameter Parameters. |
selectors | string Predefined selectors. |
Parameter
Field | Description |
---|---|
name | string Parameter identifier. |
title | string UI-visible title of the parameter. |
data | oneof: label_values , custom , text , integer_parameter , double_parameter or text_values Parameter data. |
label_values | LabelValuesParameter Label values parameter. |
custom | CustomParameter Custom parameter. |
text | TextParameter Text parameter. |
integer_parameter | IntegerParameter Integer parameter. |
double_parameter | DoubleParameter Double parameter. |
text_values | TextValuesParameter Integer parameter. |
hidden | bool UI-visibility. |
description | string Parameter description. |
LabelValuesParameter
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Folder ID. |
selectors | string Required. Selectors to select metric label values. |
label_key | string Required. Label key to list label values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
CustomParameter
Field | Description |
---|---|
values[] | string Required. List of parameter values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
TextParameter
Field | Description |
---|---|
default_value | string Default value. |
IntegerParameter
Field | Description |
---|---|
default_value | int64 Default value. |
unit_format | enum UnitFormat Parameter unit.
|
DoubleParameter
Field | Description |
---|---|
default_value | double Default value. |
unit_format | enum UnitFormat Parameter unit.
|
TextValuesParameter
Field | Description |
---|---|
default_values[] | string Default value. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateDashboardMetadata
Field | Description |
---|---|
dashboard_id | string Dashboard ID. |
Dashboard
Field | Description |
---|---|
id | string Dashboard ID. |
container | oneof: folder_id Container id |
folder_id | string Folder ID. |
created_at | google.protobuf.Timestamp Creation timestamp. |
modified_at | google.protobuf.Timestamp Modification timestamp. |
created_by | string ID of the user who created the dashboard. |
modified_by | string ID of the user who modified the dashboard. |
name | string Dashboard name. |
description | string Dashboard description. |
labels | map<string,string> Resource labels as key:value pairs. |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
etag | string Dashboard etag. |
Update
Updates the specified dashboard.
rpc Update (UpdateDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateDashboardMetadata
Operation.response:Dashboard
UpdateDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. Required. Dashboard ID. The maximum string length in characters is 50. |
name | string Required. Dashboard name. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Dashboard description. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
etag | string The current etag of the dashboard. |
Widget
Field | Description |
---|---|
position | LayoutPosition Required. Widget layout position. |
widget | oneof: text , title or chart Required. Widget data. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
chart | ChartWidget Chart widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 Required. X-axis top-left corner coordinate. |
y | int64 Required. Y-axis top-left corner coordinate. |
w | int64 Required. Weight. |
h | int64 Required. Height. |
TextWidget
Field | Description |
---|---|
text | string Text. |
TitleWidget
Field | Description |
---|---|
text | string Title text. |
size | enum TitleSize Title size.
|
ChartWidget
Field | Description |
---|---|
id | string Required. Chart ID. |
queries | Queries Queries. |
visualization_settings | VisualizationSettings Visualization settings. |
series_overrides[] | SeriesOverrides Override settings. |
name_hiding_settings | NameHidingSettings Name hiding settings. |
description | string Chart description in dashboard (not enabled in UI). |
title | string Chart widget title. |
display_legend | bool Enable legend under chart. |
freeze | enum FreezeDuration Fixed time interval for chart.
|
Queries
Field | Description |
---|---|
targets[] | Target Required. List of targets. |
downsampling | Downsampling Required. Downsampling settings. |
Target
Field | Description |
---|---|
query | string Required. Query. |
text_mode | bool Text mode. |
hidden | bool Checks that target is visible or invisible. |
VisualizationSettings
Field | Description |
---|---|
type | enum VisualizationType Visualization type.
|
normalize | bool Normalize. |
interpolate | enum Interpolate Interpolate.
|
aggregation | enum SeriesAggregation Aggregation.
|
color_scheme_settings | ColorSchemeSettings Color scheme settings. |
heatmap_settings | HeatmapSettings Heatmap settings. |
yaxis_settings | YaxisSettings Y axis settings. |
title | string Inside chart title. |
show_labels | bool Show chart labels. |
ColorSchemeSettings
Field | Description |
---|---|
scheme | oneof: automatic , standard or gradient |
automatic | AutomaticColorScheme Automatic color scheme. |
standard | StandardColorScheme Standard color scheme. |
gradient | GradientColorScheme Gradient color scheme. |
AutomaticColorScheme
StandardColorScheme
GradientColorScheme
Field | Description |
---|---|
green_value | string Gradient green value. |
yellow_value | string Gradient yellow value. |
red_value | string Gradient red value. |
violet_value | string Gradient violet_value. |
HeatmapSettings
Field | Description |
---|---|
green_value | string Heatmap green value. |
yellow_value | string Heatmap yellow value. |
red_value | string Heatmap red value. |
violet_value | string Heatmap violet_value. |
Yaxis
Field | Description |
---|---|
type | enum YaxisType Type.
|
title | string Title or empty. |
min | string Min value in extended number format or empty. |
max | string Max value in extended number format or empty. |
unit_format | enum UnitFormat Unit format.
|
precision | google.protobuf.Int64Value Tick value precision (null as default, 0-7 in other cases). |
YaxisSettings
Field | Description |
---|---|
left | Yaxis Left Y axis settings. |
right | Yaxis Right Y axis settings. |
SeriesOverrides
Field | Description |
---|---|
type | oneof: name or target_index Required. Series selection type. |
name | string Series name. |
target_index | string Target index. |
settings | SeriesOverrideSettings Required. Override settings. |
SeriesOverrideSettings
Field | Description |
---|---|
name | string Series name or empty. |
color | string Series color or empty. |
type | enum SeriesVisualizationType Type.
|
stack_name | string Stack name or empty. |
grow_down | bool Stack grow down. |
yaxis_position | enum YaxisPosition Yaxis position.
|
NameHidingSettings
Field | Description |
---|---|
positive | bool True if we want to show concrete series names only, false if we want to hide concrete series names. |
names[] | string Series names to show or hide. |
Downsampling
Field | Description |
---|---|
mode | oneof: max_points , grid_interval or disabled List of available gap filling policy for downsampling. |
max_points | int64 Maximum number of points to be returned. |
grid_interval | int64 Time interval (grid) for downsampling in milliseconds. Points in the specified range are aggregated into one time point. |
disabled | bool Disable downsampling. |
grid_aggregation | enum GridAggregation Function that is used for downsampling.
|
gap_filling | enum GapFilling Parameters for filling gaps in data.
|
Parametrization
Field | Description |
---|---|
parameters[] | Parameter Parameters. |
selectors | string Predefined selectors. |
Parameter
Field | Description |
---|---|
name | string Parameter identifier. |
title | string UI-visible title of the parameter. |
data | oneof: label_values , custom , text , integer_parameter , double_parameter or text_values Parameter data. |
label_values | LabelValuesParameter Label values parameter. |
custom | CustomParameter Custom parameter. |
text | TextParameter Text parameter. |
integer_parameter | IntegerParameter Integer parameter. |
double_parameter | DoubleParameter Double parameter. |
text_values | TextValuesParameter Integer parameter. |
hidden | bool UI-visibility. |
description | string Parameter description. |
LabelValuesParameter
Field | Description |
---|---|
container | oneof: folder_id Container id |
folder_id | string Required. Folder ID. |
selectors | string Required. Selectors to select metric label values. |
label_key | string Required. Label key to list label values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
CustomParameter
Field | Description |
---|---|
values[] | string Required. List of parameter values. |
multiselectable | bool Specifies the multiselectable values of parameter. |
default_values[] | string Default values. |
TextParameter
Field | Description |
---|---|
default_value | string Default value. |
IntegerParameter
Field | Description |
---|---|
default_value | int64 Default value. |
unit_format | enum UnitFormat Parameter unit.
|
DoubleParameter
Field | Description |
---|---|
default_value | double Default value. |
unit_format | enum UnitFormat Parameter unit.
|
TextValuesParameter
Field | Description |
---|---|
default_values[] | string Default value. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateDashboardMetadata
Field | Description |
---|---|
dashboard_id | string Dashboard ID. |
Dashboard
Field | Description |
---|---|
id | string Dashboard ID. |
container | oneof: folder_id Container id |
folder_id | string Folder ID. |
created_at | google.protobuf.Timestamp Creation timestamp. |
modified_at | google.protobuf.Timestamp Modification timestamp. |
created_by | string ID of the user who created the dashboard. |
modified_by | string ID of the user who modified the dashboard. |
name | string Dashboard name. |
description | string Dashboard description. |
labels | map<string,string> Resource labels as key:value pairs. |
title | string Dashboard title. |
widgets[] | Widget List of dashboard widgets. |
parametrization | Parametrization Dashboard parametrization. |
etag | string Dashboard etag. |
Delete
Deletes the specified dashboard.
rpc Delete (DeleteDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteDashboardMetadata
Operation.response:google.protobuf.Empty
DeleteDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. Required. Dashboard ID. The maximum string length in characters is 50. |
etag | string The current etag of the dashboard. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteDashboardMetadata
Field | Description |
---|---|
dashboard_id | string Dashboard ID. |
ListOperations
Lists operations for the specified dashboard.
rpc ListOperations (ListDashboardOperationsRequest) returns (ListDashboardOperationsResponse)
ListDashboardOperationsRequest
Field | Description |
---|---|
dashboard_id | string Required. ID of the dashboard to list operations for. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListDashboardOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListDashboardOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListDashboardOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified dashboard. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListDashboardOperationsRequest.page_size, use the next_page_token as the value for the ListDashboardOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |