tag.v1

Top

arista/tag.v1/tag.proto

DeviceTag

DeviceTag is a label-value pair that may or may not be assigned to a device.

Field NameTypeDescription
keyTagKey

Key uniquely identifies the device tag.

creator_typeCreatorType

CreatorType is the creator type of the tag.

DeviceTagAssignmentConfig

DeviceTagAssignmentConfig is the assignment of a device tag to a specific device.

Field NameTypeDescription
keyDeviceTagAssignmentKey

Key uniquely identifies the device tag assignment.

DeviceTagAssignmentKey

DeviceTagAssignmentKey uniquely identifies a device tag assignment.

Field NameTypeDescription
labelgoogle.protobuf.StringValue

Label is the label of the tag.

valuegoogle.protobuf.StringValue

Value is the value of the tag.

device_idgoogle.protobuf.StringValue

DeviceId is the ID of the device.

DeviceTagConfig

DeviceTagConfig is a label-value pair that may or may not be assigned to a device.

Field NameTypeDescription
keyTagKey

Key uniquely identifies the device tag.

InterfaceTag

InterfaceTag is a label-value pair that may or may not be assigned to an interface.

Field NameTypeDescription
keyTagKey

Key uniquely identifies the interface tag.

creator_typeCreatorType

CreatorType is the creator type of the tag.

InterfaceTagAssignmentConfig

InterfaceTagAssignmentConfig is the assignment of an interface tag to a specific interface.

Field NameTypeDescription
keyInterfaceTagAssignmentKey

Key uniquely identifies the interface tag assignment.

InterfaceTagAssignmentKey

InterfaceTagAssignmentKey uniquely identifies an interface tag assignment.

Field NameTypeDescription
labelgoogle.protobuf.StringValue

Label is the label of the tag.

valuegoogle.protobuf.StringValue

Value is the value of the tag.

device_idgoogle.protobuf.StringValue

DeviceId is the ID of the interface’s device.

interface_idgoogle.protobuf.StringValue

InterfaceId is the ID of the interface.

InterfaceTagConfig

InterfaceTagConfig is a label-value pair that may or may not be assigned to an interface.

Field NameTypeDescription
keyTagKey

Key uniquely identifies the interface tag.

TagKey

TagKey uniquely identifies a tag for a network element.

Field NameTypeDescription
labelgoogle.protobuf.StringValue

Label is the label of the tag.

valuegoogle.protobuf.StringValue

Value is the value of the tag.

CreatorType

CreatorType specifies an entity that creates something.

NameNumberDescription
CREATOR_TYPE_UNSPECIFIED0

CREATOR_TYPE_SYSTEM1

CREATOR_TYPE_SYSTEM is the type for something created by the system.

CREATOR_TYPE_USER2

CREATOR_TYPE_USER is the type for something created by a user.

Top

arista/tag.v1/services.gen.proto

DeviceTagAssignmentConfigDeleteRequest

Field NameTypeDescription
keyDeviceTagAssignmentKey

Key indicates which DeviceTagAssignmentConfig instance to remove.

This field (and all keys, unless otherwise specified) must always be set.

DeviceTagAssignmentConfigDeleteResponse

Field NameTypeDescription
keyDeviceTagAssignmentKey

Key echoes back the key of the deleted DeviceTagAssignmentConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

DeviceTagAssignmentConfigRequest

Field NameTypeDescription
keyDeviceTagAssignmentKey

Key uniquely identifies a DeviceTagAssignmentConfig instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

DeviceTagAssignmentConfigResponse

Field NameTypeDescription
valueDeviceTagAssignmentConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

DeviceTagAssignmentConfig instance in this response.

DeviceTagAssignmentConfigSetRequest

Field NameTypeDescription
valueDeviceTagAssignmentConfig

DeviceTagAssignmentConfig carries the value to set into the datastore.

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

DeviceTagAssignmentConfigSetResponse

Field NameTypeDescription
valueDeviceTagAssignmentConfig

Value carries all the values given in the DeviceTagAssignmentConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

DeviceTagAssignmentConfigStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceTagAssignmentConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

DeviceTagAssignmentConfigStreamResponse

Field NameTypeDescription
valueDeviceTagAssignmentConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the DeviceTagAssignmentConfig 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.

