configlet.v1

display_name is the display name of the static configlet.

description is the description of the static configlet.

migrated_from is populated with the source configlet name when migrated

from network provisioning to studio.

body is the static configlet body.

created_at is the time when the Configlet was created.

created_by is the user who created the Configlet.

last_modified_at is the time when the Configlet was last modified.

last_modified_by is the user who last modified the Configlet.

configlet_ids is the list of configlets which are assigned

query represents the tag query assigned

match_policy is the discriminator for the query field

list of child assignments

created_at is the time when the ConfigletAssignment was created.

created_by is the user who created the ConfigletAssignment.

last_modified_at is the time when the ConfigletAssignment

was last modified.

last_modified_by is the user who last modified the ConfigletAssignment.

configlet_ids is the list of configlets to be assigned

query is a tag query string that conforms to the CloudVision

tag query language. E.g., the query, "datacenter:NYC,SFO AND</p><p>sflow:enabled", matches all devices with sflow enabled in

data centers NYC and SFO.

malformed queries result in an error

tags not matching devices are ignored

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

unset) the tag assignments involving the studio identified

by the key if the encompassing workspace merges. Other data

fields are not allowed if this field is set to true.

match_policy is the discriminator for the query field

list of child assignments

workspace_id is the unique identifier of the workspace.

configlet_assignment_id is the unique identifier of the configlet_assignment.

remove specifies the static configlet is to be removed from the workspace.

Other data fields are not allowed when this field is set to true.

display_name is the display name of the static configlet.

description is the description of the static configlet.

migrated_from is populated with the source configlet name when migrated

from network provisioning to studio.

body is the static configlet body.

workspace_id identifies the workspace within which the static configlet resides

empty string ("") stands for the “mainline”.

configlet_id is the static configlet ID.

include_body specifies the static configlet body is to be included.

MATCH_POLICY_MATCH_FIRST dictates that matching devices are used only for the first match amongst its children

MATCH_POLICY_MATCH_ALL dictates that matching devices are used across all children

This describes the class of delete error.

This indicates the error message from the delete failure.

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

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

Key indicates which ConfigletAssignmentConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted ConfigletAssignmentConfig 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 contains a list of ConfigletAssignmentConfig keys to delete

Key uniquely identifies a ConfigletAssignmentConfig 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

ConfigletAssignmentConfig instance in this response.

ConfigletAssignmentConfig carries the value to set into the datastore.

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

Value carries all the values given in the ConfigletAssignmentConfigSetRequest 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.

value contains a list of ConfigletAssignmentConfig 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.

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.

Error is an optional field.

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

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.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ConfigletAssignmentConfig at end.

* Each ConfigletAssignmentConfig response is fully-specified (all fields set).

* start: Returns the state of each ConfigletAssignmentConfig at start, followed by updates until now.

* Each ConfigletAssignmentConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ConfigletAssignmentConfig at start, followed by updates

until end.

* Each ConfigletAssignmentConfig response at start is fully-specified, but updates until end may

be partial.

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 ConfigletAssignmentConfig’s last modification.

Operation indicates how the ConfigletAssignmentConfig 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 ConfigletAssignment 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

ConfigletAssignment instance in this response.

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.

Error is an optional field.

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

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.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ConfigletAssignment at end.

* Each ConfigletAssignment response is fully-specified (all fields set).

* start: Returns the state of each ConfigletAssignment at start, followed by updates until now.

* Each ConfigletAssignment response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ConfigletAssignment at start, followed by updates

until end.

* Each ConfigletAssignment response at start is fully-specified, but updates until end may

be partial.

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 ConfigletAssignment’s last modification.

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

This describes the class of delete error.

This indicates the error message from the delete failure.

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

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

Key indicates which ConfigletConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted ConfigletConfig 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 contains a list of ConfigletConfig keys to delete

Key uniquely identifies a ConfigletConfig 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

ConfigletConfig instance in this response.

ConfigletConfig carries the value to set into the datastore.

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

Value carries all the values given in the ConfigletConfigSetRequest 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.

value contains a list of ConfigletConfig 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.

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.

Error is an optional field.

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

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.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ConfigletConfig at end.

* Each ConfigletConfig response is fully-specified (all fields set).

* start: Returns the state of each ConfigletConfig at start, followed by updates until now.

* Each ConfigletConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ConfigletConfig at start, followed by updates

until end.

* Each ConfigletConfig response at start is fully-specified, but updates until end may

be partial.

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 ConfigletConfig’s last modification.

Operation indicates how the ConfigletConfig 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 Configlet 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

Configlet instance in this response.

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.

Error is an optional field.

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

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.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Configlet at end.

* Each Configlet response is fully-specified (all fields set).

* start: Returns the state of each Configlet at start, followed by updates until now.

* Each Configlet response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Configlet at start, followed by updates

until end.

* Each Configlet response at start is fully-specified, but updates until end may

be partial.

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 Configlet’s last modification.

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

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

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 is the number of items present under the conditions of the request.