dashboard.v1

Top

arista/dashboard.v1/dashboard.proto

Dashboard

Dashboard state contains all dashboard data.

Field NameTypeDescription
keyDashboardKey

key is the unique identifier. It will always be defined.

created_atgoogle.protobuf.Timestamp

created_at represents the date the dashboard was first created.

Old dashboards may not have this field set.

created_bygoogle.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_atgoogle.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_bygoogle.protobuf.StringValue

last_modified_by holds the username who last updated this dashboard.

Old dashboards may not have this field set.

meta_dataDashboardMetadata

meta_data includes version metadata about the dashboard.

namegoogle.protobuf.StringValue

name is the dashboard name, displayed at the top of the dashboard.

descriptiongoogle.protobuf.StringValue

description may include details about what is displayed in the dashboard.

widgetsWidgets

widgets list of widgets in the dashboard.

DashboardConfig

DashboardConfig includes all user-editable dashboard fields.

Field NameTypeDescription
keyDashboardKey

key is the unique identifier. It always must be defined.

If set, will create or update a dashboard.

namegoogle.protobuf.StringValue

name is the dashboard name, displayed at the top of the dashboard.

descriptiongoogle.protobuf.StringValue

description may include details about what is displayed in the dashboard.

widgetsWidgets

widgets list of widgets in the dashboard.

DashboardKey

DashboardKey represents the dashboard unique identifier.

Field NameTypeDescription
dashboard_idgoogle.protobuf.StringValue

DashboardMetadata

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

Field NameTypeDescription
schema_versiongoogle.protobuf.StringValue

schema_version is managed internally.

legacy_keygoogle.protobuf.StringValue

legacy_key holds the key of a previous version of the dashboard, in case it was migrated.

legacy_versiongoogle.protobuf.StringValue

legacy_version tells from which version the dashboard was migrated from.

Dimensions

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

Field NameTypeDescription
widthgoogle.protobuf.UInt32Value

width of the widget in the UI, represented in number of cells.

heightgoogle.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 NameTypeDescription
tagsfmp.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 NameTypeDescription
default_dashboardDashboardKey

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 NameTypeDescription
xgoogle.protobuf.UInt32Value

x represents a position in the horizontal axis.

ygoogle.protobuf.UInt32Value

y represents a position in the vertical axis.

Widget

Widgets are used to create a dashboard. Each widget is responsible to display some type of data. Widgets are individually configurable.

Field NameTypeDescription
idgoogle.protobuf.StringValue

id holds the unique identifier for the widget inside a dashboard

namegoogle.protobuf.StringValue

name of the widget is displayed at the top of the widget.

positionPosition

position of the widget, represented as a (x,y) coordinate in a grid.

Top left is at (0,0).

dimensionsDimensions

dimension of the widget represents how many cell in the grid it takes.

typegoogle.protobuf.StringValue

type is the widget type. Each type is handled differently in the UI,

and can use different inputs.

inputsgoogle.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.

locationgoogle.protobuf.StringValue

location is used as a position display hint, used and managed by the UI.

Widgets

Widgets holds a list of Widgets.

Field NameTypeDescription
valuesWidget[…]

Top

arista/dashboard.v1/services.gen.proto

DashboardConfigDeleteRequest

Field NameTypeDescription
keyDashboardKey

Key indicates which DashboardConfig instance to remove.

This field must always be set.

DashboardConfigDeleteResponse

Field NameTypeDescription
keyDashboardKey

Key echoes back the key of the deleted DashboardConfig instance.

timegoogle.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.

DashboardConfigRequest

Field NameTypeDescription
keyDashboardKey

Key uniquely identifies a DashboardConfig instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueDashboardConfig

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

DashboardConfig instance in this response.

DashboardConfigSetRequest

Field NameTypeDescription
valueDashboardConfig

DashboardConfig carries the value to set into the datastore.

See the documentation on the DashboardConfig struct for which fields are required.

DashboardConfigSetResponse

Field NameTypeDescription
valueDashboardConfig

Value carries all the values given in the DashboardConfigSetRequest as well

as any server-generated values.

timegoogle.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.

DashboardConfigStreamRequest

Field NameTypeDescription
partial_eq_filterDashboardConfig[…]

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.

timearista.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.

This field is not allowed in the Subscribe RPC.

DashboardConfigStreamResponse

Field NameTypeDescription
valueDashboardConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this DashboardConfig’s last modification.

typearista.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 NameTypeDescription
keyDashboardKey

Key uniquely identifies a Dashboard instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueDashboard

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Dashboard instance in this response.

DashboardStreamRequest

Field NameTypeDescription
partial_eq_filterDashboard[…]

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.

filterFilter[…]

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.

timearista.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.

This field is not allowed in the Subscribe RPC.

DashboardStreamResponse

Field NameTypeDescription
valueDashboard

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Dashboard’s last modification.

typearista.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 NameTypeDescription
timegoogle.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 NameTypeDescription
valueGlobalDashboardConfig

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

GlobalDashboardConfig instance in this response.

GlobalDashboardConfigSetRequest

Field NameTypeDescription
valueGlobalDashboardConfig

GlobalDashboardConfig carries the value to set into the datastore.

See the documentation on the GlobalDashboardConfig struct for which fields are required.

GlobalDashboardConfigSetResponse

Field NameTypeDescription
valueGlobalDashboardConfig

Value carries all the values given in the GlobalDashboardConfigSetRequest as well

as any server-generated values.

timegoogle.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 NameTypeDescription
partial_eq_filterGlobalDashboardConfig[…]

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.

timearista.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.

This field is not allowed in the Subscribe RPC.

GlobalDashboardConfigStreamResponse

Field NameTypeDescription
valueGlobalDashboardConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this GlobalDashboardConfig’s last modification.

typearista.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.

DashboardConfigService

Method NameRequest TypeResponse TypeDescription
GetOneDashboardConfigRequestDashboardConfigResponse

GetAllDashboardConfigStreamRequestDashboardConfigStreamResponse stream

SubscribeDashboardConfigStreamRequestDashboardConfigStreamResponse stream

SetDashboardConfigSetRequestDashboardConfigSetResponse

DeleteDashboardConfigDeleteRequestDashboardConfigDeleteResponse

DashboardService

Method NameRequest TypeResponse TypeDescription
GetOneDashboardRequestDashboardResponse

GetAllDashboardStreamRequestDashboardStreamResponse stream

SubscribeDashboardStreamRequestDashboardStreamResponse stream

GlobalDashboardConfigService

Method NameRequest TypeResponse TypeDescription
GetOneGlobalDashboardConfigRequestGlobalDashboardConfigResponse

SubscribeGlobalDashboardConfigStreamRequestGlobalDashboardConfigStreamResponse stream

SetGlobalDashboardConfigSetRequestGlobalDashboardConfigSetResponse