Version: trunk

workspace.v1

Version: 1.3.15

Available Services

WorkspaceBuildDetailsService

WorkspaceBuildService

WorkspaceConfigService

WorkspaceService

WorkspaceSyncConfigService

arista/workspace.v1/workspace.proto
arista/workspace.v1/services.gen.proto

Top

arista/workspace.v1/workspace.proto

AuthzResult

AuthzResult has the result of the authorization check for workspace changes.

Field Name	Type	Description
has_unauthorized_tag_change	google.protobuf.BoolValue	has_unauthorized_tag_change is true when there is a tag assignment that results in change in permissions and the subject is not authorized to do it.
has_unauthorized_device_change	google.protobuf.BoolValue	has_unauthorized_device_change is true when there is atleast 1 device for which the subject doesn't have provision permission.
error	google.protobuf.StringValue	error is an error message that is set when either of the above values are true.

Field Name

Type

Description

has_unauthorized_tag_change

google.protobuf.BoolValue

has_unauthorized_tag_change is true when there is a tag assignment that results

in change in permissions and the subject is not authorized to do it.

has_unauthorized_device_change

google.protobuf.BoolValue

has_unauthorized_device_change is true when there is atleast 1 device

for which the subject doesn't have provision permission.

error

google.protobuf.StringValue

error is an error message that is set when either of the above values

are true.

BuildStageState

BuildStageState holds the state per build stage.

Field Name	Type	Description
values	BuildStageState.ValuesEntry[...]	values is a map from build stage to build state. The possible keys to this map are BUILD_STAGE_UNSPECIFIED, BUILD_STAGE_INPUT_VALIDATION, BUILD_STAGE_CONFIGLET_BUILD, BUILD_STAGE_CONFIG_VALIDATION and BUILD_STAGE_IMAGE_VALIDATION.

Field Name

Type

Description

values

BuildStageState.ValuesEntry[...]

values is a map from build stage to build state.

The possible keys to this map are BUILD_STAGE_UNSPECIFIED,

BUILD_STAGE_INPUT_VALIDATION, BUILD_STAGE_CONFIGLET_BUILD,

BUILD_STAGE_CONFIG_VALIDATION and BUILD_STAGE_IMAGE_VALIDATION.

BuildStageState.ValuesEntry

Field Name	Type	Description
key	string
value	BuildState

ConfigSyncResult

ConfigSyncResult holds the result of config sync operation.

Field Name	Type	Description
summary	arista.configstatus.v1.ConfigSummary	summary is a summary of the changes to the running config.
errors	arista.configstatus.v1.ConfigErrors	errors are any errors detected during sync.
config_sources	arista.configstatus.v1.ConfigSources	config_sources identify the entities that generated the designed config.

ConfigValidationResult

ConfigValidationResult holds the result of a config validation stage.

Field Name	Type	Description
summary	arista.configstatus.v1.ConfigSummary	summary is a summary of the changes to the previous config.
errors	arista.configstatus.v1.ConfigErrors	errors are any errors detected in the generated config.
warnings	arista.configstatus.v1.ConfigErrors	warnings are any warnings about the generated config.
config_sources	arista.configstatus.v1.ConfigSources	config_sources identify the entities that generated the config.
only_filter_inputs_changed	google.protobuf.BoolValue	only_filter_inputs_changed indicates there is a change in filters but no change in the config or no config sources found.

ConfigletBuildResult

ConfigletBuildResult holds the result of a configlet build stage.

Field Name	Type	Description
template_errors	TemplateErrors	template_errors are errors that occured during studio template evaluation.
generated_config	google.protobuf.StringValue	generated_config is the EOS CLI config that was generated from the stage.
other_error	google.protobuf.StringValue	other_error is any other miscellaneous error.
execution_id	google.protobuf.StringValue	execution_id is the unique ID for the execution of the template. This ID can be used to retrieve logs generated by the template.
input_errors	InputErrors	input_errors are errors in input fields that are raised by the template.

ConfigletBuildResults

ConfigletBuildResults is a collection of ConfigletBuildResult (one per studio).

Field Name	Type	Description
values	ConfigletBuildResults.ValuesEntry[...]	values is a map from studio ID to ConfigletBuildResult.

