workspace.v1

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 is true when there is atleast 1 device

for which the subject doesn’t have provision permission.

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

are true.

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.

summary is a summary of the changes to the previous config.

errors are any errors detected in the generated config.

warnings are any warnings about the generated config.

config_sources identify the entities that generated the config.

template_errors are errors that occured during studio template evaluation.

generated_config is the EOS CLI config that was generated from the stage.

other_error is any other miscellaneous error.

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 are errors in input fields that are raised by the template.

values is a map from studio ID to ConfigletBuildResult.

summary is a summary of the changes to the previous image.

errors are any errors detected in the generated image.

warnings are any warnings about the generated image.

image_input_error indicates any errors in image inputs.

field_id is the ID of the input field.

path is the path leading up to the input field.

members are the members of the input field (if it is a group).

message is the error message.

values is a list of InputError.

input_schema_errors are errors for fields in the input schema.

input_value_errors are errors for values assigned to fields in the input schema.

other_errors are other miscellaneous errors.

values is map from studio ID to InputValidationResult.

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

the Response for the request in Responses.

status is the execution status of the response.

message is a string that provides more details about the response.

code is the code of the response.

values is a map from request ID to Response.

line_num is the number of the line on which the error occurred.

exception is the type of the exception thrown during the script execution.

E.g., AssertionError, etc.

detail holds the details of the exception. E.g., a full backtrace.

exception_msg is the message of the exception thrown during the script execution.

values is a list of TemplateError.

key identifies the workspace.

created_at indicates when the workspace was created.

created_by indicates who created the workspace.

last_modified_at indicates when the workspace was last updated.

last_modified_by indicates who last updated the workspace.

state describes the status of the workspace.

last_build_id is the last build ID that was set in a WorkspaceBuild

for this workspace.

responses are the responses for all requests that have been executed

thusfar for this workspace.

cc_ids are the IDs of any change controls that were created as a result

of submitting this workspace.

needs_build indicates whether a rebuild of the workspace is necessary

in order to submit it.

last_rebased_at indicates when the workspace was last rebased.

needs_rebase indicates whether a rebase of the workspace is necessary

in order to submit it.

display_name is the user-defined name of the workspace.

description is a brief description of the workspace.

key identifies the build.

state is the execution status of the build.

error is an error message that is set if the build fails early before

the per-device build result is computed.

built_by is the details of subject who built the workspace.

authz_result has the result of authorization check.

key identifies the build.

state is the execution status of the build.

stage is the stage of the build.

input_validation_results are the results of the input validation stage.

configlet_build_results are the results of the configlet build stage.

config_validation_result is the result of the config validation stage.

image_validation_result is the result of the image validation stage.

config_validation_skip_cause is the reason, if any, that the config

validation stage was skipped.

image_validation_skip_cause is the reason, if any, that the image

validation stage was skipped.

build_stage_state is the state for each build stage.

authz_status is the status of provision permission for the device.

workspace_id is the ID of the workspace.

build_id is the ID of the build.

device_id is the ID of the device.

workspace_id is the ID of the workspace.

build_id is the ID of the build.

key identifies the workspace.

display_name is the user-defined name of the workspace.

description is a brief description of the workspace.

request (if not REQUEST_UNSPECIFIED) kicks off an asynchronous operation

on the workspace.

request_params specify the parameters for request.

workspace_id is the unique ID of the workspace.

BUILD_STAGE_UNSPECIFIED indicates unspecified build stage.

BUILD_STAGE_INPUT_VALIDATION describes the stage that detects input

errors in studios based on their schemas.

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 describes the stage that validates the

generated EOS CLI configs (e.g., checks for errors in the config).

BUILD_STAGE_IMAGE_VALIDATION describes the stage that validates the

generated images (e.g., checks device compatibility).

BUILD_STATE_UNSPECIFIED indicates unspecified build state.

BUILD_STATE_IN_PROGRESS indicates that the BuildStage was started but has

not yet completed.

BUILD_STATE_CANCELED indicates that the BuildStage was started but then

stopped before completion.

BUILD_STATE_SUCCESS indicates that the BuildStage was started and ran to

completion successfully.

BUILD_STATE_FAIL indicates that the BuildStage was started and ran to

completion unsuccessfully.

BUILD_STATE_SKIPPED indicates that the BuildStage was not run.

CONFIG_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates config validation skip cause is

unspecified.

CONFIG_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped

because the device is not streaming.

CONFIG_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was

skipped because the device is pre-provisioned.

CONFIG_VALIDATION_SKIP_CAUSE_CONFIG_UNCHANGED indicates that the stage was

skipped because the device has no configuration changes in the workspace.

DEVICE_AUTHZ_STATUS_UNSPECIFIED indicates the authorization check is pending.

DEVICE_AUTHZ_STATUS_AUTHORIZED indicates the subject

is authorized to provision this device.

DEVICE_AUTHZ_STATUS_UNAUTHORIZED indicates the subject

is unauthorized to provision this device.

IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates image validation skip cause is

unspecified.

IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped

because the device is not streaming.

IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was

skipped because the device is pre-provisioned.

IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED indicates that the stage was

skipped because the device has no image changes in the workspace.

REQUEST_UNSPECIFIED describes unspecified request.

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 describes a request to stop building a workspace.

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 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 describes a request to rollback a submitted workspace, undoing

corresponding changes in the mainline.

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

RESPONSE_CODE_UNSPECIFIED indicates unspecified response code.

RESPONSE_CODE_INACTIVE_DEVICES_EXIST indicates that there are devices that have inactive

streaming status.

RESPONSE_STATUS_UNSPECIFIED indicates unspecified response status.

RESPONSE_STATUS_SUCCESS indicates that the original Request was successful

in its execution.

RESPONSE_STATUS_FAIL indicates that the original Request was unsuccessful

in its execution.

WORKSPACE_STATE_UNSPECIFIED indicates unspecified workspace state.

WORKSPACE_STATE_PENDING indicates that the changes in the workspace are open and

have not been submitted.

WORKSPACE_STATE_SUBMITTED indicates that the changes in the workspace have been

submitted to the mainline.

WORKSPACE_STATE_ABANDONED indicates that the workspace has been intentionally

closed, and may no longer be updated.

WORKSPACE_STATE_CONFLICTS indicates that the changes in the workspace are in

conflict with the current state of the system.

WORKSPACE_STATE_ROLLED_BACK indicates that the workspace was submitted, but

has been rolled back (the changes have been undone).

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

Operation indicates how the value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Count is the number of items present under the conditions of the request.

Key uniquely identifies a WorkspaceBuildDetails instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

WorkspaceBuildDetails instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

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

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

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

* end: Returns the state of each 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.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this WorkspaceBuildDetails’s last modification.

Operation indicates how the WorkspaceBuildDetails value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Key uniquely identifies a WorkspaceBuild instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

WorkspaceBuild instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

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

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

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

* end: Returns the state of each 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.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this WorkspaceBuild’s last modification.

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

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.

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

This indicates the error message from the delete failure.

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

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

Key indicates which WorkspaceConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted WorkspaceConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

key contains a list of WorkspaceConfig keys to delete

Key uniquely identifies a WorkspaceConfig instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

WorkspaceConfig instance in this response.

WorkspaceConfig carries the value to set into the datastore.

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

Value carries all the values given in the WorkspaceConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

value contains a list of WorkspaceConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

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

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

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

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this WorkspaceConfig’s last modification.

Operation indicates how the WorkspaceConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Key uniquely identifies a Workspace instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

Workspace instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

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

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

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

* end: Returns the state of each 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.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this Workspace’s last modification.

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