action.v1

Version: 1.5.0

Available Services

    ActionArgConfigService

    ActionConfigService

    ActionRunConfigService

    ActionRunService

    ActionService

• arista/action.v1/action.proto

  • Action

  • ActionArgConfig

  • ActionArgDefinition

  • ActionArgValue

  • ActionArgValues

  • ActionArgValues.ValuesEntry

  • ActionAudit

  • ActionConfig

  • ActionCore

  • ActionKey

  • ActionRun

  • ActionRunConfig

  • ActionRunKey

  • ActionSchema

  • ActionSchema.ValuesEntry

  • ActionLanguage

  • ActionType

• arista/action.v1/services.gen.proto

  • ActionArgConfigDeleteAllRequest

  • ActionArgConfigDeleteAllResponse

  • ActionArgConfigDeleteRequest

  • ActionArgConfigDeleteResponse

  • ActionArgConfigDeleteSomeRequest

  • ActionArgConfigDeleteSomeResponse

  • ActionArgConfigRequest

  • ActionArgConfigResponse

  • ActionArgConfigSetRequest

  • ActionArgConfigSetResponse

  • ActionArgConfigSetSomeRequest

  • ActionArgConfigSetSomeResponse

  • ActionArgConfigSomeRequest

  • ActionArgConfigSomeResponse

  • ActionArgConfigStreamRequest

  • ActionArgConfigStreamResponse

  • ActionConfigDeleteAllRequest

  • ActionConfigDeleteAllResponse

  • ActionConfigDeleteRequest

  • ActionConfigDeleteResponse

  • ActionConfigDeleteSomeRequest

  • ActionConfigDeleteSomeResponse

  • ActionConfigRequest

  • ActionConfigResponse

  • ActionConfigSetRequest

  • ActionConfigSetResponse

  • ActionConfigSetSomeRequest

  • ActionConfigSetSomeResponse

  • ActionConfigSomeRequest

  • ActionConfigSomeResponse

  • ActionConfigStreamRequest

  • ActionConfigStreamResponse

  • ActionRequest

  • ActionResponse

  • ActionRunConfigDeleteAllRequest

  • ActionRunConfigDeleteAllResponse

  • ActionRunConfigDeleteRequest

  • ActionRunConfigDeleteResponse

  • ActionRunConfigDeleteSomeRequest

  • ActionRunConfigDeleteSomeResponse

  • ActionRunConfigRequest

  • ActionRunConfigResponse

  • ActionRunConfigSetRequest

  • ActionRunConfigSetResponse

  • ActionRunConfigSetSomeRequest

  • ActionRunConfigSetSomeResponse

  • ActionRunConfigSomeRequest

  • ActionRunConfigSomeResponse

  • ActionRunConfigStreamRequest

  • ActionRunConfigStreamResponse

  • ActionRunRequest

  • ActionRunResponse

  • ActionRunSomeRequest

  • ActionRunSomeResponse

  • ActionRunStreamRequest

  • ActionRunStreamResponse

  • ActionSomeRequest

  • ActionSomeResponse

  • ActionStreamRequest

  • ActionStreamResponse

  • MetaResponse

  • ActionArgConfigService

  • ActionConfigService

  • ActionRunConfigService

  • ActionRunService

  • ActionService

Top

arista/action.v1/action.proto

Action

Action is the state model of an action.

Field Name	Type	Description
key	ActionKey	key uniquely identifies the action.
core	ActionCore	core contains some common attributes (state/config) of the action.
audit	ActionAudit	audit contains meta information about the action.
language	ActionLanguage	language specifies the language of the action body, if applicable.
body	google.protobuf.StringValue	body contains the action code (script), if applicable.

ActionArgConfig

ActionArgConfig is the model for the definition of static arguments

Field Name	Type	Description
key	ActionKey	key uniquely identifies the action to which the arguments apply.
static_args	ActionArgValues	static_args contains the arguments that are to be applied to all subsequent runs of the action. Argument names and values must adhere to the ActionSchema static_args. When retrieving values of the arguments that had been set, but which are defined as hidden in ActionSchema static_args, fake hardcoded values are returned instead of the real values.

ActionArgDefinition

ActionArgDefinition is the definition of an argument (static or dynamic).

Field Name	Type	Description
required	google.protobuf.BoolValue	required indicates that this argument must always be set when calling the action.
default	ActionArgValue	default is the default value for this argument. If set to null, there is no default value.
description	google.protobuf.StringValue	description is a user-friendly description of the argument.
hidden	google.protobuf.BoolValue	hidden can be set to true to indicate that the value of this argument can be set, but not retrieved from this API.

ActionArgValue

ActionArgValue contains the value of one argument of an action.