ConfigletBuildResults.ValuesEntry

Field Name	Type	Description
key	string
value	ConfigletBuildResult

HierarchyBuildStatus

HierarchyBuildStatus reference to the hierarchy build part of this workspace build

Field Name	Type	Description
build_id	google.protobuf.StringValue	build_id is the reference to the hierarchy build. It uniquely identifies the hierarchy build
build_status	HierarchyBuildStatusCode	build_status ststus of the build on its completion

Field Name

Type

Description

build_id

google.protobuf.StringValue

build_id is the reference to the hierarchy build.

It uniquely identifies the hierarchy build

build_status

HierarchyBuildStatusCode

build_status ststus of the build on its completion

ImageValidationResult

ImageValidationResult holds the result of an image validation stage.

Field Name	Type	Description
summary	arista.imagestatus.v1.ImageSummary	summary is a summary of the changes to the previous image.
errors	arista.imagestatus.v1.ImageErrors	errors are any errors detected in the generated image.
warnings	arista.imagestatus.v1.ImageWarnings	warnings are any warnings about the generated image.
image_input_error	google.protobuf.StringValue	image_input_error indicates any errors in image inputs.
infos	arista.imagestatus.v1.ImageInfos	infos are any info messages about the generated image.

InputError

InputError holds the details for an error on a studio input field or value.

Field Name	Type	Description
field_id	google.protobuf.StringValue	field_id is the ID of the input field.
path	fmp.RepeatedString	path is the path leading up to the input field.
members	fmp.RepeatedString	members are the members of the input field (if it is a group).
message	google.protobuf.StringValue	message is the error message.

InputErrors

InputErrors is a list of InputError.

Field Name	Type	Description
values	InputError[...]	values is a list of InputError.

InputValidationResult

InputValidationResult holds the result of an input validation build stage.

Field Name	Type	Description
input_schema_errors	InputErrors	input_schema_errors are errors for fields in the input schema.
input_value_errors	InputErrors	input_value_errors are errors for values assigned to fields in the input schema.
other_errors	fmp.RepeatedString	other_errors are other miscellaneous errors.
input_warnings	InputWarnings	input_warnings are warnings for values assigned to fields in the input schema.

InputValidationResults

InputValidationResults is a collection of InputValidationResult (one per studio).

Field Name	Type	Description
values	InputValidationResults.ValuesEntry[...]	values is map from studio ID to InputValidationResult.

InputValidationResults.ValuesEntry

Field Name	Type	Description
key	string
value	InputValidationResult

InputWarning

InputWarning holds the details for a warning on a studio input field or value.

Field Name	Type	Description
field_id	google.protobuf.StringValue	field_id is the ID of the input field.
path	fmp.RepeatedString	path is the path leading up to the input field.
members	fmp.RepeatedString	members are the members of the input field (if it is a group).
message	google.protobuf.StringValue	message is the warning message.

InputWarnings

InputWarnings is a list of InputWarning.

Field Name	Type	Description
values	InputWarning[...]	values is a list of InputWarning.

RequestParams

RequestParams define the parameters for a Request.

Field Name	Type	Description
request_id	google.protobuf.StringValue	request_id is the unique ID of the request. This is used to identify the Response for the request in Responses.

Field Name

Type

Description

request_id

google.protobuf.StringValue

request_id is the unique ID of the request. This is used to identify

the Response for the request in Responses.

Response

Response is a response to a Request.

Field Name	Type	Description
status	ResponseStatus	status is the execution status of the response.
message	google.protobuf.StringValue	message is a string that provides more details about the response.
code	ResponseCode	code is the code of the response.

Responses

Responses is a collection of responses for completed requests.

Field Name	Type	Description
values	Responses.ValuesEntry[...]	values is a map from request ID to Response.

Responses.ValuesEntry

Field Name	Type	Description
key	string
value	Response

StudioBuildDetails

StudioBuildDetails is a collection of per studio results that are not specific to a device.

Field Name	Type	Description
input_validation_results	InputValidationResults	input_validation_results is a map from studio ID to InputValidationResult.

TemplateError

