cloudvision.api.arista.dashboard.v1 package

Module contents

class cloudvision.api.arista.dashboard.v1.Dashboard(key: ~cloudvision.api.arista.dashboard.v1.DashboardKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, meta_data: ~cloudvision.api.arista.dashboard.v1.DashboardMetadata = <PLACEHOLDER>, name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, widgets: ~cloudvision.api.arista.dashboard.v1.Widgets = <PLACEHOLDER>)

Bases: Message

Dashboard state contains all dashboard data.

created_at: datetime = <PLACEHOLDER>

created_at represents the date the dashboard was first created. Old dashboards may not have this field set.

created_by: str | None = <PLACEHOLDER>

created_by keeps the name of the user who first created this dashboard. Old dashboards may not have this field set.

description: str | None = <PLACEHOLDER>

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

key: DashboardKey = <PLACEHOLDER>

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

last_modified_at: datetime = <PLACEHOLDER>

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: str | None = <PLACEHOLDER>

last_modified_by holds the username who last updated this dashboard. Old dashboards may not have this field set.

meta_data: DashboardMetadata = <PLACEHOLDER>

meta_data includes version metadata about the dashboard.

name: str | None = <PLACEHOLDER>

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

widgets: Widgets = <PLACEHOLDER>

widgets list of widgets in the dashboard.

class cloudvision.api.arista.dashboard.v1.DashboardBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Dashboard')] = <PLACEHOLDER>, filter: List[ForwardRef('Filter')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