Field Name	Type	Description
value	google.protobuf.StringValue	value is the string value to set the argument for runtime.

ActionArgValues

ActionArgValues contains the values of the arguments of an action.

Field Name	Type	Description
values	ActionArgValues.ValuesEntry[...]	values is a map of arg name to value.

ActionArgValues.ValuesEntry

Field Name	Type	Description
key	string
value	ActionArgValue

ActionAudit

ActionAudit contains additional information for the Action state model.

Field Name	Type	Description
created_at	google.protobuf.Timestamp	created_at records the time when the action was originally created.
created_by	google.protobuf.StringValue	created_by records the user who created the action.
last_modified_at	google.protobuf.Timestamp	last_modified_at records the time when the action was most recently modified.
last_modified_by	google.protobuf.StringValue	last_modified_by records the user who most recently modified the action.
from_package	google.protobuf.StringValue	from_package indicates that this action was created by a package, and can only be modified by the packaging service.

ActionConfig

ActionConfig is the config of an action. Unimplemented for builtin actions

Field Name	Type	Description
key	ActionKey	key uniquely identifies the action.
core	ActionCore	core contains some common attributes (state/config) of the action.
language	ActionLanguage	language specifies the language of the action body, if applicable.
body	google.protobuf.StringValue	body contains the action code (script), if applicable.

ActionCore

ActionCore contains the core fields of an action.

Field Name	Type	Description
name	google.protobuf.StringValue	name is the user-friendly name of the action.
type	ActionType	type is the specific type of the action.
description	google.protobuf.StringValue	description is a user-friendly description of the action.
static_args	ActionSchema	static_args defines arguments which can be permanently changed for subsequent runs of this action (set ActionArgConfig to accomplish that). The names of arguments in static_args cannot also appear in dynamic_args.
dynamic_args	ActionSchema	dynamic_args defines arguments which are scoped to a specific run of the action. The names of arguments in dynamic_args cannot also appear in static_args.

ActionKey

ActionKey is the model key of an action.

Field Name	Type	Description
id	google.protobuf.StringValue	id uniquely identifies the action. Although chosen by the caller, it is recommended to be a random UUID.

ActionRun

ActionRun is the state of a single run (single execution) of an action.

Field Name	Type	Description
key	ActionRunKey	key uniquely identifies the ActionRun and the corresponding ActionRunConfig.
action_id	google.protobuf.StringValue	action_id uniquely identifies the Action being run.
created_at	google.protobuf.Timestamp	created_at records the time when the action run has been requested.
created_by	google.protobuf.StringValue	created_by records the user who requested the action execution.
finished_at	google.protobuf.Timestamp	finished_at records the time when the action finished running.
is_finished	google.protobuf.BoolValue	is_finished is true only when the action has finished running and the fields code, output, error, and finished_at are assigned their final values.
code	google.protobuf.Int32Value	code contains the exit code of the action. The code may be ignored if error is empty or nil.
output	google.protobuf.StringValue	output contains the output produced by the action, truncated to the first 100,000 bytes.
error	google.protobuf.StringValue	error contains a failure description for unsuccessful runs, either caused by the body or by the execution environment. Often it is a python traceback which contains multiple newline characters. Maximum size is 100,000 bytes.

ActionRunConfig

ActionRunConfig is the configuration of a single execution of an action. Creating a record under a new key triggers a run. Attempting to set again an existing entry is an error.

Field Name	Type	Description
key	ActionRunKey	key uniquely identifies the ActionRunConfig and the corresponding ActionRun.
action_id	google.protobuf.StringValue	action_id uniquely identifies the Action being run.
dynamic_args	ActionArgValues	dynamic_args contains the values of dynamic arguments defined for the action.

ActionRunKey

ActionRunKey is the model key that can uniquely identify an action run.

Field Name	Type	Description
run_id	google.protobuf.StringValue	run_id uniquely identifies an action run

ActionSchema

ActionSchema is the schema of an action. Corresponds to the definition of multiple arguments.

Field Name	Type	Description
values	ActionSchema.ValuesEntry[...]	values is a map of argument name to its defintion.

ActionSchema.ValuesEntry

Field Name	Type	Description
key	string
value	ActionArgDefinition

ActionLanguage

ActionLanguage is the language of an action.

Name	Number	Description
ACTION_LANGUAGE_UNSPECIFIED	0	ACTION_LANGUAGE_UNSPECIFIED is the default value for this type.
ACTION_LANGUAGE_PYTHON_2	1	ACTION_LANGUAGE_PYTHON_2 indicates that the action body follows Python 2.x syntax.
ACTION_LANGUAGE_PYTHON_3	2	ACTION_LANGUAGE_PYTHON_3 indicates that the action body follows Python 3.x syntax.
ACTION_LANGUAGE_GO_TEMPLATE	3	ACTION_LANGUAGE_GO_TEMPLATE indicates that the action body is a Go language template (e.g. as used in ZTP).