TemplateError holds details for an error that occured while evaluating a studio template against its inputs.

Field Name	Type	Description
line_num	google.protobuf.UInt32Value	line_num is the number of the line on which the error occurred.
exception	google.protobuf.StringValue	exception is the type of the exception thrown during the script execution. E.g., AssertionError, etc.
detail	google.protobuf.StringValue	detail holds the details of the exception. E.g., a full backtrace.
exception_msg	google.protobuf.StringValue	exception_msg is the message of the exception thrown during the script execution.

TemplateErrors

TemplateErrors is a list of TemplateError.

Field Name	Type	Description
values	TemplateError[...]	values is a list of TemplateError.

Workspace

Workspace holds the status of a workspace.

Field Name	Type	Description
key	WorkspaceKey	key identifies the workspace.
created_at	google.protobuf.Timestamp	created_at indicates when the workspace was created.
created_by	google.protobuf.StringValue	created_by indicates who created the workspace.
last_modified_at	google.protobuf.Timestamp	last_modified_at indicates when the workspace was last updated.
last_modified_by	google.protobuf.StringValue	last_modified_by indicates who last updated the workspace.
state	WorkspaceState	state describes the status of the workspace.
last_build_id	google.protobuf.StringValue	last_build_id is the last build ID that was set in a WorkspaceBuild for this workspace.
responses	Responses	responses are the responses for all requests that have been executed thusfar for this workspace.
cc_ids	fmp.RepeatedString	cc_ids are the IDs of any change controls that were created as a result of submitting this workspace.
needs_build	google.protobuf.BoolValue	needs_build indicates whether a rebuild of the workspace is necessary in order to submit it.
last_rebased_at	google.protobuf.Timestamp	last_rebased_at indicates when the workspace was last rebased.
needs_rebase	google.protobuf.BoolValue	needs_rebase indicates whether a rebase of the workspace is necessary in order to submit it.
display_name	google.protobuf.StringValue	display_name is the user-defined name of the workspace.
description	google.protobuf.StringValue	description is a brief description of the workspace.
exclude_network_provisioning	google.protobuf.BoolValue	exclude_network_provisioning indicates whether the workspace is configured to exclude Network Provisioning.

WorkspaceBuild

WorkspaceBuild holds the details for a build of a workspace.

Field Name	Type	Description
key	WorkspaceBuildKey	key identifies the build.
state	BuildState	state is the execution status of the build.
error	google.protobuf.StringValue	error is an error message that is set if the build fails early before the per-device build result is computed.
built_by	google.protobuf.StringValue	built_by is the details of subject who built the workspace.
authz_result	AuthzResult	authz_result has the result of authorization check.
studio_build_details	StudioBuildDetails	studio_build_details has per studio results that are not specific to a device.
hierarchy_build_status	HierarchyBuildStatus	hierarchy_build_status from the hierarchy build part of this workspace build

WorkspaceBuildDetails

WorkspaceBuildDetails holds the details for a build of a device in a workspace.

Field Name	Type	Description
key	WorkspaceBuildDetailsKey	key identifies the build.
state	BuildState	state is the execution status of the build.
stage	BuildStage	stage is the stage of the build.
input_validation_results	InputValidationResults	input_validation_results are the results of the input validation stage.
configlet_build_results	ConfigletBuildResults	configlet_build_results are the results of the configlet build stage.
config_validation_result	ConfigValidationResult	config_validation_result is the result of the config validation stage.
image_validation_result	ImageValidationResult	image_validation_result is the result of the image validation stage.
config_validation_skip_cause	ConfigValidationSkipCause	config_validation_skip_cause is the reason, if any, that the config validation stage was skipped.
image_validation_skip_cause	ImageValidationSkipCause	image_validation_skip_cause is the reason, if any, that the image validation stage was skipped.
build_stage_state	BuildStageState	build_stage_state is the state for each build stage.
authz_status	DeviceAuthzStatus	authz_status is the status of provision permission for the device.
config_sync_result	ConfigSyncResult	config_sync_result is the result of the config sync.
config_sync_skip_cause	ConfigSyncSkipCause	config_sync_skip_cause is the reason for skipping the config sync.

WorkspaceBuildDetailsKey