filter: List[Filter] = <PLACEHOLDER>

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.

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[Dashboard] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardBatchedStreamResponse(responses: List[ForwardRef('DashboardStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[DashboardStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.DashboardConfig(key: ~cloudvision.api.arista.dashboard.v1.DashboardKey = <PLACEHOLDER>, name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, widgets: ~cloudvision.api.arista.dashboard.v1.Widgets = <PLACEHOLDER>)

Bases: Message

DashboardConfig includes all user-editable dashboard fields.

description: str | None = <PLACEHOLDER>

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

key: DashboardKey = <PLACEHOLDER>

key is the unique identifier. It always must be defined. If set, will create or update a dashboard.

name: str | None = <PLACEHOLDER>

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

widgets: Widgets = <PLACEHOLDER>

widgets list of widgets in the dashboard.

class cloudvision.api.arista.dashboard.v1.DashboardConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('DashboardConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[DashboardConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigBatchedStreamResponse(responses: List[ForwardRef('DashboardConfigStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[DashboardConfigStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('DashboardConfig')] = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[DashboardConfig] = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'DashboardKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

This indicates the error message from the delete failure.

key: DashboardKey = <PLACEHOLDER>

This is the key of the DashboardConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>

This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteRequest(key: 'DashboardKey' = <PLACEHOLDER>)

Bases: Message

key: DashboardKey = <PLACEHOLDER>

Key indicates which DashboardConfig instance to remove. This field must always be set.

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteResponse(key: 'DashboardKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: DashboardKey = <PLACEHOLDER>

Key echoes back the key of the deleted DashboardConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteSomeRequest(keys: List[ForwardRef('DashboardKey')] = <PLACEHOLDER>)

Bases: Message

keys: List[DashboardKey] = <PLACEHOLDER>

key contains a list of DashboardConfig keys to delete

class cloudvision.api.arista.dashboard.v1.DashboardConfigDeleteSomeResponse(key: ~cloudvision.api.arista.dashboard.v1.DashboardKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

DashboardConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: DashboardKey = <PLACEHOLDER>

class cloudvision.api.arista.dashboard.v1.DashboardConfigRequest(key: 'DashboardKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: DashboardKey = <PLACEHOLDER>

Key uniquely identifies a DashboardConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigResponse(value: 'DashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the DashboardConfig instance in this response.

value: DashboardConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigServiceBase

Bases: ServiceBase

async delete(dashboard_config_delete_request: DashboardConfigDeleteRequest) → DashboardConfigDeleteResponse

async delete_all(dashboard_config_delete_all_request: DashboardConfigDeleteAllRequest) → AsyncIterator[DashboardConfigDeleteAllResponse]

async delete_some(dashboard_config_delete_some_request: DashboardConfigDeleteSomeRequest) → AsyncIterator[DashboardConfigDeleteSomeResponse]

async get_all(dashboard_config_stream_request: DashboardConfigStreamRequest) → AsyncIterator[DashboardConfigStreamResponse]

async get_all_batched(dashboard_config_batched_stream_request: DashboardConfigBatchedStreamRequest) → AsyncIterator[DashboardConfigBatchedStreamResponse]

async get_meta(dashboard_config_stream_request: DashboardConfigStreamRequest) → MetaResponse

async get_one(dashboard_config_request: DashboardConfigRequest) → DashboardConfigResponse

async get_some(dashboard_config_some_request: DashboardConfigSomeRequest) → AsyncIterator[DashboardConfigSomeResponse]

async set(dashboard_config_set_request: DashboardConfigSetRequest) → DashboardConfigSetResponse

async set_some(dashboard_config_set_some_request: DashboardConfigSetSomeRequest) → AsyncIterator[DashboardConfigSetSomeResponse]

async subscribe(dashboard_config_stream_request: DashboardConfigStreamRequest) → AsyncIterator[DashboardConfigStreamResponse]

async subscribe_batched(dashboard_config_batched_stream_request: DashboardConfigBatchedStreamRequest) → AsyncIterator[DashboardConfigBatchedStreamResponse]

async subscribe_meta(dashboard_config_stream_request: DashboardConfigStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.DashboardConfigServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async delete(dashboard_config_delete_request: DashboardConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DashboardConfigDeleteResponse

async delete_all(dashboard_config_delete_all_request: DashboardConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigDeleteAllResponse]

async delete_some(dashboard_config_delete_some_request: DashboardConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigDeleteSomeResponse]

async get_all(dashboard_config_stream_request: DashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigStreamResponse]

async get_all_batched(dashboard_config_batched_stream_request: DashboardConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigBatchedStreamResponse]

async get_meta(dashboard_config_stream_request: DashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(dashboard_config_request: DashboardConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DashboardConfigResponse

async get_some(dashboard_config_some_request: DashboardConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigSomeResponse]

async set(dashboard_config_set_request: DashboardConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DashboardConfigSetResponse

async set_some(dashboard_config_set_some_request: DashboardConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigSetSomeResponse]

async subscribe(dashboard_config_stream_request: DashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigStreamResponse]

async subscribe_batched(dashboard_config_batched_stream_request: DashboardConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardConfigBatchedStreamResponse]

async subscribe_meta(dashboard_config_stream_request: DashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.DashboardConfigSetRequest(value: 'DashboardConfig' = <PLACEHOLDER>)

Bases: Message

value: DashboardConfig = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.DashboardConfigSetResponse(value: 'DashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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.

value: DashboardConfig = <PLACEHOLDER>

Value carries all the values given in the DashboardConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.dashboard.v1.DashboardConfigSetSomeRequest(values: List[ForwardRef('DashboardConfig')] = <PLACEHOLDER>)

Bases: Message

values: List[DashboardConfig] = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigSetSomeResponse(key: 'DashboardKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

error: str = <PLACEHOLDER>

key: DashboardKey = <PLACEHOLDER>

class cloudvision.api.arista.dashboard.v1.DashboardConfigSomeRequest(keys: List[ForwardRef('DashboardKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[DashboardKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigSomeResponse(value: 'DashboardConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: DashboardConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigStreamRequest(partial_eq_filter: List[ForwardRef('DashboardConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[DashboardConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardConfigStreamResponse(value: 'DashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: DashboardConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardKey(dashboard_id: str | None = <PLACEHOLDER>)

Bases: Message

DashboardKey represents the dashboard unique identifier.

dashboard_id: str | None = <PLACEHOLDER>

dashboard_id holds the id of the dashboard

class cloudvision.api.arista.dashboard.v1.DashboardMetadata(schema_version: str | None = <PLACEHOLDER>, legacy_key: str | None = <PLACEHOLDER>, legacy_version: str | None = <PLACEHOLDER>, from_package: str | None = <PLACEHOLDER>)

Bases: Message

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

from_package: str | None = <PLACEHOLDER>

from_package records the contributing package key and version, if applicable.

legacy_key: str | None = <PLACEHOLDER>

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

legacy_version: str | None = <PLACEHOLDER>

legacy_version tells from which version the dashboard was migrated from.

schema_version: str | None = <PLACEHOLDER>

schema_version is managed internally.

class cloudvision.api.arista.dashboard.v1.DashboardRequest(key: 'DashboardKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: DashboardKey = <PLACEHOLDER>

Key uniquely identifies a Dashboard instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardResponse(value: 'Dashboard' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the Dashboard instance in this response.

value: Dashboard = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardServiceBase

Bases: ServiceBase

async get_all(dashboard_stream_request: DashboardStreamRequest) → AsyncIterator[DashboardStreamResponse]

async get_all_batched(dashboard_batched_stream_request: DashboardBatchedStreamRequest) → AsyncIterator[DashboardBatchedStreamResponse]

async get_meta(dashboard_stream_request: DashboardStreamRequest) → MetaResponse

async get_one(dashboard_request: DashboardRequest) → DashboardResponse

async get_some(dashboard_some_request: DashboardSomeRequest) → AsyncIterator[DashboardSomeResponse]

async subscribe(dashboard_stream_request: DashboardStreamRequest) → AsyncIterator[DashboardStreamResponse]

async subscribe_batched(dashboard_batched_stream_request: DashboardBatchedStreamRequest) → AsyncIterator[DashboardBatchedStreamResponse]

async subscribe_meta(dashboard_stream_request: DashboardStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.DashboardServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(dashboard_stream_request: DashboardStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardStreamResponse]

async get_all_batched(dashboard_batched_stream_request: DashboardBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardBatchedStreamResponse]

async get_meta(dashboard_stream_request: DashboardStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(dashboard_request: DashboardRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → DashboardResponse

async get_some(dashboard_some_request: DashboardSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardSomeResponse]

async subscribe(dashboard_stream_request: DashboardStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardStreamResponse]

async subscribe_batched(dashboard_batched_stream_request: DashboardBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[DashboardBatchedStreamResponse]

async subscribe_meta(dashboard_stream_request: DashboardStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.DashboardSomeRequest(keys: List[ForwardRef('DashboardKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[DashboardKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardSomeResponse(value: 'Dashboard' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: Dashboard = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardStreamRequest(partial_eq_filter: List[ForwardRef('Dashboard')] = <PLACEHOLDER>, filter: List[ForwardRef('Filter')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

filter: List[Filter] = <PLACEHOLDER>

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.

partial_eq_filter: List[Dashboard] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.DashboardStreamResponse(value: 'Dashboard' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: Dashboard = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.Dimensions(width: int | None = <PLACEHOLDER>, height: int | None = <PLACEHOLDER>)

Bases: Message

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

height: int | None = <PLACEHOLDER>

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

width: int | None = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.Filter(tags: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)

Bases: Message

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

tags: ___fmp__.RepeatedString = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfig(default_dashboard: ~cloudvision.api.arista.dashboard.v1.DashboardKey = <PLACEHOLDER>)

Bases: Message

GlobalDashboardConfig holds global configs related to Dashboards.

default_dashboard: DashboardKey = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigRequest(time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigResponse(value: 'GlobalDashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the GlobalDashboardConfig instance in this response.

value: GlobalDashboardConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigServiceBase

Bases: ServiceBase

async get_all(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest) → AsyncIterator[GlobalDashboardConfigStreamResponse]

async get_one(global_dashboard_config_request: GlobalDashboardConfigRequest) → GlobalDashboardConfigResponse

async set(global_dashboard_config_set_request: GlobalDashboardConfigSetRequest) → GlobalDashboardConfigSetResponse

async subscribe(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest) → AsyncIterator[GlobalDashboardConfigStreamResponse]

async subscribe_meta(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GlobalDashboardConfigStreamResponse]

async get_one(global_dashboard_config_request: GlobalDashboardConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → GlobalDashboardConfigResponse

async set(global_dashboard_config_set_request: GlobalDashboardConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → GlobalDashboardConfigSetResponse

async subscribe(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[GlobalDashboardConfigStreamResponse]

async subscribe_meta(global_dashboard_config_stream_request: GlobalDashboardConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigSetRequest(value: 'GlobalDashboardConfig' = <PLACEHOLDER>)

Bases: Message

value: GlobalDashboardConfig = <PLACEHOLDER>

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

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigSetResponse(value: 'GlobalDashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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.

value: GlobalDashboardConfig = <PLACEHOLDER>

Value carries all the values given in the GlobalDashboardConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigStreamRequest(partial_eq_filter: List[ForwardRef('GlobalDashboardConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[GlobalDashboardConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.GlobalDashboardConfigStreamResponse(value: 'GlobalDashboardConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: GlobalDashboardConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)

Bases: Message

count: int | None = <PLACEHOLDER>

Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>

Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

class cloudvision.api.arista.dashboard.v1.Position(x: int | None = <PLACEHOLDER>, y: int | None = <PLACEHOLDER>)

Bases: Message

Position represents a cell position in the UI.

x: int | None = <PLACEHOLDER>

x represents a position in the horizontal axis.

y: int | None = <PLACEHOLDER>

y represents a position in the vertical axis.

class cloudvision.api.arista.dashboard.v1.Widget(id: str | None = <PLACEHOLDER>, name: str | None = <PLACEHOLDER>, position: ~cloudvision.api.arista.dashboard.v1.Position = <PLACEHOLDER>, dimensions: ~cloudvision.api.arista.dashboard.v1.Dimensions = <PLACEHOLDER>, type: str | None = <PLACEHOLDER>, inputs: str | None = <PLACEHOLDER>, location: str | None = <PLACEHOLDER>, styles: ~cloudvision.api.arista.dashboard.v1.WidgetStyles = <PLACEHOLDER>, parent: str | None = <PLACEHOLDER>)

Bases: Message

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

dimensions: Dimensions = <PLACEHOLDER>

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

id: str | None = <PLACEHOLDER>

id holds the unique identifier for the widget inside a dashboard

inputs: str | None = <PLACEHOLDER>

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: str | None = <PLACEHOLDER>

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

name: str | None = <PLACEHOLDER>

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

parent: str | None = <PLACEHOLDER>

parent stores the id of its parent widget.

position: Position = <PLACEHOLDER>

position of the widget, represented as a (x,y) coordinate in a grid. Top left is at (0,0).

styles: WidgetStyles = <PLACEHOLDER>

styles represents the widget’s panel appearance.

type: str | None = <PLACEHOLDER>

type is the widget type. Each type is handled differently in the UI, and can use different inputs.

class cloudvision.api.arista.dashboard.v1.WidgetStyles(hide_title: bool | None = <PLACEHOLDER>, background_color: str | None = <PLACEHOLDER>, hide_horizontal_bar: bool | None = <PLACEHOLDER>, title_size: int | None = <PLACEHOLDER>)

Bases: Message

WidgetStyles represents the widget’s panel appearance.

background_color: str | None = <PLACEHOLDER>

background_color is used to set the widget’s background color.

hide_horizontal_bar: bool | None = <PLACEHOLDER>

hide_horizontal_bar is used to hint the dashboard that the title separator must be hidden.

hide_title: bool | None = <PLACEHOLDER>

hide_title is used to hint the dashboard that the widget title must be hidden.

title_size: int | None = <PLACEHOLDER>

title_size is used to set widget’s title size.

class cloudvision.api.arista.dashboard.v1.Widgets(values: ~typing.List[~cloudvision.api.arista.dashboard.v1.Widget] = <PLACEHOLDER>)

Bases: Message

Widgets holds a list of `Widget`s.

values: List[Widget] = <PLACEHOLDER>

values holds a list of widgets