dashboard.v1

Version: 1.6.0

Available Services

    DashboardConfigService

    DashboardService

    GlobalDashboardConfigService

• arista/dashboard.v1/dashboard.proto
  • Dashboard
  • DashboardConfig
  • DashboardKey
  • DashboardMetadata
  • Dimensions
  • Filter
  • GlobalDashboardConfig
  • Position
  • Widget
  • WidgetStyles
  • Widgets
• arista/dashboard.v1/services.gen.proto

  • DashboardBatchedStreamRequest

  • DashboardBatchedStreamResponse

  • DashboardConfigBatchedStreamRequest

  • DashboardConfigBatchedStreamResponse

  • DashboardConfigDeleteAllRequest

  • DashboardConfigDeleteAllResponse

  • DashboardConfigDeleteRequest

  • DashboardConfigDeleteResponse

  • DashboardConfigDeleteSomeRequest

  • DashboardConfigDeleteSomeResponse

  • DashboardConfigRequest

  • DashboardConfigResponse

  • DashboardConfigSetRequest

  • DashboardConfigSetResponse

  • DashboardConfigSetSomeRequest

  • DashboardConfigSetSomeResponse

  • DashboardConfigSomeRequest

  • DashboardConfigSomeResponse

  • DashboardConfigStreamRequest

  • DashboardConfigStreamResponse

  • DashboardRequest

  • DashboardResponse

  • DashboardSomeRequest

  • DashboardSomeResponse

  • DashboardStreamRequest

  • DashboardStreamResponse

  • GlobalDashboardConfigRequest

  • GlobalDashboardConfigResponse

  • GlobalDashboardConfigSetRequest

  • GlobalDashboardConfigSetResponse

  • GlobalDashboardConfigStreamRequest

  • GlobalDashboardConfigStreamResponse

  • MetaResponse

  • DashboardConfigService

  • DashboardService

  • GlobalDashboardConfigService

Top

arista/dashboard.v1/dashboard.proto

Dashboard

Dashboard state contains all dashboard data.

Field Name	Type	Description
key	DashboardKey	key is the unique identifier. It will always be defined.
created_at	google.protobuf.Timestamp	created_at represents the date the dashboard was first created. Old dashboards may not have this field set.
created_by	google.protobuf.StringValue	created_by keeps the name of the user who first created this dashboard. Old dashboards may not have this field set.
last_modified_at	google.protobuf.Timestamp	last_modified_at holds the timestamp this dashboard was last updated by an user. Old dashboards may not have this field set.
last_modified_by	google.protobuf.StringValue	last_modified_by holds the username who last updated this dashboard. Old dashboards may not have this field set.
meta_data	DashboardMetadata	meta_data includes version metadata about the dashboard.
name	google.protobuf.StringValue	name is the dashboard name, displayed at the top of the dashboard.
description	google.protobuf.StringValue	description may include details about what is displayed in the dashboard.
widgets	Widgets	widgets list of widgets in the dashboard.

DashboardConfig

DashboardConfig includes all user-editable dashboard fields.

Field Name	Type	Description
key	DashboardKey	key is the unique identifier. It always must be defined. If set, will create or update a dashboard.
name	google.protobuf.StringValue	name is the dashboard name, displayed at the top of the dashboard.
description	google.protobuf.StringValue	description may include details about what is displayed in the dashboard.
widgets	Widgets	widgets list of widgets in the dashboard.

DashboardKey

DashboardKey represents the dashboard unique identifier.

Field Name	Type	Description
dashboard_id	google.protobuf.StringValue	dashboard_id holds the id of the dashboard

DashboardMetadata

DashboardMetadata includes versioning metadata. All the data here is managed internally, and is read-only.

Field Name	Type	Description
schema_version	google.protobuf.StringValue	schema_version is managed internally.
legacy_key	google.protobuf.StringValue	legacy_key holds the key of a previous version of the dashboard, in case it was migrated.
legacy_version	google.protobuf.StringValue	legacy_version tells from which version the dashboard was migrated from.
from_package	google.protobuf.StringValue	from_package records the contributing package key and version, if applicable.

Dimensions

Dimensions represents the dimensions in cells of the widgets in the UI.