WorkspaceBuildDetailsKey uniquely identifies a build for a particular device in a workspace.

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id is the ID of the workspace.
build_id	google.protobuf.StringValue	build_id is the ID of the build.
device_id	google.protobuf.StringValue	device_id is the ID of the device.

WorkspaceBuildKey

WorkspaceBuildKey uniquely identifies a build for a workspace.

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id is the ID of the workspace.
build_id	google.protobuf.StringValue	build_id is the ID of the build.

WorkspaceConfig

WorkspaceConfig holds the configuration of a workspace.

Field Name	Type	Description
key	WorkspaceKey	key identifies the workspace.
display_name	google.protobuf.StringValue	display_name is the user-defined name of the workspace.
description	google.protobuf.StringValue	description is a brief description of the workspace.
request	Request	request (if not REQUEST_UNSPECIFIED) kicks off an asynchronous operation on the workspace.
request_params	RequestParams	request_params specify the parameters for `request`.
exclude_network_provisioning	google.protobuf.BoolValue	exclude_network_provisioning excludes Network Provisioning components from build and from designed config on submit. This field is set to true in the workspace in which migration to Studios is initiated from the UI.

WorkspaceKey

WorkspaceKey uniquely identifies a workspace.

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id is the unique ID of the workspace.

WorkspaceSyncConfig

WorkspaceSyncConfig holds the list of devices to be synced in workspace.

Field Name	Type	Description
key	WorkspaceSyncKey	key uniquely identifies sync operations to be performed in workspace.
device_ids	fmp.RepeatedString	device_ids is the list of device Ids to be synced in the workspace.

WorkspaceSyncKey

WorkspaceSyncKey uniquely identifies sync operations to be performed in a workspace.

Field Name	Type	Description
workspace_id	google.protobuf.StringValue	workspace_id is the ID of the workspace.
sync_operation	SyncOperation	sync_operation is type of sync operation to be performed on devices.

BuildStage

BuildStage enumerates the types of stages of a build of a workspace.

Name	Number	Description
BUILD_STAGE_UNSPECIFIED	0	BUILD_STAGE_UNSPECIFIED indicates unspecified build stage.
BUILD_STAGE_INPUT_VALIDATION	1	BUILD_STAGE_INPUT_VALIDATION describes the stage that detects input errors in studios based on their schemas.
BUILD_STAGE_CONFIGLET_BUILD	2	BUILD_STAGE_CONFIGLET_BUILD describes the stage that generates EOS CLI configs and images for devices by evaluating studio templates against their inputs.
BUILD_STAGE_CONFIG_VALIDATION	3	BUILD_STAGE_CONFIG_VALIDATION describes the stage that validates the generated EOS CLI configs (e.g., checks for errors in the config).
BUILD_STAGE_IMAGE_VALIDATION	4	BUILD_STAGE_IMAGE_VALIDATION describes the stage that validates the generated images (e.g., checks device compatibility).

BuildState

BuildState enumerates the set of states that a BuildStage can be in during a workspace build cycle.

Name	Number	Description
BUILD_STATE_UNSPECIFIED	0	BUILD_STATE_UNSPECIFIED indicates unspecified build state.
BUILD_STATE_IN_PROGRESS	1	BUILD_STATE_IN_PROGRESS indicates that the BuildStage was started but has not yet completed.
BUILD_STATE_CANCELED	2	BUILD_STATE_CANCELED indicates that the BuildStage was started but then stopped before completion.
BUILD_STATE_SUCCESS	3	BUILD_STATE_SUCCESS indicates that the BuildStage was started and ran to completion successfully.
BUILD_STATE_FAIL	4	BUILD_STATE_FAIL indicates that the BuildStage was started and ran to completion unsuccessfully.
BUILD_STATE_SKIPPED	5	BUILD_STATE_SKIPPED indicates that the BuildStage was not run.

ConfigSyncSkipCause

ConfigSyncSkipCause enumerates the set of reasons a device can skip config sync.