ActionType

ActionType is the type of an action.

Name	Number	Description
ACTION_TYPE_UNSPECIFIED	0	ACTION_TYPE_UNSPECIFIED is the default value for this type.
ACTION_TYPE_CHANGECONTROL_CUSTOM	1	ACTION_TYPE_CHANGECONTROL_CUSTOM indicates a scripted action that can be used as part of a change control.
ACTION_TYPE_CHANGECONTROL_BUILT_IN	2	ACTION_TYPE_CHANGECONTROL_BUILT_IN indicates a built-in action with no scripted component which can be used as part of a change control.
ACTION_TYPE_STUDIO_AUTOFILL	3	ACTION_TYPE_STUDIO_AUTOFILL is an action which can be bound to an input in a studio.
ACTION_TYPE_PACKAGING_INSTALL_HOOK	4	ACTION_TYPE_PACKAGING_INSTALL_HOOK is a type of Action which can run during package lifecycle events (e.g. pre-install or post-uninstall) to handle any migration or configuration changes that need to happen for a Package to be (un)installed successfully.
ACTION_TYPE_ZTP_BOOTSTRAP	5	ACTION_TYPE_ZTP_BOOTSTRAP is a type of Action which can be used to bootstrap a device.
ACTION_TYPE_STUDIO_BUILD_HOOK	6	ACTION_TYPE_STUDIO_BUILD_HOOK is a type of Action which can run at various points in a workspace build pipeline (e.g. workspace pre-build, studio pre-render), facilitating customization of the workspace build beyond the standard process. Build hooks in a given stage can express dependencies on each other which allows ordering of the actions' execution. For ACTION_TYPE_STUDIO_BUILD_HOOK each hook invocation will provide the following arguments: * WorkspaceID (mandatory): the ID of the Workspace * StudioID (optional, if running in the context of a Studio): the ID of the Studio

Top

arista/action.v1/services.gen.proto

ActionArgConfigDeleteAllRequest

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

ActionArgConfigDeleteAllResponse

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

ActionArgConfigDeleteRequest

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

ActionArgConfigDeleteResponse

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

ActionArgConfigDeleteSomeRequest

Field Name	Type	Description
keys	ActionKey[...]	key contains a list of ActionArgConfig keys to delete

ActionArgConfigDeleteSomeResponse

ActionArgConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ActionKey
error	string

ActionArgConfigRequest

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

ActionArgConfigResponse

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

ActionArgConfigSetRequest

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

ActionArgConfigSetResponse

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

ActionArgConfigSetSomeRequest

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

ActionArgConfigSetSomeResponse

Field Name	Type	Description
key	ActionKey
error	string

ActionArgConfigSomeRequest

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

ActionArgConfigSomeResponse

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

ActionArgConfigStreamRequest

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

ActionArgConfigStreamResponse

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

ActionConfigDeleteAllRequest

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

ActionConfigDeleteAllResponse

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

ActionConfigDeleteRequest

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

ActionConfigDeleteResponse

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

ActionConfigDeleteSomeRequest

Field Name	Type	Description
keys	ActionKey[...]	key contains a list of ActionConfig keys to delete

ActionConfigDeleteSomeResponse

ActionConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ActionKey
error	string

ActionConfigRequest

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

ActionConfigResponse

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

ActionConfigSetRequest

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

ActionConfigSetResponse

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

ActionConfigSetSomeRequest

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

ActionConfigSetSomeResponse

Field Name	Type	Description
key	ActionKey
error	string

ActionConfigSomeRequest

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

ActionConfigSomeResponse

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

ActionConfigStreamRequest

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

ActionConfigStreamResponse

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

ActionRequest

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

ActionResponse

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

ActionRunConfigDeleteAllRequest

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

ActionRunConfigDeleteAllResponse

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

ActionRunConfigDeleteRequest

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

ActionRunConfigDeleteResponse

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

ActionRunConfigDeleteSomeRequest

Field Name	Type	Description
keys	ActionRunKey[...]	key contains a list of ActionRunConfig keys to delete

ActionRunConfigDeleteSomeResponse

ActionRunConfigDeleteSomeResponse is only sent when there is an error.

Field Name	Type	Description
key	ActionRunKey
error	string

ActionRunConfigRequest

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

ActionRunConfigResponse

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

ActionRunConfigSetRequest

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

ActionRunConfigSetResponse

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

ActionRunConfigSetSomeRequest

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

