[Документация Yandex Cloud](../../../index.md) > [Monium](../../index.md) > Справочник API > Метрики > [gRPC (англ.)](index.md) > DashboardService # Monitoring API, gRPC: DashboardService A set of methods for managing dashboards. | Call | Description | | --- | --- | | [Get](#Get) | Returns the specified dashboard. | | [List](#List) | Retrieves the list of dashboards in the specified folder. | | [Create](#Create) | Creates a new dashboard in the specified folder. | | [Update](#Update) | Updates the specified dashboard. | | [Delete](#Delete) | Deletes the specified dashboard. | | [ListOperations](#ListOperations) | Lists operations for the specified dashboard. | ## Calls DashboardService {#calls} ## Get {#Get} Returns the specified dashboard. **rpc Get ([GetDashboardRequest](#GetDashboardRequest)) returns ([Dashboard](#Dashboard))** ### GetDashboardRequest {#GetDashboardRequest} Field | Description --- | --- dashboard_id | **string**
Required. Required. Dashboard ID. The maximum string length in characters is 50. ### Dashboard {#Dashboard} Field | Description --- | --- id | **string**
Dashboard ID. container | **oneof:** `folder_id`
Container id   folder_id | **string**
Folder ID. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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**
Resource labels as `key:value` pairs. title | **string**
Dashboard title. widgets[] | **[Widget](#Widget)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization)**
Dashboard parametrization. etag | **string**
Dashboard etag. ### Widget {#Widget} Field | Description --- | --- position | **[LayoutPosition](#LayoutPosition)**
Required. Widget layout position. widget | **oneof:** `text`, `title` or `chart`
Required. Widget data.   text | **[TextWidget](#TextWidget)**
Text widget.   title | **[TitleWidget](#TitleWidget)**
Title widget.   chart | **[ChartWidget](#ChartWidget)**
Chart widget. ### LayoutPosition {#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 {#TextWidget} Field | Description --- | --- text | **string**
Text. ### TitleWidget {#TitleWidget} Field | Description --- | --- text | **string**
Title text. size | enum **TitleSize**
Title size. ### ChartWidget {#ChartWidget} Field | Description --- | --- id | **string**
Required. Chart ID. queries | **[Queries](#Queries)**
Queries. visualization_settings | **[VisualizationSettings](#VisualizationSettings)**
Visualization settings. series_overrides[] | **[SeriesOverrides](#SeriesOverrides)**
Override settings. name_hiding_settings | **[NameHidingSettings](#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 {#Queries} Field | Description --- | --- targets[] | **[Target](#Target)**
Required. List of targets. downsampling | **[Downsampling](#Downsampling)**
Required. Downsampling settings. ### Target {#Target} Field | Description --- | --- query | **string**
Required. Query. text_mode | **bool**
Text mode. hidden | **bool**
Checks that target is visible or invisible. ### VisualizationSettings {#VisualizationSettings} Field | Description --- | --- type | enum **VisualizationType**
Visualization type. normalize | **bool**
Normalize. interpolate | enum **Interpolate**
Interpolate. aggregation | enum **SeriesAggregation**
Aggregation. color_scheme_settings | **[ColorSchemeSettings](#ColorSchemeSettings)**
Color scheme settings. heatmap_settings | **[HeatmapSettings](#HeatmapSettings)**
Heatmap settings. yaxis_settings | **[YaxisSettings](#YaxisSettings)**
Y axis settings. title | **string**
Inside chart title. show_labels | **bool**
Show chart labels. ### ColorSchemeSettings {#ColorSchemeSettings} Field | Description --- | --- scheme | **oneof:** `automatic`, `standard` or `gradient`
  automatic | **[AutomaticColorScheme](#AutomaticColorScheme)**
Automatic color scheme.   standard | **[StandardColorScheme](#StandardColorScheme)**
Standard color scheme.   gradient | **[GradientColorScheme](#GradientColorScheme)**
Gradient color scheme. ### AutomaticColorScheme {#AutomaticColorScheme} ### StandardColorScheme {#StandardColorScheme} ### GradientColorScheme {#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 {#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 {#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](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)**
Tick value precision (null as default, 0-7 in other cases). ### YaxisSettings {#YaxisSettings} Field | Description --- | --- left | **[Yaxis](#Yaxis)**
Left Y axis settings. right | **[Yaxis](#Yaxis)**
Right Y axis settings. ### SeriesOverrides {#SeriesOverrides} Field | Description --- | --- type | **oneof:** `name` or `target_index`
Required. Series selection type.   name | **string**
Series name.   target_index | **string**
Target index. settings | **[SeriesOverrideSettings](#SeriesOverrideSettings)**
Required. Override settings. ### SeriesOverrideSettings {#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 {#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 {#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 {#Parametrization} Field | Description --- | --- parameters[] | **[Parameter](#Parameter)**
Parameters. selectors | **string**
Predefined selectors. ### Parameter {#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](#LabelValuesParameter)**
Label values parameter.   custom | **[CustomParameter](#CustomParameter)**
Custom parameter.   text | **[TextParameter](#TextParameter)**
Text parameter.   integer_parameter | **[IntegerParameter](#IntegerParameter)**
Integer parameter.   double_parameter | **[DoubleParameter](#DoubleParameter)**
Double parameter.   text_values | **[TextValuesParameter](#TextValuesParameter)**
Integer parameter. hidden | **bool**
UI-visibility. description | **string**
Parameter description. ### LabelValuesParameter {#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 {#CustomParameter} Field | Description --- | --- values[] | **string**
Required. List of parameter values. multiselectable | **bool**
Specifies the multiselectable values of parameter. default_values[] | **string**
Default values. ### TextParameter {#TextParameter} Field | Description --- | --- default_value | **string**
Default value. ### IntegerParameter {#IntegerParameter} Field | Description --- | --- default_value | **int64**
Default value. unit_format | enum **UnitFormat**
Parameter unit. ### DoubleParameter {#DoubleParameter} Field | Description --- | --- default_value | **double**
Default value. unit_format | enum **UnitFormat**
Parameter unit. ### TextValuesParameter {#TextValuesParameter} Field | Description --- | --- default_values[] | **string**
Default value. ## List {#List} Retrieves the list of dashboards in the specified folder. **rpc List ([ListDashboardsRequest](#ListDashboardsRequest)) returns ([ListDashboardsResponse](#ListDashboardsResponse))** ### ListDashboardsRequest {#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:
  1. The field name. Currently you can use filtering only on the [Dashboard.name](#Dashboard1) field.
  2. An `=` operator.
  3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
Example: name="abc" The maximum string length in characters is 1000. ### ListDashboardsResponse {#ListDashboardsResponse} Field | Description --- | --- dashboards[] | **[Dashboard](#Dashboard1)**
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 {#Dashboard1} Field | Description --- | --- id | **string**
Dashboard ID. container | **oneof:** `folder_id`
Container id   folder_id | **string**
Folder ID. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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**
Resource labels as `key:value` pairs. title | **string**
Dashboard title. widgets[] | **[Widget](#Widget1)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization1)**
Dashboard parametrization. etag | **string**
Dashboard etag. ### Widget {#Widget1} Field | Description --- | --- position | **[LayoutPosition](#LayoutPosition1)**
Required. Widget layout position. widget | **oneof:** `text`, `title` or `chart`
Required. Widget data.   text | **[TextWidget](#TextWidget1)**
Text widget.   title | **[TitleWidget](#TitleWidget1)**
Title widget.   chart | **[ChartWidget](#ChartWidget1)**
Chart widget. ### LayoutPosition {#LayoutPosition1} 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 {#TextWidget1} Field | Description --- | --- text | **string**
Text. ### TitleWidget {#TitleWidget1} Field | Description --- | --- text | **string**
Title text. size | enum **TitleSize**
Title size. ### ChartWidget {#ChartWidget1} Field | Description --- | --- id | **string**
Required. Chart ID. queries | **[Queries](#Queries1)**
Queries. visualization_settings | **[VisualizationSettings](#VisualizationSettings1)**
Visualization settings. series_overrides[] | **[SeriesOverrides](#SeriesOverrides1)**
Override settings. name_hiding_settings | **[NameHidingSettings](#NameHidingSettings1)**
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 {#Queries1} Field | Description --- | --- targets[] | **[Target](#Target1)**
Required. List of targets. downsampling | **[Downsampling](#Downsampling1)**
Required. Downsampling settings. ### Target {#Target1} Field | Description --- | --- query | **string**
Required. Query. text_mode | **bool**
Text mode. hidden | **bool**
Checks that target is visible or invisible. ### VisualizationSettings {#VisualizationSettings1} Field | Description --- | --- type | enum **VisualizationType**
Visualization type. normalize | **bool**
Normalize. interpolate | enum **Interpolate**
Interpolate. aggregation | enum **SeriesAggregation**
Aggregation. color_scheme_settings | **[ColorSchemeSettings](#ColorSchemeSettings1)**
Color scheme settings. heatmap_settings | **[HeatmapSettings](#HeatmapSettings1)**
Heatmap settings. yaxis_settings | **[YaxisSettings](#YaxisSettings1)**
Y axis settings. title | **string**
Inside chart title. show_labels | **bool**
Show chart labels. ### ColorSchemeSettings {#ColorSchemeSettings1} Field | Description --- | --- scheme | **oneof:** `automatic`, `standard` or `gradient`
  automatic | **[AutomaticColorScheme](#AutomaticColorScheme1)**
Automatic color scheme.   standard | **[StandardColorScheme](#StandardColorScheme1)**
Standard color scheme.   gradient | **[GradientColorScheme](#GradientColorScheme1)**
Gradient color scheme. ### AutomaticColorScheme {#AutomaticColorScheme1} ### StandardColorScheme {#StandardColorScheme1} ### GradientColorScheme {#GradientColorScheme1} 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 {#HeatmapSettings1} 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 {#Yaxis1} 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](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)**
Tick value precision (null as default, 0-7 in other cases). ### YaxisSettings {#YaxisSettings1} Field | Description --- | --- left | **[Yaxis](#Yaxis1)**
Left Y axis settings. right | **[Yaxis](#Yaxis1)**
Right Y axis settings. ### SeriesOverrides {#SeriesOverrides1} Field | Description --- | --- type | **oneof:** `name` or `target_index`
Required. Series selection type.   name | **string**
Series name.   target_index | **string**
Target index. settings | **[SeriesOverrideSettings](#SeriesOverrideSettings1)**
Required. Override settings. ### SeriesOverrideSettings {#SeriesOverrideSettings1} 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 {#NameHidingSettings1} 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 {#Downsampling1} 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 {#Parametrization1} Field | Description --- | --- parameters[] | **[Parameter](#Parameter1)**
Parameters. selectors | **string**
Predefined selectors. ### Parameter {#Parameter1} 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](#LabelValuesParameter1)**
Label values parameter.   custom | **[CustomParameter](#CustomParameter1)**
Custom parameter.   text | **[TextParameter](#TextParameter1)**
Text parameter.   integer_parameter | **[IntegerParameter](#IntegerParameter1)**
Integer parameter.   double_parameter | **[DoubleParameter](#DoubleParameter1)**
Double parameter.   text_values | **[TextValuesParameter](#TextValuesParameter1)**
Integer parameter. hidden | **bool**
UI-visibility. description | **string**
Parameter description. ### LabelValuesParameter {#LabelValuesParameter1} 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 {#CustomParameter1} Field | Description --- | --- values[] | **string**
Required. List of parameter values. multiselectable | **bool**
Specifies the multiselectable values of parameter. default_values[] | **string**
Default values. ### TextParameter {#TextParameter1} Field | Description --- | --- default_value | **string**
Default value. ### IntegerParameter {#IntegerParameter1} Field | Description --- | --- default_value | **int64**
Default value. unit_format | enum **UnitFormat**
Parameter unit. ### DoubleParameter {#DoubleParameter1} Field | Description --- | --- default_value | **double**
Default value. unit_format | enum **UnitFormat**
Parameter unit. ### TextValuesParameter {#TextValuesParameter1} Field | Description --- | --- default_values[] | **string**
Default value. ## Create {#Create} Creates a new dashboard in the specified folder. **rpc Create ([CreateDashboardRequest](#CreateDashboardRequest)) returns ([operation.Operation](#Operation))** Metadata and response of Operation:
    Operation.metadata:[CreateDashboardMetadata](#CreateDashboardMetadata)
    Operation.response:[Dashboard](#Dashboard2)
### CreateDashboardRequest {#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**
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](#Widget2)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization2)**
Dashboard parametrization. ### Widget {#Widget2} Field | Description --- | --- position | **[LayoutPosition](#LayoutPosition2)**
Required. Widget layout position. widget | **oneof:** `text`, `title` or `chart`
Required. Widget data.   text | **[TextWidget](#TextWidget2)**
Text widget.   title | **[TitleWidget](#TitleWidget2)**
Title widget.   chart | **[ChartWidget](#ChartWidget2)**
Chart widget. ### LayoutPosition {#LayoutPosition2} 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 {#TextWidget2} Field | Description --- | --- text | **string**
Text. ### TitleWidget {#TitleWidget2} Field | Description --- | --- text | **string**
Title text. size | enum **TitleSize**
Title size.
  • `TITLE_SIZE_XS`: Extra small size.
  • `TITLE_SIZE_S`: Small size.
  • `TITLE_SIZE_M`: Middle size.
  • `TITLE_SIZE_L`: Large size.
### ChartWidget {#ChartWidget2} Field | Description --- | --- id | **string**
Required. Chart ID. queries | **[Queries](#Queries2)**
Queries. visualization_settings | **[VisualizationSettings](#VisualizationSettings2)**
Visualization settings. series_overrides[] | **[SeriesOverrides](#SeriesOverrides2)**
Override settings. name_hiding_settings | **[NameHidingSettings](#NameHidingSettings2)**
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.
  • `FREEZE_DURATION_HOUR`: Last hour.
  • `FREEZE_DURATION_DAY`: Last day = last 24 hours.
  • `FREEZE_DURATION_WEEK`: Last 7 days.
  • `FREEZE_DURATION_MONTH`: Last 31 days.
### Queries {#Queries2} Field | Description --- | --- targets[] | **[Target](#Target2)**
Required. List of targets. downsampling | **[Downsampling](#Downsampling2)**
Required. Downsampling settings. ### Target {#Target2} Field | Description --- | --- query | **string**
Required. Query. text_mode | **bool**
Text mode. hidden | **bool**
Checks that target is visible or invisible. ### VisualizationSettings {#VisualizationSettings2} Field | Description --- | --- type | enum **VisualizationType**
Visualization type.
  • `VISUALIZATION_TYPE_UNSPECIFIED`: Not specified (line by default).
  • `VISUALIZATION_TYPE_LINE`: Line chart.
  • `VISUALIZATION_TYPE_STACK`: Stack chart.
  • `VISUALIZATION_TYPE_COLUMN`: Points as columns chart.
  • `VISUALIZATION_TYPE_POINTS`: Points.
  • `VISUALIZATION_TYPE_PIE`: Pie aggregation chart.
  • `VISUALIZATION_TYPE_BARS`: Bars aggregation chart.
  • `VISUALIZATION_TYPE_DISTRIBUTION`: Distribution aggregation chart.
  • `VISUALIZATION_TYPE_HEATMAP`: Heatmap aggregation chart.
normalize | **bool**
Normalize. interpolate | enum **Interpolate**
Interpolate.
  • `INTERPOLATE_UNSPECIFIED`: Not specified (linear by default).
  • `INTERPOLATE_LINEAR`: Linear.
  • `INTERPOLATE_LEFT`: Left.
  • `INTERPOLATE_RIGHT`: Right.
aggregation | enum **SeriesAggregation**
Aggregation.
  • `SERIES_AGGREGATION_UNSPECIFIED`: Not specified (avg by default).
  • `SERIES_AGGREGATION_AVG`: Average.
  • `SERIES_AGGREGATION_MIN`: Minimum.
  • `SERIES_AGGREGATION_MAX`: Maximum.
  • `SERIES_AGGREGATION_LAST`: Last non-NaN value.
  • `SERIES_AGGREGATION_SUM`: Sum.
color_scheme_settings | **[ColorSchemeSettings](#ColorSchemeSettings2)**
Color scheme settings. heatmap_settings | **[HeatmapSettings](#HeatmapSettings2)**
Heatmap settings. yaxis_settings | **[YaxisSettings](#YaxisSettings2)**
Y axis settings. title | **string**
Inside chart title. show_labels | **bool**
Show chart labels. ### ColorSchemeSettings {#ColorSchemeSettings2} Field | Description --- | --- scheme | **oneof:** `automatic`, `standard` or `gradient`
  automatic | **[AutomaticColorScheme](#AutomaticColorScheme2)**
Automatic color scheme.   standard | **[StandardColorScheme](#StandardColorScheme2)**
Standard color scheme.   gradient | **[GradientColorScheme](#GradientColorScheme2)**
Gradient color scheme. ### AutomaticColorScheme {#AutomaticColorScheme2} ### StandardColorScheme {#StandardColorScheme2} ### GradientColorScheme {#GradientColorScheme2} 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 {#HeatmapSettings2} 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 {#Yaxis2} Field | Description --- | --- type | enum **YaxisType**
Type.
  • `YAXIS_TYPE_UNSPECIFIED`: Not specified (linear by default).
  • `YAXIS_TYPE_LINEAR`: Linear.
  • `YAXIS_TYPE_LOGARITHMIC`: Logarithmic.
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.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
precision | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)**
Tick value precision (null as default, 0-7 in other cases). ### YaxisSettings {#YaxisSettings2} Field | Description --- | --- left | **[Yaxis](#Yaxis2)**
Left Y axis settings. right | **[Yaxis](#Yaxis2)**
Right Y axis settings. ### SeriesOverrides {#SeriesOverrides2} Field | Description --- | --- type | **oneof:** `name` or `target_index`
Required. Series selection type.   name | **string**
Series name.   target_index | **string**
Target index. settings | **[SeriesOverrideSettings](#SeriesOverrideSettings2)**
Required. Override settings. ### SeriesOverrideSettings {#SeriesOverrideSettings2} Field | Description --- | --- name | **string**
Series name or empty. color | **string**
Series color or empty. type | enum **SeriesVisualizationType**
Type.
  • `SERIES_VISUALIZATION_TYPE_UNSPECIFIED`: Not specified (line by default).
  • `SERIES_VISUALIZATION_TYPE_LINE`: Line chart.
  • `SERIES_VISUALIZATION_TYPE_STACK`: Stack chart.
  • `SERIES_VISUALIZATION_TYPE_COLUMN`: Points as columns chart.
  • `SERIES_VISUALIZATION_TYPE_POINTS`: Points.
stack_name | **string**
Stack name or empty. grow_down | **bool**
Stack grow down. yaxis_position | enum **YaxisPosition**
Yaxis position.
  • `YAXIS_POSITION_UNSPECIFIED`: Not specified (left by default).
  • `YAXIS_POSITION_LEFT`: Left.
  • `YAXIS_POSITION_RIGHT`: Right.
### NameHidingSettings {#NameHidingSettings2} 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 {#Downsampling2} 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.
  • `GRID_AGGREGATION_MAX`: Max value.
  • `GRID_AGGREGATION_MIN`: Min value.
  • `GRID_AGGREGATION_SUM`: Sum of values.
  • `GRID_AGGREGATION_AVG`: Average value.
  • `GRID_AGGREGATION_LAST`: Last value.
  • `GRID_AGGREGATION_COUNT`: Total count of points.
gap_filling | enum **GapFilling**
Parameters for filling gaps in data.
  • `GAP_FILLING_NULL`: Returns `null` as a metric value and `timestamp` as a time series value.
  • `GAP_FILLING_NONE`: Returns no value and no timestamp.
  • `GAP_FILLING_PREVIOUS`: Returns the value from the previous time interval.
### Parametrization {#Parametrization2} Field | Description --- | --- parameters[] | **[Parameter](#Parameter2)**
Parameters. selectors | **string**
Predefined selectors. ### Parameter {#Parameter2} 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](#LabelValuesParameter2)**
Label values parameter.   custom | **[CustomParameter](#CustomParameter2)**
Custom parameter.   text | **[TextParameter](#TextParameter2)**
Text parameter.   integer_parameter | **[IntegerParameter](#IntegerParameter2)**
Integer parameter.   double_parameter | **[DoubleParameter](#DoubleParameter2)**
Double parameter.   text_values | **[TextValuesParameter](#TextValuesParameter2)**
Integer parameter. hidden | **bool**
UI-visibility. description | **string**
Parameter description. ### LabelValuesParameter {#LabelValuesParameter2} 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 {#CustomParameter2} Field | Description --- | --- values[] | **string**
Required. List of parameter values. multiselectable | **bool**
Specifies the multiselectable values of parameter. default_values[] | **string**
Default values. ### TextParameter {#TextParameter2} Field | Description --- | --- default_value | **string**
Default value. ### IntegerParameter {#IntegerParameter2} Field | Description --- | --- default_value | **int64**
Default value. unit_format | enum **UnitFormat**
Parameter unit.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
### DoubleParameter {#DoubleParameter2} Field | Description --- | --- default_value | **double**
Default value. unit_format | enum **UnitFormat**
Parameter unit.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
### TextValuesParameter {#TextValuesParameter2} Field | Description --- | --- default_values[] | **string**
Default value. ### Operation {#Operation} Field | Description --- | --- id | **string**
ID of the operation. description | **string**
Description of the operation. 0-256 characters long. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. created_by | **string**
ID of the user or service account who initiated the operation. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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](https://developers.google.com/protocol-buffers/docs/proto3#any)<[CreateDashboardMetadata](#CreateDashboardMetadata)>**
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](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)**
The error result of the operation in case of failure or cancellation.   response | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#any)<[Dashboard](#Dashboard2)>**
if operation finished successfully. ### CreateDashboardMetadata {#CreateDashboardMetadata} Field | Description --- | --- dashboard_id | **string**
Dashboard ID. ### Dashboard {#Dashboard2} Field | Description --- | --- id | **string**
Dashboard ID. container | **oneof:** `folder_id`
Container id   folder_id | **string**
Folder ID. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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**
Resource labels as `key:value` pairs. title | **string**
Dashboard title. widgets[] | **[Widget](#Widget3)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization3)**
Dashboard parametrization. etag | **string**
Dashboard etag. ## Update {#Update} Updates the specified dashboard. **rpc Update ([UpdateDashboardRequest](#UpdateDashboardRequest)) returns ([operation.Operation](#Operation1))** Metadata and response of Operation:
    Operation.metadata:[UpdateDashboardMetadata](#UpdateDashboardMetadata)
    Operation.response:[Dashboard](#Dashboard3)
### UpdateDashboardRequest {#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**
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](#Widget3)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization3)**
Dashboard parametrization. etag | **string**
The current etag of the dashboard. ### Widget {#Widget3} Field | Description --- | --- position | **[LayoutPosition](#LayoutPosition3)**
Required. Widget layout position. widget | **oneof:** `text`, `title` or `chart`
Required. Widget data.   text | **[TextWidget](#TextWidget3)**
Text widget.   title | **[TitleWidget](#TitleWidget3)**
Title widget.   chart | **[ChartWidget](#ChartWidget3)**
Chart widget. ### LayoutPosition {#LayoutPosition3} 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 {#TextWidget3} Field | Description --- | --- text | **string**
Text. ### TitleWidget {#TitleWidget3} Field | Description --- | --- text | **string**
Title text. size | enum **TitleSize**
Title size.
  • `TITLE_SIZE_XS`: Extra small size.
  • `TITLE_SIZE_S`: Small size.
  • `TITLE_SIZE_M`: Middle size.
  • `TITLE_SIZE_L`: Large size.
### ChartWidget {#ChartWidget3} Field | Description --- | --- id | **string**
Required. Chart ID. queries | **[Queries](#Queries3)**
Queries. visualization_settings | **[VisualizationSettings](#VisualizationSettings3)**
Visualization settings. series_overrides[] | **[SeriesOverrides](#SeriesOverrides3)**
Override settings. name_hiding_settings | **[NameHidingSettings](#NameHidingSettings3)**
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.
  • `FREEZE_DURATION_HOUR`: Last hour.
  • `FREEZE_DURATION_DAY`: Last day = last 24 hours.
  • `FREEZE_DURATION_WEEK`: Last 7 days.
  • `FREEZE_DURATION_MONTH`: Last 31 days.
### Queries {#Queries3} Field | Description --- | --- targets[] | **[Target](#Target3)**
Required. List of targets. downsampling | **[Downsampling](#Downsampling3)**
Required. Downsampling settings. ### Target {#Target3} Field | Description --- | --- query | **string**
Required. Query. text_mode | **bool**
Text mode. hidden | **bool**
Checks that target is visible or invisible. ### VisualizationSettings {#VisualizationSettings3} Field | Description --- | --- type | enum **VisualizationType**
Visualization type.
  • `VISUALIZATION_TYPE_UNSPECIFIED`: Not specified (line by default).
  • `VISUALIZATION_TYPE_LINE`: Line chart.
  • `VISUALIZATION_TYPE_STACK`: Stack chart.
  • `VISUALIZATION_TYPE_COLUMN`: Points as columns chart.
  • `VISUALIZATION_TYPE_POINTS`: Points.
  • `VISUALIZATION_TYPE_PIE`: Pie aggregation chart.
  • `VISUALIZATION_TYPE_BARS`: Bars aggregation chart.
  • `VISUALIZATION_TYPE_DISTRIBUTION`: Distribution aggregation chart.
  • `VISUALIZATION_TYPE_HEATMAP`: Heatmap aggregation chart.
normalize | **bool**
Normalize. interpolate | enum **Interpolate**
Interpolate.
  • `INTERPOLATE_UNSPECIFIED`: Not specified (linear by default).
  • `INTERPOLATE_LINEAR`: Linear.
  • `INTERPOLATE_LEFT`: Left.
  • `INTERPOLATE_RIGHT`: Right.
aggregation | enum **SeriesAggregation**
Aggregation.
  • `SERIES_AGGREGATION_UNSPECIFIED`: Not specified (avg by default).
  • `SERIES_AGGREGATION_AVG`: Average.
  • `SERIES_AGGREGATION_MIN`: Minimum.
  • `SERIES_AGGREGATION_MAX`: Maximum.
  • `SERIES_AGGREGATION_LAST`: Last non-NaN value.
  • `SERIES_AGGREGATION_SUM`: Sum.
color_scheme_settings | **[ColorSchemeSettings](#ColorSchemeSettings3)**
Color scheme settings. heatmap_settings | **[HeatmapSettings](#HeatmapSettings3)**
Heatmap settings. yaxis_settings | **[YaxisSettings](#YaxisSettings3)**
Y axis settings. title | **string**
Inside chart title. show_labels | **bool**
Show chart labels. ### ColorSchemeSettings {#ColorSchemeSettings3} Field | Description --- | --- scheme | **oneof:** `automatic`, `standard` or `gradient`
  automatic | **[AutomaticColorScheme](#AutomaticColorScheme3)**
Automatic color scheme.   standard | **[StandardColorScheme](#StandardColorScheme3)**
Standard color scheme.   gradient | **[GradientColorScheme](#GradientColorScheme3)**
Gradient color scheme. ### AutomaticColorScheme {#AutomaticColorScheme3} ### StandardColorScheme {#StandardColorScheme3} ### GradientColorScheme {#GradientColorScheme3} 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 {#HeatmapSettings3} 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 {#Yaxis3} Field | Description --- | --- type | enum **YaxisType**
Type.
  • `YAXIS_TYPE_UNSPECIFIED`: Not specified (linear by default).
  • `YAXIS_TYPE_LINEAR`: Linear.
  • `YAXIS_TYPE_LOGARITHMIC`: Logarithmic.
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.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
precision | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)**
Tick value precision (null as default, 0-7 in other cases). ### YaxisSettings {#YaxisSettings3} Field | Description --- | --- left | **[Yaxis](#Yaxis3)**
Left Y axis settings. right | **[Yaxis](#Yaxis3)**
Right Y axis settings. ### SeriesOverrides {#SeriesOverrides3} Field | Description --- | --- type | **oneof:** `name` or `target_index`
Required. Series selection type.   name | **string**
Series name.   target_index | **string**
Target index. settings | **[SeriesOverrideSettings](#SeriesOverrideSettings3)**
Required. Override settings. ### SeriesOverrideSettings {#SeriesOverrideSettings3} Field | Description --- | --- name | **string**
Series name or empty. color | **string**
Series color or empty. type | enum **SeriesVisualizationType**
Type.
  • `SERIES_VISUALIZATION_TYPE_UNSPECIFIED`: Not specified (line by default).
  • `SERIES_VISUALIZATION_TYPE_LINE`: Line chart.
  • `SERIES_VISUALIZATION_TYPE_STACK`: Stack chart.
  • `SERIES_VISUALIZATION_TYPE_COLUMN`: Points as columns chart.
  • `SERIES_VISUALIZATION_TYPE_POINTS`: Points.
stack_name | **string**
Stack name or empty. grow_down | **bool**
Stack grow down. yaxis_position | enum **YaxisPosition**
Yaxis position.
  • `YAXIS_POSITION_UNSPECIFIED`: Not specified (left by default).
  • `YAXIS_POSITION_LEFT`: Left.
  • `YAXIS_POSITION_RIGHT`: Right.
### NameHidingSettings {#NameHidingSettings3} 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 {#Downsampling3} 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.
  • `GRID_AGGREGATION_MAX`: Max value.
  • `GRID_AGGREGATION_MIN`: Min value.
  • `GRID_AGGREGATION_SUM`: Sum of values.
  • `GRID_AGGREGATION_AVG`: Average value.
  • `GRID_AGGREGATION_LAST`: Last value.
  • `GRID_AGGREGATION_COUNT`: Total count of points.
gap_filling | enum **GapFilling**
Parameters for filling gaps in data.
  • `GAP_FILLING_NULL`: Returns `null` as a metric value and `timestamp` as a time series value.
  • `GAP_FILLING_NONE`: Returns no value and no timestamp.
  • `GAP_FILLING_PREVIOUS`: Returns the value from the previous time interval.
### Parametrization {#Parametrization3} Field | Description --- | --- parameters[] | **[Parameter](#Parameter3)**
Parameters. selectors | **string**
Predefined selectors. ### Parameter {#Parameter3} 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](#LabelValuesParameter3)**
Label values parameter.   custom | **[CustomParameter](#CustomParameter3)**
Custom parameter.   text | **[TextParameter](#TextParameter3)**
Text parameter.   integer_parameter | **[IntegerParameter](#IntegerParameter3)**
Integer parameter.   double_parameter | **[DoubleParameter](#DoubleParameter3)**
Double parameter.   text_values | **[TextValuesParameter](#TextValuesParameter3)**
Integer parameter. hidden | **bool**
UI-visibility. description | **string**
Parameter description. ### LabelValuesParameter {#LabelValuesParameter3} 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 {#CustomParameter3} Field | Description --- | --- values[] | **string**
Required. List of parameter values. multiselectable | **bool**
Specifies the multiselectable values of parameter. default_values[] | **string**
Default values. ### TextParameter {#TextParameter3} Field | Description --- | --- default_value | **string**
Default value. ### IntegerParameter {#IntegerParameter3} Field | Description --- | --- default_value | **int64**
Default value. unit_format | enum **UnitFormat**
Parameter unit.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
### DoubleParameter {#DoubleParameter3} Field | Description --- | --- default_value | **double**
Default value. unit_format | enum **UnitFormat**
Parameter unit.
  • `UNIT_NONE`: None (show tick values as-is).
  • `UNIT_COUNT`: Count.
  • `UNIT_PERCENT`: Percent (0-100).
  • `UNIT_PERCENT_UNIT`: Percent (0-1).
  • `UNIT_NANOSECONDS`: Nanoseconds (ns).
  • `UNIT_MICROSECONDS`: Microseconds (µs).
  • `UNIT_MILLISECONDS`: Milliseconds (ms).
  • `UNIT_SECONDS`: Seconds (s).
  • `UNIT_MINUTES`: Minutes (m).
  • `UNIT_HOURS`: Hours (h).
  • `UNIT_DAYS`: Days (d).
  • `UNIT_BITS_SI`: Bits (SI).
  • `UNIT_BYTES_SI`: Bytes (SI).
  • `UNIT_KILOBYTES`: Kilobytes (KB).
  • `UNIT_MEGABYTES`: Megabytes (MB).
  • `UNIT_GIGABYTES`: Gigabytes (GB).
  • `UNIT_TERABYTES`: Terabytes (TB)
  • `UNIT_PETABYTES`: Petabytes (PB).
  • `UNIT_EXABYTES`: Exabytes (EB).
  • `UNIT_BITS_IEC`: Bits (IEC).
  • `UNIT_BYTES_IEC`: Bytes (IEC).
  • `UNIT_KIBIBYTES`: Kibibytes (KiB).
  • `UNIT_MEBIBYTES`: Mebibytes (MiB).
  • `UNIT_GIBIBYTES`: Gigibytes (GiB).
  • `UNIT_TEBIBYTES`: Tebibytes (TiB).
  • `UNIT_PEBIBYTES`: Pebibytes (PiB).
  • `UNIT_EXBIBYTES`: Exbibytes (EiB).
  • `UNIT_REQUESTS_PER_SECOND`: Requests per second (reqps).
  • `UNIT_OPERATIONS_PER_SECOND`: Operations per second (ops).
  • `UNIT_WRITES_PER_SECOND`: Writes per second (wps).
  • `UNIT_READS_PER_SECOND`: Reads per second (rps).
  • `UNIT_PACKETS_PER_SECOND`: Packets per second (pps).
  • `UNIT_IO_OPERATIONS_PER_SECOND`: IO operations per second (iops).
  • `UNIT_COUNTS_PER_SECOND`: Counts per second (counts/sec).
  • `UNIT_BITS_SI_PER_SECOND`: Bits (SI) per second (bits/sec).
  • `UNIT_BYTES_SI_PER_SECOND`: Bytes (SI) per second (bytes/sec).
  • `UNIT_KILOBITS_PER_SECOND`: Kilobits per second (KBits/sec).
  • `UNIT_KILOBYTES_PER_SECOND`: Kilobytes per second (KB/sec).
  • `UNIT_MEGABITS_PER_SECOND`: Megabits per second (MBits/sec).
  • `UNIT_MEGABYTES_PER_SECOND`: Megabytes per second (MB/sec).
  • `UNIT_GIGABITS_PER_SECOND`: Gigabits per second (GBits/sec).
  • `UNIT_GIGABYTES_PER_SECOND`: Gigabytes per second (GB/sec).
  • `UNIT_TERABITS_PER_SECOND`: Terabits per second (TBits/sec).
  • `UNIT_TERABYTES_PER_SECOND`: Terabytes per second (TB/sec).
  • `UNIT_PETABITS_PER_SECOND`: Petabits per second (Pbits/sec).
  • `UNIT_PETABYTES_PER_SECOND`: Petabytes per second (PB/sec).
  • `UNIT_BITS_IEC_PER_SECOND`: Bits (IEC) per second (bits/sec).
  • `UNIT_BYTES_IEC_PER_SECOND`: Bytes (IEC) per second (bytes/sec).
  • `UNIT_KIBIBITS_PER_SECOND`: Kibibits per second (KiBits/sec).
  • `UNIT_KIBIBYTES_PER_SECOND`: Kibibytes per second (KiB/sec).
  • `UNIT_MEBIBITS_PER_SECOND`: Mebibits per second (MiBits/sec).
  • `UNIT_MEBIBYTES_PER_SECOND`: Mebibytes per second (MiB/sec).
  • `UNIT_GIBIBITS_PER_SECOND`: Gibibits per second (GiBits/sec).
  • `UNIT_GIBIBYTES_PER_SECOND`: Gibibytes per second (GiB/sec).
  • `UNIT_TEBIBITS_PER_SECOND`: Tebibits per second (TiBits/sec).
  • `UNIT_TEBIBYTES_PER_SECOND`: Tebibytes per second (TiB/sec).
  • `UNIT_PEBIBITS_PER_SECOND`: Pebibits per second (PiBits/sec).
  • `UNIT_PEBIBYTES_PER_SECOND`: Pebibytes per second (PiB/sec).
  • `UNIT_DATETIME_UTC`: Datetime (UTC).
  • `UNIT_DATETIME_LOCAL`: Datetime (local).
  • `UNIT_HERTZ`: Hertz (Hz).
  • `UNIT_KILOHERTZ`: Kilohertz (KHz).
  • `UNIT_MEGAHERTZ`: Megahertz (MHz).
  • `UNIT_GIGAHERTZ`: Gigahertz (GHz).
  • `UNIT_DOLLAR`: Dollar.
  • `UNIT_EURO`: Euro.
  • `UNIT_ROUBLE`: Rouble.
  • `UNIT_CELSIUS`: Celsius (°C).
  • `UNIT_FAHRENHEIT`: Fahrenheit (°F).
  • `UNIT_KELVIN`: Kelvin (K).
  • `UNIT_FLOP_PER_SECOND`: Flop per second (FLOP/sec).
  • `UNIT_KILOFLOP_PER_SECOND`: Kiloflop per second (KFLOP/sec).
  • `UNIT_MEGAFLOP_PER_SECOND`: Megaflop per second (MFLOP/sec).
  • `UNIT_GIGAFLOP_PER_SECOND`: Gigaflop per second (GFLOP/sec).
  • `UNIT_PETAFLOP_PER_SECOND`: Petaflop per second (PFLOP/sec).
  • `UNIT_EXAFLOP_PER_SECOND`: Exaflop per second (EFLOP/sec).
  • `UNIT_METERS_PER_SECOND`: Meters per second (m/sec).
  • `UNIT_KILOMETERS_PER_HOUR`: Kilometers per hour (km/h).
  • `UNIT_MILES_PER_HOUR`: Miles per hour (mi/h).
  • `UNIT_MILLIMETER`: Millimeter.
  • `UNIT_CENTIMETER`: Centimeter.
  • `UNIT_METER`: Meter.
  • `UNIT_KILOMETER`: Kilometer.
  • `UNIT_MILE`: Mile.
  • `UNIT_PPM`: Parts per million (ppm).
  • `UNIT_EVENTS_PER_SECOND`: Events per second
  • `UNIT_PACKETS`: Packets
  • `UNIT_DBM`: dBm (dbm)
  • `UNIT_VIRTUAL_CPU`: Virtual CPU cores based on CPU time (vcpu)
  • `UNIT_MESSAGES_PER_SECOND`: Messages per second (mps)
### TextValuesParameter {#TextValuesParameter3} Field | Description --- | --- default_values[] | **string**
Default value. ### Operation {#Operation1} Field | Description --- | --- id | **string**
ID of the operation. description | **string**
Description of the operation. 0-256 characters long. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. created_by | **string**
ID of the user or service account who initiated the operation. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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](https://developers.google.com/protocol-buffers/docs/proto3#any)<[UpdateDashboardMetadata](#UpdateDashboardMetadata)>**
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](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)**
The error result of the operation in case of failure or cancellation.   response | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#any)<[Dashboard](#Dashboard3)>**
if operation finished successfully. ### UpdateDashboardMetadata {#UpdateDashboardMetadata} Field | Description --- | --- dashboard_id | **string**
Dashboard ID. ### Dashboard {#Dashboard3} Field | Description --- | --- id | **string**
Dashboard ID. container | **oneof:** `folder_id`
Container id   folder_id | **string**
Folder ID. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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**
Resource labels as `key:value` pairs. title | **string**
Dashboard title. widgets[] | **[Widget](#Widget4)**
List of dashboard widgets. parametrization | **[Parametrization](#Parametrization4)**
Dashboard parametrization. etag | **string**
Dashboard etag. ## Delete {#Delete} Deletes the specified dashboard. **rpc Delete ([DeleteDashboardRequest](#DeleteDashboardRequest)) returns ([operation.Operation](#Operation2))** Metadata and response of Operation:
    Operation.metadata:[DeleteDashboardMetadata](#DeleteDashboardMetadata)
    Operation.response:[google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty)
### DeleteDashboardRequest {#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 {#Operation2} Field | Description --- | --- id | **string**
ID of the operation. description | **string**
Description of the operation. 0-256 characters long. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. created_by | **string**
ID of the user or service account who initiated the operation. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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](https://developers.google.com/protocol-buffers/docs/proto3#any)<[DeleteDashboardMetadata](#DeleteDashboardMetadata)>**
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](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)**
The error result of the operation in case of failure or cancellation.   response | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#any)<[google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty)>**
if operation finished successfully. ### DeleteDashboardMetadata {#DeleteDashboardMetadata} Field | Description --- | --- dashboard_id | **string**
Dashboard ID. ## ListOperations {#ListOperations} Lists operations for the specified dashboard. **rpc ListOperations ([ListDashboardOperationsRequest](#ListDashboardOperationsRequest)) returns ([ListDashboardOperationsResponse](#ListDashboardOperationsResponse))** ### ListDashboardOperationsRequest {#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](#ListDashboardOperationsResponse) 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](#ListDashboardOperationsResponse) returned by a previous list request. The maximum string length in characters is 100. ### ListDashboardOperationsResponse {#ListDashboardOperationsResponse} Field | Description --- | --- operations[] | **[operation.Operation](#Operation3)**
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](#ListDashboardOperationsRequest), use the `next_page_token` as the value for the [ListDashboardOperationsRequest.page_token](#ListDashboardOperationsRequest) 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 {#Operation3} Field | Description --- | --- id | **string**
ID of the operation. description | **string**
Description of the operation. 0-256 characters long. created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)**
Creation timestamp. created_by | **string**
ID of the user or service account who initiated the operation. modified_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/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](https://developers.google.com/protocol-buffers/docs/proto3#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](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)**
The error result of the operation in case of failure or cancellation.   response | **[google.protobuf.Any](https://developers.google.com/protocol-buffers/docs/proto3#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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.