Name	Number	Description
CONFIG_SYNC_SKIP_CAUSE_UNSPECIFIED	0	CONFIG_SYNC_SKIP_CAUSE_UNSPECIFIED indicates that config sync skip cause is unspecified.
CONFIG_SYNC_SKIP_CAUSE_INACTIVE	1	CONFIG_SYNC_SKIP_CAUSE_INACTIVE indicates that config sync is skipped because device is not streaming.
CONFIG_SYNC_SKIP_CAUSE_PRE_PROVISIONED	2	CONFIG_SYNC_SKIP_CAUSE_PRE_PROVISIONED indicates that config sync is skipped because device is pre-provisioned.
CONFIG_SYNC_SKIP_CAUSE_IN_COMPLIANCE	3	CONFIG_SYNC_SKIP_CAUSE_IN_COMPLIANCE indicates that config sync is skipped because device is in compliance.
CONFIG_SYNC_SKIP_CAUSE_NO_CONFIG_SOURCES	4	CONFIG_SYNC_SKIP_CAUSE_NO_CONFIG_SOURCES indicates that the sync was skipped because the device has no config sources.
CONFIG_SYNC_SKIP_CAUSE_DEVICE_DECOMMISSIONED	5	CONFIG_SYNC_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that sync was skipped because the device is decommissioned in the workspace.
CONFIG_SYNC_SKIP_CAUSE_DEVICE_REPLACED	6	CONFIG_SYNC_SKIP_CAUSE_DEVICE_REPLACED indicates that sync was skipped because the device is replaced in the workspace.

ConfigValidationSkipCause

ConfigValidationSkipCause enumerates the set of reasons a device can skip the config validation stage.

Name	Number	Description
CONFIG_VALIDATION_SKIP_CAUSE_UNSPECIFIED	0	CONFIG_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates config validation skip cause is unspecified.
CONFIG_VALIDATION_SKIP_CAUSE_INACTIVE	1	CONFIG_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped because the device is not streaming.
CONFIG_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED	2	CONFIG_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was skipped because the device is pre-provisioned.
CONFIG_VALIDATION_SKIP_CAUSE_CONFIG_UNCHANGED	3	CONFIG_VALIDATION_SKIP_CAUSE_CONFIG_UNCHANGED indicates that the stage was skipped because the device has no configuration changes in the workspace.
CONFIG_VALIDATION_SKIP_CAUSE_NO_CONFIG_SOURCES	4	CONFIG_VALIDATION_SKIP_CAUSE_NO_CONFIG_SOURCES indicates that the stage was skipped because the device has no config sources in the workspace.
CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED	5	CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that the stage was skipped because the device is decommissioned in the workspace.
CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED	6	CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED indicates that the stage was skipped because the device is replaced in the workspace.

DeviceAuthzStatus

DeviceAuthzStatus holds the result of the authorization check on device.

Name	Number	Description
DEVICE_AUTHZ_STATUS_UNSPECIFIED	0	DEVICE_AUTHZ_STATUS_UNSPECIFIED indicates the authorization check is pending.
DEVICE_AUTHZ_STATUS_AUTHORIZED	1	DEVICE_AUTHZ_STATUS_AUTHORIZED indicates the subject is authorized to provision this device.
DEVICE_AUTHZ_STATUS_UNAUTHORIZED	2	DEVICE_AUTHZ_STATUS_UNAUTHORIZED indicates the subject is unauthorized to provision this device.

Name

Number

Description

DEVICE_AUTHZ_STATUS_UNSPECIFIED

DEVICE_AUTHZ_STATUS_UNSPECIFIED indicates the authorization check is pending.

DEVICE_AUTHZ_STATUS_AUTHORIZED

DEVICE_AUTHZ_STATUS_AUTHORIZED indicates the subject

is authorized to provision this device.

DEVICE_AUTHZ_STATUS_UNAUTHORIZED

DEVICE_AUTHZ_STATUS_UNAUTHORIZED indicates the subject

is unauthorized to provision this device.

HierarchyBuildStatusCode

HierarchyBuildStatusCode enumerates the various statuses for a build. duplicated from hierarchy.v1.BuildStatus

