BuildResult is the per-device build output
| Field Name | Type | Description |
|---|---|---|
| state | BuildState | |
| stage | BuildStage | |
| input_validation_results | InputValidationResults | |
| configlet_build_results | ConfigletBuildResults | |
| config_validation_result | ConfigValidationResult |
BuildResults is the build output for all devices, indexed by device ID
| Field Name | Type | Description |
|---|---|---|
| values | BuildResults.ValuesEntry[…] |
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | BuildResult |
ConfigValidationResult is the result of validating config with an EOS device
| Field Name | Type | Description |
|---|---|---|
| summary | arista.configstatus.v1.ConfigSummary | |
| errors | arista.configstatus.v1.ConfigErrors | |
| warnings | arista.configstatus.v1.ConfigErrors |
ConfigletBuildResult is the output of configlet (template) build
| Field Name | Type | Description |
|---|---|---|
| template_errors | TemplateErrors | |
| generated_config | google.protobuf.StringValue |
ConfigletBuildResults is the output of configlet build, one per studio
| Field Name | Type | Description |
|---|---|---|
| values | ConfigletBuildResults.ValuesEntry[…] |
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | ConfigletBuildResult |
InputError represents an error in an input field, with either schema or value
| Field Name | Type | Description |
|---|---|---|
| field_id | google.protobuf.StringValue | ID of the field |
| path | fmp.RepeatedString | Path leading up to the field |
| members | fmp.RepeatedString | Members of the field |
| message | google.protobuf.StringValue | The error message |
InputErrors is the nullable list of InputError
| Field Name | Type | Description |
|---|---|---|
| values | InputError[…] |
InputValidationResult is the result of input validation of a studio
| Field Name | Type | Description |
|---|---|---|
| input_schema_errors | InputErrors | |
| input_value_errors | InputErrors | |
| other_errors | fmp.RepeatedString |
InputValidationResults is the result of input validation, one per studio
| Field Name | Type | Description |
|---|---|---|
| values | InputValidationResults.ValuesEntry[…] |
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | InputValidationResult |
RequestParams is the parameters associated with a WorkspaceRequest
| Field Name | Type | Description |
|---|---|---|
| request_id | google.protobuf.StringValue |
Response is the response to the last Request, typically errors in processing
| Field Name | Type | Description |
|---|---|---|
| status | ResponseStatus | |
| message | google.protobuf.StringValue |
Responses is the map of all request ID to response that are processed so far
| Field Name | Type | Description |
|---|---|---|
| values | Responses.ValuesEntry[…] |
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | Response |
TemplateError represents a single error generated by a template evaluation
| Field Name | Type | Description |
|---|---|---|
| line_num | google.protobuf.UInt32Value | Line on which the error occurred |
| exception | google.protobuf.StringValue | The exception type |
| detail | google.protobuf.StringValue | Backtrace, etc. |
TemplateErrors is the nullable list of TemplateError
| Field Name | Type | Description |
|---|---|---|
| values | TemplateError[…] |
Workspace is the status of a workspace
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | |
| created_at | google.protobuf.Timestamp | |
| created_by | google.protobuf.StringValue | |
| last_modified_at | google.protobuf.Timestamp | |
| last_modified_by | google.protobuf.StringValue | |
| state | WorkspaceState | |
| last_build_id | google.protobuf.StringValue | |
| responses | Responses | |
| cc_ids | fmp.RepeatedString | Change Controls created by submitting this workspace |
WorkspaceBuild is the result, or output of a workspace build This includes results for all devices across all studios in the workspace
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceBuildKey | |
| state | BuildState | |
| build_results | BuildResults |
WorkspaceBuildKey is the key to get the build result for a workspace
| Field Name | Type | Description |
|---|---|---|
| workspace_id | google.protobuf.StringValue | workspace_id is a required field which represents workspace ID |
| build_id | google.protobuf.StringValue | build_id is a required field which represents build ID |
WorkspaceConfig represents the configurable parameters of a workspace
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | |
| display_name | google.protobuf.StringValue | |
| description | google.protobuf.StringValue | |
| request | Request | |
| request_params | RequestParams |
WorkspaceKey is the key to get a workspace’s status
| Field Name | Type | Description |
|---|---|---|
| workspace_id | google.protobuf.StringValue |
BuildStage is the stage of a workspace build
| Name | Number | Description |
|---|---|---|
| BUILD_STAGE_UNSPECIFIED | 0 | |
| BUILD_STAGE_INPUT_VALIDATION | 1 | |
| BUILD_STAGE_CONFIGLET_BUILD | 2 | |
| BUILD_STAGE_CONFIG_VALIDATION | 3 |
| Name | Number | Description |
|---|---|---|
| BUILD_STATE_UNSPECIFIED | 0 | |
| BUILD_STATE_IN_PROGRESS | 1 | |
| BUILD_STATE_CANCELED | 2 | |
| BUILD_STATE_SUCCESS | 3 | |
| BUILD_STATE_FAIL | 4 |
Operations on a workspace that can be requested by a client. These are workspace-specific operations. The standard operations Add, Delete, etc. are performed via the standard (“core”) APIs. This is an asynchronous request that returns immediately if the request is valid. The result of the operation will be available in WorkspaceStatus when it is generated.
| Name | Number | Description |
|---|---|---|
| REQUEST_UNSPECIFIED | 0 | |
| REQUEST_START_BUILD | 1 | Start a new build |
| REQUEST_CANCEL_BUILD | 2 | Cancel any pending build |
| REQUEST_SUBMIT | 3 | Submit the workspace (merge into mainline) |
| REQUEST_ABANDON | 4 | Abandon the workspace. Not delete |
| REQUEST_ROLLBACK | 5 | Rollback an already submitted workspace |
| Name | Number | Description |
|---|---|---|
| RESPONSE_STATUS_UNSPECIFIED | 0 | |
| RESPONSE_STATUS_SUCCESS | 1 | |
| RESPONSE_STATUS_FAIL | 2 |
| Name | Number | Description |
|---|---|---|
| WORKSPACE_STATE_UNSPECIFIED | 0 | |
| WORKSPACE_STATE_PENDING | 1 | |
| WORKSPACE_STATE_SUBMITTED | 2 | |
| WORKSPACE_STATE_ABANDONED | 3 | |
| WORKSPACE_STATE_CONFLICTS | 4 | |
| WORKSPACE_STATE_ROLLED_BACK | 5 |
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceBuildKey | Key uniquely identifies a WorkspaceBuild instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceBuild | 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 WorkspaceBuild instance in this response. |
| 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. This field is not allowed in the Subscribe RPC. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceBuild | 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 WorkspaceBuild’s last modification. |
| type | arista.subscriptions.Operation | 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. |
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | Key indicates which WorkspaceConfig instance to remove. This field must always be set. |
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | Key echoes back the key of the deleted WorkspaceConfig instance. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==DeletedAt will not include this instance. |
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | Key uniquely identifies a WorkspaceConfig instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceConfig | 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 WorkspaceConfig instance in this response. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceConfig | WorkspaceConfig carries the value to set into the datastore. See the documentation on the WorkspaceConfig struct for which fields are required. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceConfig | Value carries all the values given in the WorkspaceConfigSetRequest as well as any server-generated values. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance. |
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | WorkspaceConfig[…] | 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. This field is not allowed in the Subscribe RPC. |
| Field Name | Type | Description |
|---|---|---|
| value | WorkspaceConfig | 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 WorkspaceConfig’s last modification. |
| type | arista.subscriptions.Operation | 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. |
| Field Name | Type | Description |
|---|---|---|
| key | WorkspaceKey | Key uniquely identifies a Workspace instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
| Field Name | Type | Description |
|---|---|---|
| value | Workspace | 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 Workspace instance in this response. |
| 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. This field is not allowed in the Subscribe RPC. |
| Field Name | Type | Description |
|---|---|---|
| value | Workspace | 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 Workspace’s last modification. |
| type | arista.subscriptions.Operation | 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. |
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | WorkspaceBuildRequest | WorkspaceBuildResponse | |
| GetAll | WorkspaceBuildStreamRequest | WorkspaceBuildStreamResponse stream | |
| Subscribe | WorkspaceBuildStreamRequest | WorkspaceBuildStreamResponse stream |
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | WorkspaceConfigRequest | WorkspaceConfigResponse | |
| GetAll | WorkspaceConfigStreamRequest | WorkspaceConfigStreamResponse stream | |
| Subscribe | WorkspaceConfigStreamRequest | WorkspaceConfigStreamResponse stream | |
| Set | WorkspaceConfigSetRequest | WorkspaceConfigSetResponse | |
| Delete | WorkspaceConfigDeleteRequest | WorkspaceConfigDeleteResponse |
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | WorkspaceRequest | WorkspaceResponse | |
| GetAll | WorkspaceStreamRequest | WorkspaceStreamResponse stream | |
| Subscribe | WorkspaceStreamRequest | WorkspaceStreamResponse stream |