DeviceTagConfigDeleteRequest

Field NameTypeDescription
keyTagKey

Key indicates which DeviceTagConfig instance to remove.

This field (and all keys, unless otherwise specified) must always be set.

DeviceTagConfigDeleteResponse

Field NameTypeDescription
keyTagKey

Key echoes back the key of the deleted DeviceTagConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

DeviceTagConfigRequest

Field NameTypeDescription
keyTagKey

Key uniquely identifies a DeviceTagConfig instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

DeviceTagConfigResponse

Field NameTypeDescription
valueDeviceTagConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

DeviceTagConfig instance in this response.

DeviceTagConfigSetRequest

Field NameTypeDescription
valueDeviceTagConfig

DeviceTagConfig carries the value to set into the datastore.

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

DeviceTagConfigSetResponse

Field NameTypeDescription
valueDeviceTagConfig

Value carries all the values given in the DeviceTagConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

DeviceTagConfigStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceTagConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

DeviceTagConfigStreamResponse

Field NameTypeDescription
valueDeviceTagConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the DeviceTagConfig 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.

DeviceTagRequest

Field NameTypeDescription
keyTagKey

Key uniquely identifies a DeviceTag instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

DeviceTagResponse

Field NameTypeDescription
valueDeviceTag

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

DeviceTag instance in this response.

DeviceTagStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceTag[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

DeviceTagStreamResponse

Field NameTypeDescription
valueDeviceTag

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the DeviceTag 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.

InterfaceTagAssignmentConfigDeleteRequest

Field NameTypeDescription
keyInterfaceTagAssignmentKey

Key indicates which InterfaceTagAssignmentConfig instance to remove.

This field (and all keys, unless otherwise specified) must always be set.

InterfaceTagAssignmentConfigDeleteResponse

Field NameTypeDescription
keyInterfaceTagAssignmentKey

Key echoes back the key of the deleted InterfaceTagAssignmentConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

InterfaceTagAssignmentConfigRequest

Field NameTypeDescription
keyInterfaceTagAssignmentKey

Key uniquely identifies a InterfaceTagAssignmentConfig instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

InterfaceTagAssignmentConfigResponse

Field NameTypeDescription
valueInterfaceTagAssignmentConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

InterfaceTagAssignmentConfig instance in this response.

InterfaceTagAssignmentConfigSetRequest

Field NameTypeDescription
valueInterfaceTagAssignmentConfig

InterfaceTagAssignmentConfig carries the value to set into the datastore.

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

InterfaceTagAssignmentConfigSetResponse

Field NameTypeDescription
valueInterfaceTagAssignmentConfig

Value carries all the values given in the InterfaceTagAssignmentConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

InterfaceTagAssignmentConfigStreamRequest

Field NameTypeDescription
partial_eq_filterInterfaceTagAssignmentConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

InterfaceTagAssignmentConfigStreamResponse

Field NameTypeDescription
valueInterfaceTagAssignmentConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the InterfaceTagAssignmentConfig 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.

InterfaceTagConfigDeleteRequest

Field NameTypeDescription
keyTagKey

Key indicates which InterfaceTagConfig instance to remove.

This field (and all keys, unless otherwise specified) must always be set.

InterfaceTagConfigDeleteResponse

Field NameTypeDescription
keyTagKey

Key echoes back the key of the deleted InterfaceTagConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

InterfaceTagConfigRequest

Field NameTypeDescription
keyTagKey

Key uniquely identifies a InterfaceTagConfig instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

InterfaceTagConfigResponse

Field NameTypeDescription
valueInterfaceTagConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

InterfaceTagConfig instance in this response.

InterfaceTagConfigSetRequest

Field NameTypeDescription
valueInterfaceTagConfig

InterfaceTagConfig carries the value to set into the datastore.

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

InterfaceTagConfigSetResponse

Field NameTypeDescription
valueInterfaceTagConfig

Value carries all the values given in the InterfaceTagConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

InterfaceTagConfigStreamRequest

Field NameTypeDescription
partial_eq_filterInterfaceTagConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

InterfaceTagConfigStreamResponse

Field NameTypeDescription
valueInterfaceTagConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the InterfaceTagConfig 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.

InterfaceTagRequest

Field NameTypeDescription
keyTagKey

Key uniquely identifies a InterfaceTag instance to retrieve.

This value (and all fields, unless otherwise specified) must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at twhich it makes the request.

InterfaceTagResponse

Field NameTypeDescription
valueInterfaceTag

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

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

InterfaceTag instance in this response.

InterfaceTagStreamRequest

Field NameTypeDescription
partial_eq_filterInterfaceTag[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

This field is not allowed in the Subscribe RPC.

InterfaceTagStreamResponse

Field NameTypeDescription
valueInterfaceTag

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

Operation indicates how the InterfaceTag 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.

DeviceTagAssignmentConfigService

Method NameRequest TypeResponse TypeDescription
GetOneDeviceTagAssignmentConfigRequestDeviceTagAssignmentConfigResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllDeviceTagAssignmentConfigStreamRequestDeviceTagAssignmentConfigStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeDeviceTagAssignmentConfigStreamRequestDeviceTagAssignmentConfigStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

SetDeviceTagAssignmentConfigSetRequestDeviceTagAssignmentConfigSetResponse

Set allows setting values for the entity specified by the key in the request.

The key must be provided and all fields set (unless otherwise specified).

DeleteDeviceTagAssignmentConfigDeleteRequestDeviceTagAssignmentConfigDeleteResponse

Delete will remove the entity specified by the key within the request.

The key must be provided and all fields populated (unless otherwise specified).

DeviceTagConfigService

Method NameRequest TypeResponse TypeDescription
GetOneDeviceTagConfigRequestDeviceTagConfigResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllDeviceTagConfigStreamRequestDeviceTagConfigStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeDeviceTagConfigStreamRequestDeviceTagConfigStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

SetDeviceTagConfigSetRequestDeviceTagConfigSetResponse

Set allows setting values for the entity specified by the key in the request.

The key must be provided and all fields set (unless otherwise specified).

DeleteDeviceTagConfigDeleteRequestDeviceTagConfigDeleteResponse

Delete will remove the entity specified by the key within the request.

The key must be provided and all fields populated (unless otherwise specified).

DeviceTagService

Method NameRequest TypeResponse TypeDescription
GetOneDeviceTagRequestDeviceTagResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllDeviceTagStreamRequestDeviceTagStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeDeviceTagStreamRequestDeviceTagStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

InterfaceTagAssignmentConfigService

Method NameRequest TypeResponse TypeDescription
GetOneInterfaceTagAssignmentConfigRequestInterfaceTagAssignmentConfigResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllInterfaceTagAssignmentConfigStreamRequestInterfaceTagAssignmentConfigStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeInterfaceTagAssignmentConfigStreamRequestInterfaceTagAssignmentConfigStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

SetInterfaceTagAssignmentConfigSetRequestInterfaceTagAssignmentConfigSetResponse

Set allows setting values for the entity specified by the key in the request.

The key must be provided and all fields set (unless otherwise specified).

DeleteInterfaceTagAssignmentConfigDeleteRequestInterfaceTagAssignmentConfigDeleteResponse

Delete will remove the entity specified by the key within the request.

The key must be provided and all fields populated (unless otherwise specified).

InterfaceTagConfigService

Method NameRequest TypeResponse TypeDescription
GetOneInterfaceTagConfigRequestInterfaceTagConfigResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllInterfaceTagConfigStreamRequestInterfaceTagConfigStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeInterfaceTagConfigStreamRequestInterfaceTagConfigStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

SetInterfaceTagConfigSetRequestInterfaceTagConfigSetResponse

Set allows setting values for the entity specified by the key in the request.

The key must be provided and all fields set (unless otherwise specified).

DeleteInterfaceTagConfigDeleteRequestInterfaceTagConfigDeleteResponse

Delete will remove the entity specified by the key within the request.

The key must be provided and all fields populated (unless otherwise specified).

InterfaceTagService

Method NameRequest TypeResponse TypeDescription
GetOneInterfaceTagRequestInterfaceTagResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllInterfaceTagStreamRequestInterfaceTagStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeInterfaceTagStreamRequestInterfaceTagStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.