Name	Number	Description
HIERARCHY_BUILD_STATUS_CODE_UNSPECIFIED	0	HIERARCHY_BUILD_STATUS_CODE_UNSPECIFIED is the default value indicating an unspecified build status.
HIERARCHY_BUILD_STATUS_CODE_RUNNING	1	HIERARCHY_BUILD_STATUS_CODE_RUNNING indicates that the build is running.
HIERARCHY_BUILD_STATUS_CODE_SUCCESS	2	HIERARCHY_BUILD_STATUS_CODE_SUCCESS indicates that the build has completed successfully without any errors.
HIERARCHY_BUILD_STATUS_CODE_FAILURE	3	HIERARCHY_BUILD_STATUS_CODE_FAILURE indicates that the build has completed unsuccesfully with errors.
HIERARCHY_BUILD_STATUS_CODE_CANCELED	4	HIERARCHY_BUILD_STATUS_CODE_CANCELED indicates that the build was canceled.

ImageValidationSkipCause

ImageValidationSkipCause enumerates the set of reasons a device can skip the image validation stage.

Name	Number	Description
IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED	0	IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates image validation skip cause is unspecified.
IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE	1	IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped because the device is not streaming.
IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED	2	IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was skipped because the device is pre-provisioned.
IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED	3	IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED indicates that the stage was skipped because the device has no image changes in the workspace.
IMAGE_VALIDATION_SKIP_CAUSE_NO_PROPOSED_SOFTWARE	4	IMAGE_VALIDATION_SKIP_CAUSE_NO_PROPOSED_SOFTWARE indicates that the stage was skipped because the device has no proposed software changes in the workspace.
IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED	5	IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that the stage was skipped because the device is decommissioned.
IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED	6	IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED indicates that the stage was skipped because the device is replaced.

Request

Request enumerates the set of asynchronous operations that can be performed on a workspace.

Name	Number	Description
REQUEST_UNSPECIFIED	0	REQUEST_UNSPECIFIED describes unspecified request.
REQUEST_START_BUILD	1	REQUEST_START_BUILD describes a request to start building a workspace. This kicks of a multi-stage operation to compile and validate the changes in a workspace (see BuildStage for more details).
REQUEST_CANCEL_BUILD	2	REQUEST_CANCEL_BUILD describes a request to stop building a workspace.
REQUEST_SUBMIT	3	REQUEST_SUBMIT describes a request to submit a workspace to the mainline. Before submission, some checks are made that can cause the request to fail. E.g., if there is a modified configuration for a non-streaming device in the workspace, then the request will fail. Once submitted, changes are applied and change controls are created (if necessary).
REQUEST_ABANDON	4	REQUEST_ABANDON describes a request to abandon a workspace. This operation does not delete the workspace from the system, but closes it to any further updates.
REQUEST_ROLLBACK	5	REQUEST_ROLLBACK describes a request to rollback a submitted workspace, undoing corresponding changes in the mainline.
REQUEST_SUBMIT_FORCE	6	REQUEST_SUBMIT_FORCE describes a request to submit a workspace without making any checks that could normally cause the submission to fail. See REQUEST_SUBMIT for more details.
REQUEST_REBASE	7	REQUEST_REBASE describes a request to rebase a workspace. This operation updates workspace state to reflect the latest mainline content, and re-applies workspace changes on top of that.

ResponseCode

ResponseCode is a code for a Response indicating a particular scenario.

Name	Number	Description
RESPONSE_CODE_UNSPECIFIED	0	RESPONSE_CODE_UNSPECIFIED indicates unspecified response code.
RESPONSE_CODE_INACTIVE_DEVICES_EXIST	1	RESPONSE_CODE_INACTIVE_DEVICES_EXIST indicates that there are devices that have inactive streaming status.
RESPONSE_CODE_DECOMMISSION_DEVICES_INCOMPLETE	2	RESPONSE_CODE_DECOMMISSION_DEVICES_INCOMPLETE indicates that the decommission process is incomplete for devices.

Name

Number

Description

RESPONSE_CODE_UNSPECIFIED

RESPONSE_CODE_UNSPECIFIED indicates unspecified response code.

RESPONSE_CODE_INACTIVE_DEVICES_EXIST

RESPONSE_CODE_INACTIVE_DEVICES_EXIST indicates that there are devices that have inactive

