studio_topology.v1
Available Services
arista/studio_topology.v1/studio_topology.proto
NOTE: This is a workspace-aware Resource API. Please see workspace.v1 for more information.
Decommission
Decommission is the resource that holds the decommissioning state of a device.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device in a given workspace. |
created_at | google.protobuf.Timestamp | created_at is the time at which decommissioning was first initiated. |
created_by | google.protobuf.StringValue | created_by is the name of the user who first initiated decommissioning. |
last_modified_at | google.protobuf.Timestamp | last_modified_at is the time at which the decommissioning was last modified. |
last_modified_by | google.protobuf.StringValue | last_modified_by is the name of the user that last modified the status. |
status | DecommissionStatus | status of the decommissioning operation |
error | google.protobuf.StringValue | error indicates if there is a failure in decommissioning |
DecommissionConfig
DecommissionConfig is the resource for decommissioning the device from the studio.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device for a given workspace. |
DeviceInfo
DeviceInfo contains device properties.
Field Name | Type | Description |
---|---|---|
device_id | google.protobuf.StringValue | device_id identifies the device uniquely. |
model_name | google.protobuf.StringValue | model_name indicates the model of the device. |
mac_address | fmp.MACAddress | mac_address indicates the MAC address of the device. |
hostname | google.protobuf.StringValue | hostname indicates the hostname of the device. |
DeviceInputConfig
DeviceInputConfig is the desired topology input for a device.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device ID for a given workspace. |
device_info | DeviceInfo | device_info contains device properties. |
remove | google.protobuf.BoolValue | remove if set to true will remove the device from mainline post workspace merge |
DeviceKey
DeviceKey uniquely identifies the device for a workspace.
Field Name | Type | Description |
---|---|---|
workspace_id | google.protobuf.StringValue | workspace_id identifies the workspace uniquely. |
device_id | google.protobuf.StringValue | device_id identifies the device uniquely. |
DeviceState
DeviceState is the state of a device written by InterfaceInputConfig, DeviceInputConfig and UpdateConfig resources
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the device for a given workspace. |
device_info | DeviceInfo | device_info contains device properties |
interface_infos | InterfaceInfos | interface_infos contains interface properties of all the interfaces belonging to the device |
InterfaceInfo
InterfaceInfo contains interface properties.
Field Name | Type | Description |
---|---|---|
name | google.protobuf.StringValue | name is the name of an interface. |
neighbor_device_id | google.protobuf.StringValue | neighbor_device_id indicates the device ID of the neighbor to which this interface is connected. |
neighbor_interface_name | google.protobuf.StringValue | neighbor_interface_name indicates the interface on the neighbor to which this interface is connected. |
InterfaceInfos
InterfaceInfos is a list of InterfaceInfo.
Field Name | Type | Description |
---|---|---|
values | InterfaceInfo[...] | values is a list of InterfaceInfo. |
InterfaceInputConfig
InterfaceInputConfig is the resource for manually adding an interface in I&T studios
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | key uniquely identifies the interface for a given workspace. |
interface_info | InterfaceInfo | interface_info contains interface properties. |
remove | google.protobuf.BoolValue | remove if set to true will remove the interface from mainline post workspace merge |
InterfaceInputKey
InterfaceInputKey is the set of inputs that uniquely identify the interface for a workspace.
Field Name | Type | Description |
---|---|---|
workspace_id | google.protobuf.StringValue | workspace_id identifies the workspace uniquely. |
device_id | google.protobuf.StringValue | device_id identifies the device uniquely. |
interface_id | google.protobuf.StringValue | interface_id along with device_id identifies the interface uniquely. |
Replace
Replace is the resource that holds the status of the replace operation.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the original device for a given workspace. |
replacement_device_id | google.protobuf.StringValue | replacement_device_id is the device to replace the original device with. |
created_at | google.protobuf.Timestamp | created_at is the time at which the status was first set. |
created_by | google.protobuf.StringValue | created_by is the name of the user that first set the status. |
last_modified_at | google.protobuf.Timestamp | last_modified_at is the time at which the status was last modified. |
last_modified_by | google.protobuf.StringValue | last_modified_by is the name of the user that last modified the status. |
status | ReplaceStatus | status indicates the status of the replace operation. |
error | google.protobuf.StringValue | error provides the reason if there is a failure in replace. |
ReplaceConfig
ReplaceConfig is the resource for replacing a device with another device in Studios.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | key uniquely identifies the original device to be replaced in a given workspace. |
replacement_device_id | google.protobuf.StringValue | replacement_device_id is the device to replace the original device with. All references to the original device in Studios and tags will be replaced with this device. |
RevertConfig
RevertConfig is the model provided to revert a workspace.
Field Name | Type | Description |
---|---|---|
key | arista.workspace.v1.WorkspaceKey | key uniquely identifies the workspace. |
Update
Update represents an update on to the workspace.
Field Name | Type | Description |
---|---|---|
key | UpdateKey | key uniquely identifies the update. |
element | Element | element indicates the type of a network element. |
operation | Operation | operation indicates the type of operation on the topology update. |
status | UpdateStatus | status indicates the status of the topology update. |
description | google.protobuf.StringValue | description describes the topology update in short. |
device_id | google.protobuf.StringValue | device_id indicates the device associated with the update. |
UpdateConfig
UpdateConfig contains the acceptance status of an Update.
Field Name | Type | Description |
---|---|---|
key | UpdateKey | key uniquely identifies the update. |
status | UpdateStatus | status indicates the status of the topology update. |
remove | google.protobuf.BoolValue | remove if set to true will remove the update key from mainline post workspace merge. This can only be set true for ignored keys since we don't carry accepted keys to mainline post workspace merge |
UpdateKey
UpdateKey uniquely identifies a workspace topology update.
Field Name | Type | Description |
---|---|---|
workspace_id | google.protobuf.StringValue | workspace_id identifies the workspace uniquely. |
update_id | google.protobuf.StringValue | update_id identifies the update uniquely. |
UpdateSyncConfig
UpdateSyncConfig model represents a point in time all updates are to be accepted.
Field Name | Type | Description |
---|---|---|
key | arista.workspace.v1.WorkspaceKey | key uniquely identifies the workspace. |
sync_time | google.protobuf.Timestamp | sync_time indicates the desired synchronization time with the live topology. If the sync_time indicated in the config takes effect without error, it will appear in the state model, and then all updates that occurred up to and including the timestamp in the state model will be accepted. |
DecommissionStatus
DecommissionStatus enumerates the status of decommissioning a device.
Name | Number | Description |
---|---|---|
DECOMMISSION_STATUS_UNSPECIFIED | 0 | DECOMMISSION_STATUS_UNSPECIFIED indicates that the device was decommissioned with an unspecified state. |
DECOMMISSION_STATUS_SUCCESS | 1 | DECOMMISSION_STATUS_SUCCESS indicates that the device was successfully decommissioned. |
DECOMMISSION_STATUS_FAILURE | 2 | DECOMMISSION_STATUS_FAILURE indicates an error with decommissioning the device. |
Element
Element defines the fundamental types of elements in topology.
Name | Number | Description |
---|---|---|
ELEMENT_UNSPECIFIED | 0 | ELEMENT_UNSPECIFIED indicates an unspecified element type. |
ELEMENT_DEVICE | 1 | ELEMENT_DEVICE indicates a device. |
ELEMENT_INTERFACE | 2 | ELEMENT_INTERFACE indicates an interface. |
ELEMENT_CONNECTION | 3 | ELEMENT_CONNECTION indicates a connection. |
Operation
Operation defines the operations that may be performed on the topology.
Name | Number | Description |
---|---|---|
OPERATION_UNSPECIFIED | 0 | OPERATION_UNSPECIFIED indicates an unspecified operation. |
OPERATION_ADDED | 1 | OPERATION_ADDED indicates addition of an Element. |
OPERATION_MODIFIED | 2 | OPERATION_MODIFIED indicates modification of an Element. |
OPERATION_REMOVED | 3 | OPERATION_REMOVED indicates removal of an Element. |
ReplaceStatus
ReplaceStatus enumerates the status of the device.
Name | Number | Description |
---|---|---|
REPLACE_STATUS_UNSPECIFIED | 0 | REPLACE_STATUS_UNSPECIFIED indicates that the device was replaced with an unspecified state. |
REPLACE_STATUS_SUCCESS | 1 | REPLACE_STATUS_SUCCESS indicates that the device was successfully replaced. |
REPLACE_STATUS_FAILURE | 2 | REPLACE_STATUS_FAILURE indicates an error with replace. |
UpdateStatus
UpdateStatus defines the set of statuses that apply to individual topology updates.
Name | Number | Description |
---|---|---|
UPDATE_STATUS_UNSPECIFIED | 0 | UPDATE_STATUS_UNSPECIFIED indicates an unspecified update status. |
UPDATE_STATUS_NEW | 1 | UPDATE_STATUS_NEW indicates the update is new. |
UPDATE_STATUS_ACCEPTED | 2 | UPDATE_STATUS_ACCEPTED indicates the update is accepted. |
UPDATE_STATUS_IGNORED | 3 | UPDATE_STATUS_IGNORED indicates the update is ignored. |
arista/studio_topology.v1/services.gen.proto
DecommissionBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Decommission[...] | 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 Decommission at end. * Each Decommission response is fully-specified (all fields set). * start: Returns the state of each Decommission at start, followed by updates until now. * Each Decommission response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Decommission at start, followed by updates until end. * Each Decommission 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. |
DecommissionBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DecommissionStreamResponse[...] | 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). |
DecommissionConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DecommissionConfig[...] | 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 DecommissionConfig at end. * Each DecommissionConfig response is fully-specified (all fields set). * start: Returns the state of each DecommissionConfig at start, followed by updates until now. * Each DecommissionConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DecommissionConfig at start, followed by updates until end. * Each DecommissionConfig 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. |
DecommissionConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DecommissionConfigStreamResponse[...] | 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). |
DecommissionConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DecommissionConfig[...] | 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. |
DecommissionConfigDeleteAllResponse
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 | DeviceKey | This is the key of the DecommissionConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
DecommissionConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key indicates which DecommissionConfig instance to remove. This field must always be set. |
DecommissionConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key echoes back the key of the deleted DecommissionConfig 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. |
DecommissionConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | key contains a list of DecommissionConfig keys to delete |
DecommissionConfigDeleteSomeResponse
DecommissionConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
DecommissionConfigRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a DecommissionConfig 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. |
DecommissionConfigResponse
Field Name | Type | Description |
---|---|---|
value | DecommissionConfig | 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 DecommissionConfig instance in this response. |
DecommissionConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | DecommissionConfig | DecommissionConfig carries the value to set into the datastore. See the documentation on the DecommissionConfig struct for which fields are required. |
DecommissionConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | DecommissionConfig | Value carries all the values given in the DecommissionConfigSetRequest 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. |
DecommissionConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | DecommissionConfig[...] | value contains a list of DecommissionConfig 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. |
DecommissionConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
DecommissionConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
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. |
DecommissionConfigSomeResponse
Field Name | Type | Description |
---|---|---|
value | DecommissionConfig | 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 |
DecommissionConfigStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DecommissionConfig[...] | 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 DecommissionConfig at end. * Each DecommissionConfig response is fully-specified (all fields set). * start: Returns the state of each DecommissionConfig at start, followed by updates until now. * Each DecommissionConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DecommissionConfig at start, followed by updates until end. * Each DecommissionConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
DecommissionConfigStreamResponse
Field Name | Type | Description |
---|---|---|
value | DecommissionConfig | 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 DecommissionConfig's last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DecommissionConfig 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. |
DecommissionRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a Decommission 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. |
DecommissionResponse
Field Name | Type | Description |
---|---|---|
value | Decommission | 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 Decommission instance in this response. |
DecommissionSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
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. |
DecommissionSomeResponse
Field Name | Type | Description |
---|---|---|
value | Decommission | 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 |
DecommissionStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Decommission[...] | 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 Decommission at end. * Each Decommission response is fully-specified (all fields set). * start: Returns the state of each Decommission at start, followed by updates until now. * Each Decommission response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Decommission at start, followed by updates until end. * Each Decommission response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
DecommissionStreamResponse
Field Name | Type | Description |
---|---|---|
value | Decommission | 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 Decommission's last modification. |
type | arista.subscriptions.Operation | Operation indicates how the Decommission 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. |
DeviceInputConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceInputConfig[...] | 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 DeviceInputConfig at end. * Each DeviceInputConfig response is fully-specified (all fields set). * start: Returns the state of each DeviceInputConfig at start, followed by updates until now. * Each DeviceInputConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DeviceInputConfig at start, followed by updates until end. * Each DeviceInputConfig 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. |
DeviceInputConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceInputConfigStreamResponse[...] | 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). |
DeviceInputConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceInputConfig[...] | 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. |
DeviceInputConfigDeleteAllResponse
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 | DeviceKey | This is the key of the DeviceInputConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
DeviceInputConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key indicates which DeviceInputConfig instance to remove. This field must always be set. |
DeviceInputConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key echoes back the key of the deleted DeviceInputConfig 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. |
DeviceInputConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | key contains a list of DeviceInputConfig keys to delete |
DeviceInputConfigDeleteSomeResponse
DeviceInputConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
DeviceInputConfigRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a DeviceInputConfig 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. |
DeviceInputConfigResponse
Field Name | Type | Description |
---|---|---|
value | DeviceInputConfig | 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 DeviceInputConfig instance in this response. |
DeviceInputConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | DeviceInputConfig | DeviceInputConfig carries the value to set into the datastore. See the documentation on the DeviceInputConfig struct for which fields are required. |
DeviceInputConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | DeviceInputConfig | Value carries all the values given in the DeviceInputConfigSetRequest 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. |
DeviceInputConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | DeviceInputConfig[...] | value contains a list of DeviceInputConfig 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. |
DeviceInputConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
DeviceInputConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
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. |
DeviceInputConfigSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceInputConfig | 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 |
DeviceInputConfigStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceInputConfig[...] | 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 DeviceInputConfig at end. * Each DeviceInputConfig response is fully-specified (all fields set). * start: Returns the state of each DeviceInputConfig at start, followed by updates until now. * Each DeviceInputConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DeviceInputConfig at start, followed by updates until end. * Each DeviceInputConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
DeviceInputConfigStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceInputConfig | 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 DeviceInputConfig's last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DeviceInputConfig 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. |
DeviceStateBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceState[...] | 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 DeviceState at end. * Each DeviceState response is fully-specified (all fields set). * start: Returns the state of each DeviceState at start, followed by updates until now. * Each DeviceState response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DeviceState at start, followed by updates until end. * Each DeviceState 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. |
DeviceStateBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | DeviceStateStreamResponse[...] | 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). |
DeviceStateRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a DeviceState 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. |
DeviceStateResponse
Field Name | Type | Description |
---|---|---|
value | DeviceState | 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 DeviceState instance in this response. |
DeviceStateSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
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. |
DeviceStateSomeResponse
Field Name | Type | Description |
---|---|---|
value | DeviceState | 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 |
DeviceStateStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | DeviceState[...] | 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 DeviceState at end. * Each DeviceState response is fully-specified (all fields set). * start: Returns the state of each DeviceState at start, followed by updates until now. * Each DeviceState response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each DeviceState at start, followed by updates until end. * Each DeviceState response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
DeviceStateStreamResponse
Field Name | Type | Description |
---|---|---|
value | DeviceState | 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 DeviceState's last modification. |
type | arista.subscriptions.Operation | Operation indicates how the DeviceState 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. |
InterfaceInputConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceInputConfig[...] | 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 InterfaceInputConfig at end. * Each InterfaceInputConfig response is fully-specified (all fields set). * start: Returns the state of each InterfaceInputConfig at start, followed by updates until now. * Each InterfaceInputConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each InterfaceInputConfig at start, followed by updates until end. * Each InterfaceInputConfig 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. |
InterfaceInputConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | InterfaceInputConfigStreamResponse[...] | 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). |
InterfaceInputConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceInputConfig[...] | 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. |
InterfaceInputConfigDeleteAllResponse
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 | InterfaceInputKey | This is the key of the InterfaceInputConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
InterfaceInputConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | Key indicates which InterfaceInputConfig instance to remove. This field must always be set. |
InterfaceInputConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | Key echoes back the key of the deleted InterfaceInputConfig 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. |
InterfaceInputConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | InterfaceInputKey[...] | key contains a list of InterfaceInputConfig keys to delete |
InterfaceInputConfigDeleteSomeResponse
InterfaceInputConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | |
error | string |
InterfaceInputConfigRequest
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | Key uniquely identifies a InterfaceInputConfig 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. |
InterfaceInputConfigResponse
Field Name | Type | Description |
---|---|---|
value | InterfaceInputConfig | 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 InterfaceInputConfig instance in this response. |
InterfaceInputConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | InterfaceInputConfig | InterfaceInputConfig carries the value to set into the datastore. See the documentation on the InterfaceInputConfig struct for which fields are required. |
InterfaceInputConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | InterfaceInputConfig | Value carries all the values given in the InterfaceInputConfigSetRequest 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. |
InterfaceInputConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | InterfaceInputConfig[...] | value contains a list of InterfaceInputConfig 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. |
InterfaceInputConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | InterfaceInputKey | |
error | string |
InterfaceInputConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | InterfaceInputKey[...] | |
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. |
InterfaceInputConfigSomeResponse
Field Name | Type | Description |
---|---|---|
value | InterfaceInputConfig | 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 |
InterfaceInputConfigStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | InterfaceInputConfig[...] | 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 InterfaceInputConfig at end. * Each InterfaceInputConfig response is fully-specified (all fields set). * start: Returns the state of each InterfaceInputConfig at start, followed by updates until now. * Each InterfaceInputConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each InterfaceInputConfig at start, followed by updates until end. * Each InterfaceInputConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC. |
InterfaceInputConfigStreamResponse
Field Name | Type | Description |
---|---|---|
value | InterfaceInputConfig | 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 InterfaceInputConfig's last modification. |
type | arista.subscriptions.Operation | Operation indicates how the InterfaceInputConfig 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. |
ReplaceBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | Replace[...] | 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 Replace at end. * Each Replace response is fully-specified (all fields set). * start: Returns the state of each Replace at start, followed by updates until now. * Each Replace response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Replace at start, followed by updates until end. * Each Replace 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. |
ReplaceBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | ReplaceStreamResponse[...] | 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). |
ReplaceConfigBatchedStreamRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | ReplaceConfig[...] | 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 ReplaceConfig at end. * Each ReplaceConfig response is fully-specified (all fields set). * start: Returns the state of each ReplaceConfig at start, followed by updates until now. * Each ReplaceConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ReplaceConfig at start, followed by updates until end. * Each ReplaceConfig 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. |
ReplaceConfigBatchedStreamResponse
Field Name | Type | Description |
---|---|---|
responses | ReplaceConfigStreamResponse[...] | 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). |
ReplaceConfigDeleteAllRequest
Field Name | Type | Description |
---|---|---|
partial_eq_filter | ReplaceConfig[...] | 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. |
ReplaceConfigDeleteAllResponse
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 | DeviceKey | This is the key of the ReplaceConfig instance that failed to be deleted. |
time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
ReplaceConfigDeleteRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key indicates which ReplaceConfig instance to remove. This field must always be set. |
ReplaceConfigDeleteResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key echoes back the key of the deleted ReplaceConfig 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. |
ReplaceConfigDeleteSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | key contains a list of ReplaceConfig keys to delete |
ReplaceConfigDeleteSomeResponse
ReplaceConfigDeleteSomeResponse is only sent when there is an error.
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
ReplaceConfigRequest
Field Name | Type | Description |
---|---|---|
key | DeviceKey | Key uniquely identifies a ReplaceConfig 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. |
ReplaceConfigResponse
Field Name | Type | Description |
---|---|---|
value | ReplaceConfig | 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 ReplaceConfig instance in this response. |
ReplaceConfigSetRequest
Field Name | Type | Description |
---|---|---|
value | ReplaceConfig | ReplaceConfig carries the value to set into the datastore. See the documentation on the ReplaceConfig struct for which fields are required. |
ReplaceConfigSetResponse
Field Name | Type | Description |
---|---|---|
value | ReplaceConfig | Value carries all the values given in the ReplaceConfigSetRequest 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. |
ReplaceConfigSetSomeRequest
Field Name | Type | Description |
---|---|---|
values | ReplaceConfig[...] | value contains a list of ReplaceConfig 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. |
ReplaceConfigSetSomeResponse
Field Name | Type | Description |
---|---|---|
key | DeviceKey | |
error | string |
ReplaceConfigSomeRequest
Field Name | Type | Description |
---|---|---|
keys | DeviceKey[...] | |
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. |