changecontrol.v1

key uniquely identifies the change control.

approve

FlagConfig

approve is the flag to approve (approve.value set to true)

or unapprove (approve.value set to false) the change control.

version

google.protobuf.Timestamp

version is the timestamp of the change control to approve.

This field must be set when approve.value is set to true

and is intended to safeguard against approving a change control

that has been updated since last read.

Change

Change holds the configuration and status of the change of a change control.

Field Name	Type	Description
name	google.protobuf.StringValue	name is the name of the change.
root_stage_id	google.protobuf.StringValue	root_stage_id is the ID of the root stage or the stage that should execute first.
stages	StageMap	stages holds a configuration of stages and their statuses.
notes	google.protobuf.StringValue	notes are any notes associated with the change.
time	google.protobuf.Timestamp	time is the time at which the change was last updated.
user	google.protobuf.StringValue	user is the user by which the change was last updated.

ChangeConfig

ChangeConfig holds a configuration for the change of a change control which is essentially a named configuration of stages.

Field Name	Type	Description
name	google.protobuf.StringValue	name is the name of the change.
root_stage_id	google.protobuf.StringValue	root_stage_id is the ID of the root stage or the stage that should execute first.
stages	StageConfigMap	stages holds a configuration of stages. See `StageConfigMap` description for more information.
notes	google.protobuf.StringValue	notes are any notes associated with the change.

ChangeControl

ChangeControl holds the configuration and status of a change control.

Field Name	Type	Description
key	ChangeControlKey	key uniquely identifies the change control.
change	Change	change holds the configuration and status of the change of the change control.
approve	Flag	approve indicates whether the change control was flagged as approved (`approve.value` set to `true`) or unapproved (`approve.value` set to `false`).
start	Flag	start indicates whether the change control was flagged to start (`start.value` set to `true`) or stop (`start.value` set to `false`) execution.
status	ChangeControlStatus	status is the execution status of the change control.
error	google.protobuf.StringValue	error is any error that occurred during the execution of the change control.
schedule	TimestampFlag	schedule indicates whether the change control was flagged to be scheduled (`schedule.value` set to some timestamp) or unscheduled (`schedule.value` set to `nil`) for execution.
device_ids	fmp.RepeatedString	device_ids is a list of device IDs on which the change control will operate.
device_id_to_stage_ids	DeviceToStageMap	device_id_to_stage_ids is a map of device IDs to the stages present in the specified Change state. This is not affected by the device ID based custom filtering and will contain info about all the devices associated with a CC ID.

ChangeControlConfig

ChangeControlConfig holds the configuration of a change control.

Field Name	Type	Description
key	ChangeControlKey	key uniquely identifies the change control.
change	ChangeConfig	change is the change subject to execution.
start	FlagConfig	start is the flag to start (`start.value` set to `true`) or stop (`start.value` set to `false`) execution of the change control.
schedule	TimestampFlagConfig	schedule is the flag to schedule (`schedule.value` set to some timestamp) or unschedule (`schedule.value` set to `nil`) the change control for execution.

ChangeControlKey

ChangeControlKey uniquely identifies a change control.

Field Name	Type	Description
id	google.protobuf.StringValue	id is the ID of the change control.

DeviceToStageMap

DeviceToStageMap is a map of a device ID and its list of corresponding stages.

Field Name	Type	Description
values	DeviceToStageMap.ValuesEntry[...]	values maps the device ID with the stages which are associated with a device in a changecontrol state model.

Field Name

Type

Description

values

DeviceToStageMap.ValuesEntry[...]

values maps the device ID with the stages which are associated with a device

in a changecontrol state model.

DeviceToStageMap.ValuesEntry

Field Name	Type	Description
key	string
value	fmp.RepeatedString

Filter

Filter is used to filter changecontrols for requested device ids.

Field Name	Type	Description
device_ids	fmp.RepeatedString	device_ids includes the list of device ids to be matched with devices in the changecontrol state model. At least one of the provided device ids must be present in CC devices field.

Field Name

Type

Description

device_ids

fmp.RepeatedString

device_ids includes the list of device ids to be matched with devices

in the changecontrol state model.

At least one of the provided device ids must be present in CC devices field.

Flag

Flag holds the configuration of a boolean flag plus some information about when and by whom it was set.

Field Name	Type	Description
value	google.protobuf.BoolValue	value is the value of the flag (`true` or `false`).
notes	google.protobuf.StringValue	notes are any notes associated with the setting of the flag.
time	google.protobuf.Timestamp	time is the time at which the flag was last updated.
user	google.protobuf.StringValue	user is the user by which the flag was last updated.

FlagConfig

FlagConfig is used to set a flag on a change control that takes a boolean value (e.g. start/stop, approve/unapprove).