streaming status.

RESPONSE_CODE_DECOMMISSION_DEVICES_INCOMPLETE

RESPONSE_CODE_DECOMMISSION_DEVICES_INCOMPLETE indicates that the decommission process is

incomplete for devices.

ResponseStatus

ResponseStatus enumerates the set of execution statuses of a Response.

Name	Number	Description
RESPONSE_STATUS_UNSPECIFIED	0	RESPONSE_STATUS_UNSPECIFIED indicates unspecified response status.
RESPONSE_STATUS_SUCCESS	1	RESPONSE_STATUS_SUCCESS indicates that the original Request was successful in its execution.
RESPONSE_STATUS_FAIL	2	RESPONSE_STATUS_FAIL indicates that the original Request was unsuccessful in its execution.

Name

Number

Description

RESPONSE_STATUS_UNSPECIFIED

RESPONSE_STATUS_UNSPECIFIED indicates unspecified response status.

RESPONSE_STATUS_SUCCESS

RESPONSE_STATUS_SUCCESS indicates that the original Request was successful

in its execution.

RESPONSE_STATUS_FAIL

RESPONSE_STATUS_FAIL indicates that the original Request was unsuccessful

in its execution.

SyncOperation

SyncOperation enumerates sync operations.

Name	Number	Description
SYNC_OPERATION_UNSPECIFIED	0	SYNC_OPERATION_UNSPECIFIED indicates unspecified sync operation.
SYNC_OPERATION_CONFIG	1	SYNC_OPERATION_CONFIG indicates config sync operation.

WorkspaceState

WorkspaceState enumerates the general states of a workspace. Some of these states are derived as a result of executing a specific request on the workspace (see Request).

Name	Number	Description
WORKSPACE_STATE_UNSPECIFIED	0	WORKSPACE_STATE_UNSPECIFIED indicates unspecified workspace state.
WORKSPACE_STATE_PENDING	1	WORKSPACE_STATE_PENDING indicates that the changes in the workspace are open and have not been submitted.
WORKSPACE_STATE_SUBMITTED	2	WORKSPACE_STATE_SUBMITTED indicates that the changes in the workspace have been submitted to the mainline.
WORKSPACE_STATE_ABANDONED	3	WORKSPACE_STATE_ABANDONED indicates that the workspace has been intentionally closed, and may no longer be updated.
WORKSPACE_STATE_CONFLICTS	4	WORKSPACE_STATE_CONFLICTS indicates that the changes in the workspace are in conflict with the current state of the system.
WORKSPACE_STATE_ROLLED_BACK	5	WORKSPACE_STATE_ROLLED_BACK indicates that the workspace was submitted, but has been rolled back (the changes have been undone).

Top

arista/workspace.v1/services.gen.proto

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.

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.

WorkspaceBatchedStreamRequest

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

Workspace[...]

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

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

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

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

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

until end.

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

WorkspaceBatchedStreamResponse

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

WorkspaceStreamResponse[...]

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

WorkspaceBuildBatchedStreamRequest

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

WorkspaceBuild[...]

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

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

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

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

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

until end.

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

WorkspaceBuildBatchedStreamResponse

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

WorkspaceBuildStreamResponse[...]

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

WorkspaceBuildDetailsBatchedStreamRequest

Field Name

Type

Description

partial_eq_filter

WorkspaceBuildDetails[...]

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

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

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

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

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

until end.

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

WorkspaceBuildDetailsBatchedStreamResponse

Field Name

Type

Description

responses

WorkspaceBuildDetailsStreamResponse[...]

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

WorkspaceBuildDetailsRequest

Field Name

Type

Description

key

WorkspaceBuildDetailsKey

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

WorkspaceBuildDetailsResponse

Field Name

Type

Description

value

WorkspaceBuildDetails

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

WorkspaceBuildDetails instance in this response.

WorkspaceBuildDetailsSomeRequest

Field Name

Type

Description

keys

WorkspaceBuildDetailsKey[...]

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.

WorkspaceBuildDetailsSomeResponse

Field Name

Type

Description

value

WorkspaceBuildDetails

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

WorkspaceBuildDetailsStreamRequest