Field Name	Type	Description
width	google.protobuf.UInt32Value	width of the widget in the UI, represented in number of cells.
height	google.protobuf.UInt32Value	height of the widget in the UI, represented in number of cells.

Filter

Filter is used to filter dashboards for non exact match cases.

Field Name	Type	Description
tags	fmp.RepeatedString	tags includes the values to be matched in the dashboard description. Tags are matched by word. Generally, a tag is prefixed by a '#', which must be omitted when provided here. All provided tags must match inside a dashboard for it to be returned. E.g., to match "#devices", the tag should be set to "devices".

GlobalDashboardConfig

GlobalDashboardConfig holds global configs related to Dashboards.

Field Name	Type	Description
default_dashboard	DashboardKey	default_dashboard is the default dashboard shown to a user. To unset, use an empty key ({dashboard_id: nil}) in a Set() call.

Position

Position represents a cell position in the UI.

Field Name	Type	Description
x	google.protobuf.UInt32Value	x represents a position in the horizontal axis.
y	google.protobuf.UInt32Value	y represents a position in the vertical axis.

Widget

Widget is used to create a dashboard. Each widget is responsible to display some type of data.

Field Name	Type	Description
id	google.protobuf.StringValue	id holds the unique identifier for the widget inside a dashboard
name	google.protobuf.StringValue	name of the widget is displayed at the top of the widget.
position	Position	position of the widget, represented as a (x,y) coordinate in a grid. Top left is at (0,0).
dimensions	Dimensions	dimensions of the widget represents how many cell in the grid it takes.
type	google.protobuf.StringValue	type is the widget type. Each type is handled differently in the UI, and can use different inputs.
inputs	google.protobuf.StringValue	inputs contains metadata about the data the widget will display, encoded in a JSON string. Internal data vary based on the widget type type and is managed by the client.
location	google.protobuf.StringValue	location is used as a position display hint, used and managed by the UI.
styles	WidgetStyles	styles represents the widget's panel appearance.
parent	google.protobuf.StringValue	parent stores the id of its parent widget.

WidgetStyles

WidgetStyles represents the widget's panel appearance.

Field Name	Type	Description
hide_title	google.protobuf.BoolValue	hide_title is used to hint the dashboard that the widget title must be hidden.
background_color	google.protobuf.StringValue	background_color is used to set the widget's background color.
hide_horizontal_bar	google.protobuf.BoolValue	hide_horizontal_bar is used to hint the dashboard that the title separator must be hidden.
title_size	google.protobuf.UInt32Value	title_size is used to set widget's title size.

Widgets

Widgets holds a list of Widgets.

Field Name	Type	Description
values	Widget[...]	values holds a list of widgets

Top

arista/dashboard.v1/services.gen.proto

DashboardBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	Dashboard[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
filter	Filter[...]	For each Dashboard in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Dashboard is streamed to the user.
time	arista.time.TimeBounds	TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each Dashboard at end. * Each Dashboard response is fully-specified (all fields set). * start: Returns the state of each Dashboard at start, followed by updates until now. * Each Dashboard response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Dashboard at start, followed by updates until end. * Each Dashboard response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.
max_messages	google.protobuf.UInt32Value	MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DashboardBatchedStreamResponse

Field Name	Type	Description
responses	DashboardStreamResponse[...]	Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

DashboardConfigBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	DashboardConfig[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.time.TimeBounds	TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each DashboardConfig at end. * Each DashboardConfig response is fully-specified (all fields set). * start: Returns the state of each DashboardConfig at start, followed by updates until now. * Each DashboardConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DashboardConfig at start, followed by updates until end. * Each DashboardConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.
max_messages	google.protobuf.UInt32Value	MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DashboardConfigBatchedStreamResponse

Field Name	Type	Description
responses	DashboardConfigStreamResponse[...]	Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

DashboardConfigDeleteAllRequest

Field Name	Type	Description
partial_eq_filter	DashboardConfig[...]	PartialEqFilter provides a way to server-side filter a DeleteAll. This requires all provided fields to be equal to the response. A filtered DeleteAll will use GetAll with filter to find things to delete.

DashboardConfigDeleteAllResponse

Field Name	Type	Description
type	fmp.DeleteError	This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.
error	google.protobuf.StringValue	This indicates the error message from the delete failure.
key	DashboardKey	This is the key of the DashboardConfig instance that failed to be deleted.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp when the key was being deleted.

DashboardConfigDeleteRequest

Field Name	Type	Description
key	DashboardKey	Key indicates which DashboardConfig instance to remove. This field must always be set.

DashboardConfigDeleteResponse

Field Name	Type	Description
key	DashboardKey	Key echoes back the key of the deleted DashboardConfig instance.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==DeletedAt will not include this instance.

DashboardConfigDeleteSomeRequest

Field Name	Type	Description
keys	DashboardKey[...]	key contains a list of DashboardConfig keys to delete

DashboardConfigDeleteSomeResponse

DashboardConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	DashboardKey
error	string

DashboardConfigRequest

Field Name	Type	Description
key	DashboardKey	Key uniquely identifies a DashboardConfig instance to retrieve. This value must be populated.
time	google.protobuf.Timestamp	Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

DashboardConfigResponse

Field Name	Type	Description
value	DashboardConfig	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the DashboardConfig instance in this response.

DashboardConfigSetRequest

Field Name	Type	Description
value	DashboardConfig	DashboardConfig carries the value to set into the datastore. See the documentation on the DashboardConfig struct for which fields are required.

DashboardConfigSetResponse

Field Name	Type	Description
value	DashboardConfig	Value carries all the values given in the DashboardConfigSetRequest as well as any server-generated values.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance.

DashboardConfigSetSomeRequest

Field Name	Type	Description
values	DashboardConfig[...]	value contains a list of DashboardConfig values to write. It is possible to provide more values than can fit within either: - the maxiumum send size of the client - the maximum receive size of the server If this error occurs you must reduce the number of values sent. See gRPC "maximum message size" documentation for more information.

DashboardConfigSetSomeResponse

Field Name	Type	Description
key	DashboardKey
error	string

DashboardConfigSomeRequest

Field Name	Type	Description
keys	DashboardKey[...]
time	google.protobuf.Timestamp	Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

DashboardConfigSomeResponse

Field Name	Type	Description
value	DashboardConfig	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
error	google.protobuf.StringValue	Error is an optional field. It should be filled when there is an error in the GetSome process.
time	google.protobuf.Timestamp

DashboardConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	DashboardConfig[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.time.TimeBounds	TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each DashboardConfig at end. * Each DashboardConfig response is fully-specified (all fields set). * start: Returns the state of each DashboardConfig at start, followed by updates until now. * Each DashboardConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DashboardConfig at start, followed by updates until end. * Each DashboardConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

DashboardConfigStreamResponse

Field Name	Type	Description
value	DashboardConfig	Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.
time	google.protobuf.Timestamp	Time holds the timestamp of this DashboardConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the DashboardConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

DashboardRequest

Field Name	Type	Description
key	DashboardKey	Key uniquely identifies a Dashboard instance to retrieve. This value must be populated.
time	google.protobuf.Timestamp	Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

DashboardResponse

Field Name	Type	Description
value	Dashboard	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the Dashboard instance in this response.

DashboardSomeRequest

Field Name	Type	Description
keys	DashboardKey[...]
time	google.protobuf.Timestamp	Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

DashboardSomeResponse

Field Name	Type	Description
value	Dashboard	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
error	google.protobuf.StringValue	Error is an optional field. It should be filled when there is an error in the GetSome process.
time	google.protobuf.Timestamp

DashboardStreamRequest

Field Name	Type	Description
partial_eq_filter	Dashboard[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
filter	Filter[...]	For each Dashboard in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Dashboard is streamed to the user.
time	arista.time.TimeBounds	TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each Dashboard at end. * Each Dashboard response is fully-specified (all fields set). * start: Returns the state of each Dashboard at start, followed by updates until now. * Each Dashboard response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Dashboard at start, followed by updates until end. * Each Dashboard response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

DashboardStreamResponse

Field Name	Type	Description
value	Dashboard	Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.
time	google.protobuf.Timestamp	Time holds the timestamp of this Dashboard's last modification.
type	arista.subscriptions.Operation	Operation indicates how the Dashboard value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

GlobalDashboardConfigRequest

Field Name	Type	Description
time	google.protobuf.Timestamp	Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request.

GlobalDashboardConfigResponse

Field Name	Type	Description
value	GlobalDashboardConfig	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the GlobalDashboardConfig instance in this response.

GlobalDashboardConfigSetRequest

Field Name	Type	Description
value	GlobalDashboardConfig	GlobalDashboardConfig carries the value to set into the datastore. See the documentation on the GlobalDashboardConfig struct for which fields are required.

GlobalDashboardConfigSetResponse

Field Name	Type	Description
value	GlobalDashboardConfig	Value carries all the values given in the GlobalDashboardConfigSetRequest as well as any server-generated values.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance.

GlobalDashboardConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	GlobalDashboardConfig[...]	PartialEqFilter provides a way to server-side filter a GetAll/Subscribe. This requires all provided fields to be equal to the response. While transparent to users, this field also allows services to optimize internal subscriptions if filter(s) are sufficiently specific.
time	arista.time.TimeBounds	TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each GlobalDashboardConfig at end. * Each GlobalDashboardConfig response is fully-specified (all fields set). * start: Returns the state of each GlobalDashboardConfig at start, followed by updates until now. * Each GlobalDashboardConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each GlobalDashboardConfig at start, followed by updates until end. * Each GlobalDashboardConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

GlobalDashboardConfigStreamResponse

Field Name	Type	Description
value	GlobalDashboardConfig	Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.
time	google.protobuf.Timestamp	Time holds the timestamp of this GlobalDashboardConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the GlobalDashboardConfig value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

MetaResponse

Field Name	Type	Description
time	google.protobuf.Timestamp	Time holds the timestamp of the last item included in the metadata calculation.
type	arista.subscriptions.Operation	Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.
count	google.protobuf.UInt32Value	Count is the number of items present under the conditions of the request.

DashboardConfigService

Method Name	Request Type	Response Type	Description
GetOne	DashboardConfigRequest	DashboardConfigResponse
GetSome	DashboardConfigSomeRequest	DashboardConfigSomeResponse stream
GetAll	DashboardConfigStreamRequest	DashboardConfigStreamResponse stream
Subscribe	DashboardConfigStreamRequest	DashboardConfigStreamResponse stream
GetMeta	DashboardConfigStreamRequest	MetaResponse
SubscribeMeta	DashboardConfigStreamRequest	MetaResponse stream
Set	DashboardConfigSetRequest	DashboardConfigSetResponse
SetSome	DashboardConfigSetSomeRequest	DashboardConfigSetSomeResponse stream
Delete	DashboardConfigDeleteRequest	DashboardConfigDeleteResponse
DeleteSome	DashboardConfigDeleteSomeRequest	DashboardConfigDeleteSomeResponse stream
DeleteAll	DashboardConfigDeleteAllRequest	DashboardConfigDeleteAllResponse stream
GetAllBatched	DashboardConfigBatchedStreamRequest	DashboardConfigBatchedStreamResponse stream
SubscribeBatched	DashboardConfigBatchedStreamRequest	DashboardConfigBatchedStreamResponse stream

DashboardService

Method Name	Request Type	Response Type	Description
GetOne	DashboardRequest	DashboardResponse
GetSome	DashboardSomeRequest	DashboardSomeResponse stream
GetAll	DashboardStreamRequest	DashboardStreamResponse stream
Subscribe	DashboardStreamRequest	DashboardStreamResponse stream
GetMeta	DashboardStreamRequest	MetaResponse
SubscribeMeta	DashboardStreamRequest	MetaResponse stream
GetAllBatched	DashboardBatchedStreamRequest	DashboardBatchedStreamResponse stream
SubscribeBatched	DashboardBatchedStreamRequest	DashboardBatchedStreamResponse stream

GlobalDashboardConfigService

Method Name	Request Type	Response Type	Description
GetOne	GlobalDashboardConfigRequest	GlobalDashboardConfigResponse
GetAll	GlobalDashboardConfigStreamRequest	GlobalDashboardConfigStreamResponse stream
Subscribe	GlobalDashboardConfigStreamRequest	GlobalDashboardConfigStreamResponse stream
SubscribeMeta	GlobalDashboardConfigStreamRequest	MetaResponse stream
Set	GlobalDashboardConfigSetRequest	GlobalDashboardConfigSetResponse