Field Name	Type	Description
value	google.protobuf.BoolValue	value is the value of the flag (`true` or `false`).
notes	google.protobuf.StringValue	notes are any notes associated with the flag value.

RepeatedRepeatedString

RepeatedRepeatedString wraps a repeated fmp.RepeatedString to define a string matrix which is used to represent stage rows (see StageConfig).

Field Name	Type	Description
values	fmp.RepeatedString[...]	values is a list of `fmp.RepeatedString`.

Stage

Stage holds the configuration and status of a stage.

Field Name	Type	Description
name	google.protobuf.StringValue	name is the name of the stage.
action	Action	action is the action to perform during the stage.
rows	RepeatedRepeatedString	rows is a series of rows of parallel stages referenced by ID. See `StageConfig.rows` for more details.
status	StageStatus	status is the execution status of the stage.
error	google.protobuf.StringValue	error is any error that occured during the execution of the stage.
start_time	google.protobuf.Timestamp	start_time is the time when status change to Running.
end_time	google.protobuf.Timestamp	end_time is the time when status change to Completed.
steps	ActionSteps	steps represent the granular steps and their statuses associated with the action performed in the change control stage. Each stage generally defines either an action or a series of sub-stages.

StageConfig

StageConfig holds a configuration for a stage in a change control. Each stage generally defines either an action or a series of sub-stages.

Field Name Type Description

name

google.protobuf.StringValue

name is the name of the stage.

action

Action

action is the action to perform on stage execution.

rows

RepeatedRepeatedString

rows is a series of rows of parallel stages referenced

by ID. Each row is run one after the other and the

stages within each row are run in parallel.

For example:

</p><p>[["1a", "1b"], ["2"]]</p><p>

This configures stage 1a and stage 1b to run at the

same time, and then stage 2 once both of them have

completed.

StageConfigMap

StageConfigMap wraps a map from stage ID to StageConfig. This defines the configuration and order of execution for the stages in a change control.

For example:

