tag.v2

key identifies a tag.

creator_type is the creator type of the tag.

key identifies an assignment.

key identifies an assignment. The special workspace ID “"

for merged assignments should not be set here.

remove indicates whether to remove (true) or add (false,

unset) the assignment identified by the key if the

encompassing workspace merges.

workspace_id is the ID of a workspace. The special ID “"

identifies the location where merged assignments reside.

element_type is the element type of a tag. What should

be set per element type:

ELEMENT_TYPE_DEVICE: device_id

ELEMENT_TYPE_INTERFACE: device_id, interface_id

label is the label of a tag.

value is the value of a tag.

device_id identifies a device.

interface_id identifies an interface on a device.

key identifies a tag. The special workspace ID "” for

merged tags should not be set here.

remove indicates whether to remove (true) or add (false,

unset) the tag identified by the key if the encompassing

workspace merges.

workspace_id is the ID of a workspace. The special ID “"

identifies the location where merged tags reside.

element_type is the category of network element to which

this tag can be assigned.

label is an arbitrary label.

value is an arbitrary value.

CREATOR_TYPE_SYSTEM is used for system tags.

CREATOR_TYPE_USER is used for user tags.

ELEMENT_TYPE_DEVICE is used for device tags.

ELEMENT_TYPE_INTERFACE is used for interface tags.

Key indicates which TagAssignmentConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted TagAssignmentConfig instance.

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.

Key uniquely identifies a TagAssignmentConfig instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

TagAssignmentConfig instance in this response.

TagAssignmentConfig carries the value to set into the datastore.

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

Value carries all the values given in the TagAssignmentConfigSetRequest as well

as any server-generated values.

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.

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.

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.

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 holds the timestamp of this TagAssignmentConfig’s last modification.

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

Key uniquely identifies a TagAssignment instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

TagAssignment instance in this response.

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.

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.

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 holds the timestamp of this TagAssignment’s last modification.

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

Key indicates which TagConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted TagConfig instance.

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.

Key uniquely identifies a TagConfig instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

TagConfig instance in this response.

TagConfig carries the value to set into the datastore.

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

Value carries all the values given in the TagConfigSetRequest as well

as any server-generated values.

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.

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.

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.

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 holds the timestamp of this TagConfig’s last modification.

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

Key uniquely identifies a Tag instance to retrieve.

This value must be populated.

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.

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 carries the (UTC) timestamp of the last-modification of the

Tag instance in this response.

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.

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.

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 holds the timestamp of this Tag’s last modification.

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