ActionRunConfigSetSomeResponse

Field Name	Type	Description
key	ActionRunKey
error	string

ActionRunConfigSomeRequest

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

ActionRunConfigSomeResponse

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

ActionRunConfigStreamRequest

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

ActionRunConfigStreamResponse

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

ActionRunRequest

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

ActionRunResponse

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

ActionRunSomeRequest

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

ActionRunSomeResponse

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

ActionRunStreamRequest

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

ActionRunStreamResponse

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

ActionSomeRequest

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

ActionSomeResponse

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

ActionStreamRequest

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

ActionStreamResponse

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

ActionArgConfigService

Method Name	Request Type	Response Type	Description
GetOne	ActionArgConfigRequest	ActionArgConfigResponse
GetSome	ActionArgConfigSomeRequest	ActionArgConfigSomeResponse stream
GetAll	ActionArgConfigStreamRequest	ActionArgConfigStreamResponse stream
Subscribe	ActionArgConfigStreamRequest	ActionArgConfigStreamResponse stream
GetMeta	ActionArgConfigStreamRequest	MetaResponse
SubscribeMeta	ActionArgConfigStreamRequest	MetaResponse stream
Set	ActionArgConfigSetRequest	ActionArgConfigSetResponse
SetSome	ActionArgConfigSetSomeRequest	ActionArgConfigSetSomeResponse stream
Delete	ActionArgConfigDeleteRequest	ActionArgConfigDeleteResponse
DeleteSome	ActionArgConfigDeleteSomeRequest	ActionArgConfigDeleteSomeResponse stream
DeleteAll	ActionArgConfigDeleteAllRequest	ActionArgConfigDeleteAllResponse stream

ActionConfigService

Method Name	Request Type	Response Type	Description
GetOne	ActionConfigRequest	ActionConfigResponse
GetSome	ActionConfigSomeRequest	ActionConfigSomeResponse stream
GetAll	ActionConfigStreamRequest	ActionConfigStreamResponse stream
Subscribe	ActionConfigStreamRequest	ActionConfigStreamResponse stream
GetMeta	ActionConfigStreamRequest	MetaResponse
SubscribeMeta	ActionConfigStreamRequest	MetaResponse stream
Set	ActionConfigSetRequest	ActionConfigSetResponse
SetSome	ActionConfigSetSomeRequest	ActionConfigSetSomeResponse stream
Delete	ActionConfigDeleteRequest	ActionConfigDeleteResponse
DeleteSome	ActionConfigDeleteSomeRequest	ActionConfigDeleteSomeResponse stream
DeleteAll	ActionConfigDeleteAllRequest	ActionConfigDeleteAllResponse stream

ActionRunConfigService

Method Name	Request Type	Response Type	Description
GetOne	ActionRunConfigRequest	ActionRunConfigResponse
GetSome	ActionRunConfigSomeRequest	ActionRunConfigSomeResponse stream
GetAll	ActionRunConfigStreamRequest	ActionRunConfigStreamResponse stream
Subscribe	ActionRunConfigStreamRequest	ActionRunConfigStreamResponse stream
GetMeta	ActionRunConfigStreamRequest	MetaResponse
SubscribeMeta	ActionRunConfigStreamRequest	MetaResponse stream
Set	ActionRunConfigSetRequest	ActionRunConfigSetResponse
SetSome	ActionRunConfigSetSomeRequest	ActionRunConfigSetSomeResponse stream
Delete	ActionRunConfigDeleteRequest	ActionRunConfigDeleteResponse
DeleteSome	ActionRunConfigDeleteSomeRequest	ActionRunConfigDeleteSomeResponse stream
DeleteAll	ActionRunConfigDeleteAllRequest	ActionRunConfigDeleteAllResponse stream

ActionRunService

Method Name	Request Type	Response Type	Description
GetOne	ActionRunRequest	ActionRunResponse
GetSome	ActionRunSomeRequest	ActionRunSomeResponse stream
GetAll	ActionRunStreamRequest	ActionRunStreamResponse stream
Subscribe	ActionRunStreamRequest	ActionRunStreamResponse stream
GetMeta	ActionRunStreamRequest	MetaResponse
SubscribeMeta	ActionRunStreamRequest	MetaResponse stream

ActionService

Method Name	Request Type	Response Type	Description
GetOne	ActionRequest	ActionResponse
GetSome	ActionSomeRequest	ActionSomeResponse stream
GetAll	ActionStreamRequest	ActionStreamResponse stream
Subscribe	ActionStreamRequest	ActionStreamResponse stream
GetMeta	ActionStreamRequest	MetaResponse
SubscribeMeta	ActionStreamRequest	MetaResponse stream