{
    "root": { name: "root", rows: [["1-2"], ["3"]] },
    "1-2":  { name: "stages 1-2", rows: [["1"], ["2"]] },
    "1":    { name: "stage 1", rows: [["1a", "1b"]] },
    "1a":   { name: "stage 1a", action: { name: "task", args: { "TaskID": "101" } },
    "1b":   { name: "stage 1b", action: { name: "task", args: { "TaskID": "102" } },
    "2":    { name: "stage 2", action: { name: "task", args: { "TaskID": "103" } },
    "3":    { name: "stage 3", action: { name: "task", args: { "TaskID": "104" } }
}

Assuming the root stage ID of the enclosing change control is "root", this would mean to do the following in sequence:

root
|- stages 1-2
|  |- stage 1
|  |  |- stage 1a, stage 1b (parallel)
|  |- stage 2
|- stage 3

That is, execute tasks 101 and 102 in parallel, then task 103, then task 104.

Field Name	Type	Description
values	StageConfigMap.ValuesEntry[...]	values is a map from stage ID to `StageConfig`.

StageConfigMap.ValuesEntry

Field Name	Type	Description
key	string
value	StageConfig

StageMap

StageMap is a map from stage ID to Stage. This has essentially the same structure as StageConfigMap, but with each ID mapping to a Stage instead of StageConfig.

Field Name	Type	Description
values	StageMap.ValuesEntry[...]	values is a map from stage ID to `Stage`.

StageMap.ValuesEntry

Field Name	Type	Description
key	string
value	Stage

StepInfo

StepInfo contains the status details of an action step.

Field Name	Type	Description
name	google.protobuf.StringValue	name represents the name of the step.
status	StepStatus	status represents the present execution status of the step.
error	google.protobuf.StringValue	error captures any error that occurred.
message	google.protobuf.StringValue	message represents any relevant information associated with the step.

TimestampFlag

TimestampFlag holds the configuration of a timestamp flag plus some information about when and by whom is was set.

Field Name	Type	Description
value	google.protobuf.Timestamp	value is the value of the flag (some timestamp).
notes	google.protobuf.StringValue	notes are any notes associated with the setting of the flag.
time	google.protobuf.Timestamp	time is the time at which the flag was last updated.
user	google.protobuf.StringValue	user is the user by which the flag was last updated.

TimestampFlagConfig

TimestampFlagConfig is used to set a flag on a change control that takes a timestamp value (e.g. schedule/unschedule).

Field Name	Type	Description
value	google.protobuf.Timestamp	value is the value of the flag (some timestamp).
notes	google.protobuf.StringValue	notes are the notes associated with the flag value.

ChangeControlStatus

ChangeControlStatus defines the possible execution statuses of a change control.

Name	Number	Description
CHANGE_CONTROL_STATUS_UNSPECIFIED	0	CHANGE_CONTROL_STATUS_UNSPECIFIED means the change control status is unknown.
CHANGE_CONTROL_STATUS_RUNNING	1	CHANGE_CONTROL_STATUS_RUNNING means the change control has begun execution.
CHANGE_CONTROL_STATUS_COMPLETED	2	CHANGE_CONTROL_STATUS_COMPLETED means the change control has ceased execution. Success/failure of a change control cannot be inferred from this status alone but rather this status plus the change control error. That is, no error implies success and some error implies failure.
CHANGE_CONTROL_STATUS_SCHEDULED	3	CHANGE_CONTROL_STATUS_SCHEDULED means the change control has been scheduled for execution at some time. Any failure that occurs during this process will cause a transition back to the unspecified status, a reset of the schedule flag by the system, and an error on the change control reporting the details of the failure.
CHANGE_CONTROL_STATUS_NOT_STARTED	4	CHANGE_CONTROL_STATUS_NOT_STARTED means the change control has not been started. This would include approved and not approved change controls.

StageStatus

StageStatus defines the possible execution statuses of a stage.

Name	Number	Description
STAGE_STATUS_UNSPECIFIED	0	STAGE_STATUS_UNSPECIFIED means unknown stage status.
STAGE_STATUS_RUNNING	1	STAGE_STATUS_RUNNING means the stage has begun execution.
STAGE_STATUS_COMPLETED	2	STAGE_STATUS_COMPLETED means the stage has ceased execution. Success/failure of a stage cannot be inferred from this status alone but rather this status plus the stage error. That is, no error implies success and some error implies failure.
STAGE_STATUS_NOT_STARTED	3	STAGE_STATUS_NOT_STARTED means the stage has not been started.

StepStatus

StepStatus defines the possible execution statuses of a step within an action.

Name	Number	Description
STEP_STATUS_UNSPECIFIED	0	STEP_STATUS_UNSPECIFIED represents an unspecified state for a step within an action.
STEP_STATUS_NOT_STARTED	1	STEP_STATUS_NOT_STARTED represents that the step has not started execution.
STEP_STATUS_RUNNING	2	STEP_STATUS_RUNNING represents that the step is under execution.
STEP_STATUS_FINISHED	3	STEP_STATUS_FINISHED represents that the step has finished execution.
STEP_STATUS_SKIPPED	4	STEP_STATUS_SKIPPED represents that the step has been skipped from execution.
STEP_STATUS_FAILED	5	STEP_STATUS_FAILED represents that the step has failed its execution.

Top

arista/changecontrol.v1/services.gen.proto

ApproveConfigBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ApproveConfig[...]	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 ApproveConfig at end. * Each ApproveConfig response is fully-specified (all fields set). * start: Returns the state of each ApproveConfig at start, followed by updates until now. * Each ApproveConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApproveConfig at start, followed by updates until end. * Each ApproveConfig 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.

Field Name

Type

Description

partial_eq_filter

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 ApproveConfig at end.

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

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

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

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

until end.

* Each ApproveConfig 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.

ApproveConfigBatchedStreamResponse

Field Name	Type	Description
responses	ApproveConfigStreamResponse[...]	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).

Field Name

Type

Description

responses

ApproveConfigStreamResponse[...]

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

ApproveConfigDeleteAllRequest

Field Name	Type	Description
partial_eq_filter	ApproveConfig[...]	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.

Field Name

Type

Description

partial_eq_filter

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.

ApproveConfigDeleteAllResponse

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	ChangeControlKey	This is the key of the ApproveConfig instance that failed to be deleted.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp when the key was being deleted.

ApproveConfigDeleteRequest

Field Name	Type	Description
key	ChangeControlKey	Key indicates which ApproveConfig instance to remove. This field must always be set.

Field Name

Type

Description

key

Key indicates which ApproveConfig instance to remove.

This field must always be set.

ApproveConfigDeleteResponse

Field Name	Type	Description
key	ChangeControlKey	Key echoes back the key of the deleted ApproveConfig 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.

Field Name

Type

Description

key

Key echoes back the key of the deleted ApproveConfig 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.

ApproveConfigDeleteSomeRequest

Field Name	Type	Description
keys	ChangeControlKey[...]	key contains a list of ApproveConfig keys to delete

ApproveConfigDeleteSomeResponse

ApproveConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ChangeControlKey
error	string

ApproveConfigRequest

Field Name	Type	Description
key	ChangeControlKey	Key uniquely identifies a ApproveConfig 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.

Field Name

Type

Description

key

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

ApproveConfigResponse

Field Name	Type	Description
value	ApproveConfig	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 ApproveConfig instance in this response.

Field Name

Type

Description

value

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

ApproveConfig instance in this response.

ApproveConfigSetRequest

Field Name	Type	Description
value	ApproveConfig	ApproveConfig carries the value to set into the datastore. See the documentation on the ApproveConfig struct for which fields are required.

Field Name

Type

Description

value

ApproveConfig carries the value to set into the datastore.

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

ApproveConfigSetResponse

Field Name	Type	Description
value	ApproveConfig	Value carries all the values given in the ApproveConfigSetRequest 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.

Field Name

Type

Description

value

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

ApproveConfigSetSomeRequest

Field Name	Type	Description
values	ApproveConfig[...]	value contains a list of ApproveConfig 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.

Field Name

Type

Description

values

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

ApproveConfigSetSomeResponse

Field Name	Type	Description
key	ChangeControlKey
error	string

ApproveConfigSomeRequest

Field Name	Type	Description
keys	ChangeControlKey[...]
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.

Field Name

Type

Description

keys

ChangeControlKey[...]

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.

ApproveConfigSomeResponse

Field Name	Type	Description
value	ApproveConfig	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

Field Name

Type

Description

value

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

ApproveConfigStreamRequest

Field Name	Type	Description
partial_eq_filter	ApproveConfig[...]	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 ApproveConfig at end. * Each ApproveConfig response is fully-specified (all fields set). * start: Returns the state of each ApproveConfig at start, followed by updates until now. * Each ApproveConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApproveConfig at start, followed by updates until end. * Each ApproveConfig response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

Field Name

Type

Description

partial_eq_filter

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 ApproveConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

ApproveConfigStreamResponse

Field Name	Type	Description
value	ApproveConfig	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 ApproveConfig's last modification.
type	arista.subscriptions.Operation	Operation indicates how the ApproveConfig 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.

Field Name

Type

Description

value

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 ApproveConfig's last modification.

type

arista.subscriptions.Operation

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

ChangeControlBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ChangeControl[...]	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.
filter	Filter	For each ChangeControl in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ChangeControl is streamed to the user.
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 ChangeControl at end. * Each ChangeControl response is fully-specified (all fields set). * start: Returns the state of each ChangeControl at start, followed by updates until now. * Each ChangeControl response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ChangeControl at start, followed by updates until end. * Each ChangeControl 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.

ChangeControlBatchedStreamResponse

Field Name	Type	Description
responses	ChangeControlStreamResponse[...]	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).

Field Name

Type

Description

responses

ChangeControlStreamResponse[...]

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

ChangeControlConfigBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	ChangeControlConfig[...]	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 ChangeControlConfig at end. * Each ChangeControlConfig response is fully-specified (all fields set). * start: Returns the state of each ChangeControlConfig at start, followed by updates until now. * Each ChangeControlConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ChangeControlConfig at start, followed by updates until end. * Each ChangeControlConfig 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.

Field Name

Type

Description

partial_eq_filter

ChangeControlConfig[...]

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 ChangeControlConfig at end.

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

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

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

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

until end.

* Each ChangeControlConfig 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.

ChangeControlConfigBatchedStreamResponse

Field Name	Type	Description
responses	ChangeControlConfigStreamResponse[...]	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).

Field Name

Type

Description

responses

ChangeControlConfigStreamResponse[...]

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

ChangeControlConfigDeleteAllRequest

Field Name	Type	Description
partial_eq_filter	ChangeControlConfig[...]	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.

Field Name

Type

Description

partial_eq_filter

ChangeControlConfig[...]

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.

ChangeControlConfigDeleteAllResponse

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	ChangeControlKey	This is the key of the ChangeControlConfig instance that failed to be deleted.
time	google.protobuf.Timestamp	Time indicates the (UTC) timestamp when the key was being deleted.

ChangeControlConfigDeleteRequest

Field Name

Type

Description

key

Key indicates which ChangeControlConfig instance to remove.

This field must always be set.

ChangeControlConfigDeleteResponse

Field Name

Type

Description

key

Key echoes back the key of the deleted ChangeControlConfig 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.

ChangeControlConfigDeleteSomeRequest

Field Name	Type	Description
keys	ChangeControlKey[...]	key contains a list of ChangeControlConfig keys to delete

ChangeControlConfigDeleteSomeResponse

ChangeControlConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ChangeControlKey
error	string

ChangeControlConfigRequest

Field Name

Type

Description

key

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

ChangeControlConfigResponse

Field Name

Type

Description

value

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

ChangeControlConfig instance in this response.

ChangeControlConfigSetRequest

Field Name

Type

Description

value

ChangeControlConfig carries the value to set into the datastore.

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

ChangeControlConfigSetResponse

Field Name

Type

Description

value

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

ChangeControlConfigSetSomeRequest

Field Name

Type

Description

values

ChangeControlConfig[...]

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

ChangeControlConfigSetSomeResponse

Field Name	Type	Description
key	ChangeControlKey
error	string

ChangeControlConfigSomeRequest

Field Name

Type

Description

keys

ChangeControlKey[...]

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.

ChangeControlConfigSomeResponse

Field Name

Type

Description

value