cloudvision.api.arista.workspace.v1 package

Module contents

class cloudvision.api.arista.workspace.v1.AuthzResult(has_unauthorized_tag_change: bool | None = <PLACEHOLDER>, has_unauthorized_device_change: bool | None = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>)

Bases: Message

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

error: str | None = <PLACEHOLDER>

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

has_unauthorized_device_change: bool | None = <PLACEHOLDER>

has_unauthorized_device_change is true when there is atleast 1 device for which the subject doesn’t have provision permission.

has_unauthorized_tag_change: bool | None = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.BuildStage(value: int)

Bases: Enum

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

CONFIGLET_BUILD = BuildStage.CONFIGLET_BUILD

BUILD_STAGE_CONFIGLET_BUILD describes the stage that generates EOS CLI configs and images for devices by evaluating studio templates against their inputs.

CONFIG_VALIDATION = BuildStage.CONFIG_VALIDATION

BUILD_STAGE_CONFIG_VALIDATION describes the stage that validates the generated EOS CLI configs (e.g., checks for errors in the config).

IMAGE_VALIDATION = BuildStage.IMAGE_VALIDATION

BUILD_STAGE_IMAGE_VALIDATION describes the stage that validates the generated images (e.g., checks device compatibility).

INPUT_VALIDATION = BuildStage.INPUT_VALIDATION

BUILD_STAGE_INPUT_VALIDATION describes the stage that detects input errors in studios based on their schemas.

UNSPECIFIED = BuildStage.UNSPECIFIED

BUILD_STAGE_UNSPECIFIED indicates unspecified build stage.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.BuildStageState(values: ~typing.Dict[str, ~cloudvision.api.arista.workspace.v1.BuildState] = <PLACEHOLDER>)

Bases: Message

BuildStageState holds the state per build stage.

values: Dict[str, BuildState] = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.BuildState(value: int)

Bases: Enum

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

CANCELED = BuildState.CANCELED

BUILD_STATE_CANCELED indicates that the BuildStage was started but then stopped before completion.

FAIL = BuildState.FAIL

BUILD_STATE_FAIL indicates that the BuildStage was started and ran to completion unsuccessfully.

IN_PROGRESS = BuildState.IN_PROGRESS

BUILD_STATE_IN_PROGRESS indicates that the BuildStage was started but has not yet completed.

SKIPPED = BuildState.SKIPPED

BUILD_STATE_SKIPPED indicates that the BuildStage was not run.

SUCCESS = BuildState.SUCCESS

BUILD_STATE_SUCCESS indicates that the BuildStage was started and ran to completion successfully.

UNSPECIFIED = BuildState.UNSPECIFIED

BUILD_STATE_UNSPECIFIED indicates unspecified build state.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.ConfigSyncResult(summary: ~cloudvision.api.arista.configstatus.v1.ConfigSummary = <PLACEHOLDER>, errors: ~cloudvision.api.arista.configstatus.v1.ConfigErrors = <PLACEHOLDER>, config_sources: ~cloudvision.api.arista.configstatus.v1.ConfigSources = <PLACEHOLDER>)

Bases: Message

ConfigSyncResult holds the result of config sync operation.

config_sources: __configstatus_v1__.ConfigSources = <PLACEHOLDER>

config_sources identify the entities that generated the designed config.

errors: __configstatus_v1__.ConfigErrors = <PLACEHOLDER>

errors are any errors detected during sync.

summary: __configstatus_v1__.ConfigSummary = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.ConfigSyncSkipCause(value: int)

Bases: Enum

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

DEVICE_DECOMMISSIONED = ConfigSyncSkipCause.DEVICE_DECOMMISSIONED

CONFIG_SYNC_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that sync was skipped because the device is decommissioned in the workspace.

DEVICE_REPLACED = ConfigSyncSkipCause.DEVICE_REPLACED

CONFIG_SYNC_SKIP_CAUSE_DEVICE_REPLACED indicates that sync was skipped because the device is replaced in the workspace.

INACTIVE = ConfigSyncSkipCause.INACTIVE

CONFIG_SYNC_SKIP_CAUSE_INACTIVE indicates that config sync is skipped because device is not streaming.

IN_COMPLIANCE = ConfigSyncSkipCause.IN_COMPLIANCE

CONFIG_SYNC_SKIP_CAUSE_IN_COMPLIANCE indicates that config sync is skipped because device is in compliance.

NO_CONFIG_SOURCES = ConfigSyncSkipCause.NO_CONFIG_SOURCES

CONFIG_SYNC_SKIP_CAUSE_NO_CONFIG_SOURCES indicates that the sync was skipped because the device has no config sources.

PRE_PROVISIONED = ConfigSyncSkipCause.PRE_PROVISIONED

CONFIG_SYNC_SKIP_CAUSE_PRE_PROVISIONED indicates that config sync is skipped because device is pre-provisioned.

UNSPECIFIED = ConfigSyncSkipCause.UNSPECIFIED

CONFIG_SYNC_SKIP_CAUSE_UNSPECIFIED indicates that config sync skip cause is unspecified.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.ConfigValidationResult(summary: ~cloudvision.api.arista.configstatus.v1.ConfigSummary = <PLACEHOLDER>, errors: ~cloudvision.api.arista.configstatus.v1.ConfigErrors = <PLACEHOLDER>, warnings: ~cloudvision.api.arista.configstatus.v1.ConfigErrors = <PLACEHOLDER>, config_sources: ~cloudvision.api.arista.configstatus.v1.ConfigSources = <PLACEHOLDER>, only_filter_inputs_changed: bool | None = <PLACEHOLDER>)

Bases: Message

ConfigValidationResult holds the result of a config validation stage.

config_sources: __configstatus_v1__.ConfigSources = <PLACEHOLDER>

config_sources identify the entities that generated the config.

errors: __configstatus_v1__.ConfigErrors = <PLACEHOLDER>

errors are any errors detected in the generated config.

only_filter_inputs_changed: bool | None = <PLACEHOLDER>

only_filter_inputs_changed indicates there is a change in filters but no change in the config or no config sources found.

summary: __configstatus_v1__.ConfigSummary = <PLACEHOLDER>

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

warnings: __configstatus_v1__.ConfigErrors = <PLACEHOLDER>

warnings are any warnings about the generated config.

class cloudvision.api.arista.workspace.v1.ConfigValidationSkipCause(value: int)

Bases: Enum

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

CONFIG_UNCHANGED = ConfigValidationSkipCause.CONFIG_UNCHANGED

CONFIG_VALIDATION_SKIP_CAUSE_CONFIG_UNCHANGED indicates that the stage was skipped because the device has no configuration changes in the workspace.

DEVICE_DECOMMISSIONED = ConfigValidationSkipCause.DEVICE_DECOMMISSIONED

CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that the stage was skipped because the device is decommissioned in the workspace.

DEVICE_REPLACED = ConfigValidationSkipCause.DEVICE_REPLACED

CONFIG_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED indicates that the stage was skipped because the device is replaced in the workspace.

INACTIVE = ConfigValidationSkipCause.INACTIVE

CONFIG_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped because the device is not streaming.

NO_CONFIG_SOURCES = ConfigValidationSkipCause.NO_CONFIG_SOURCES

CONFIG_VALIDATION_SKIP_CAUSE_NO_CONFIG_SOURCES indicates that the stage was skipped because the device has no config sources in the workspace.

PRE_PROVISIONED = ConfigValidationSkipCause.PRE_PROVISIONED

CONFIG_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was skipped because the device is pre-provisioned.

UNSPECIFIED = ConfigValidationSkipCause.UNSPECIFIED

CONFIG_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates config validation skip cause is unspecified.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.ConfigletBuildResult(template_errors: ~cloudvision.api.arista.workspace.v1.TemplateErrors = <PLACEHOLDER>, generated_config: str | None = <PLACEHOLDER>, other_error: str | None = <PLACEHOLDER>, execution_id: str | None = <PLACEHOLDER>, input_errors: ~cloudvision.api.arista.workspace.v1.InputErrors = <PLACEHOLDER>)

Bases: Message

ConfigletBuildResult holds the result of a configlet build stage.

execution_id: str | None = <PLACEHOLDER>

execution_id is the unique ID for the execution of the template. This ID can be used to retrieve logs generated by the template.

generated_config: str | None = <PLACEHOLDER>

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

input_errors: InputErrors = <PLACEHOLDER>

input_errors are errors in input fields that are raised by the template.

other_error: str | None = <PLACEHOLDER>

other_error is any other miscellaneous error.

template_errors: TemplateErrors = <PLACEHOLDER>

template_errors are errors that occured during studio template evaluation.

class cloudvision.api.arista.workspace.v1.ConfigletBuildResults(values: ~typing.Dict[str, ~cloudvision.api.arista.workspace.v1.ConfigletBuildResult] = <PLACEHOLDER>)

Bases: Message

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

values: Dict[str, ConfigletBuildResult] = <PLACEHOLDER>

values is a map from studio ID to ConfigletBuildResult.

class cloudvision.api.arista.workspace.v1.DeviceAuthzStatus(value: int)

Bases: Enum

DeviceAuthzStatus holds the result of the authorization check on device.

AUTHORIZED = DeviceAuthzStatus.AUTHORIZED

DEVICE_AUTHZ_STATUS_AUTHORIZED indicates the subject is authorized to provision this device.

UNAUTHORIZED = DeviceAuthzStatus.UNAUTHORIZED

DEVICE_AUTHZ_STATUS_UNAUTHORIZED indicates the subject is unauthorized to provision this device.

UNSPECIFIED = DeviceAuthzStatus.UNSPECIFIED

DEVICE_AUTHZ_STATUS_UNSPECIFIED indicates the authorization check is pending.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.DiffEntries(values: ~typing.List[~cloudvision.api.arista.workspace.v1.DiffEntry] = <PLACEHOLDER>)

Bases: Message

DiffEntries is a container for a list of individual diff entries.

values: List[DiffEntry] = <PLACEHOLDER>

values contains a list of DiffEntry messages, each representing a change.

class cloudvision.api.arista.workspace.v1.DiffEntry(op: ~cloudvision.api.arista.workspace.v1.DiffOp = <PLACEHOLDER>, path: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, value_a: str | None = <PLACEHOLDER>, value_b: str | None = <PLACEHOLDER>, index_b: int | None = <PLACEHOLDER>, key_path: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)

Bases: Message

DiffEntry represents a change detected between two versions of an entity.

index_b: int | None = <PLACEHOLDER>

index_b is the new position of an array element in workspace_b (only for MOVE). MOVE represents relocating a single element while preserving the relative order of all others. Detected using LCS. .. rubric:: Example

workspace_a: users = [“u1”,”u2”,”u3”] workspace_b: users = [“u2”,”u1”,”u3”] DiffEntry for “u2”: path = [“1”], op = MOVE, index_b = 0

key_path: ___fmp__.RepeatedString = <PLACEHOLDER>

key_path is used to locate list elements when they have stable keys instead of numeric indices.

Syntax: [field=value] - field: the unique key field of the element - value: the element’s identifier

Example

users = [{“id”:”u1”,”name”:”Alice”}] key_path = [“users”, “[id=u1]”, “name”] path = [“users”, “0”, “name”]

op: DiffOp = <PLACEHOLDER>

op is the type of diff operation.

path: ___fmp__.RepeatedString = <PLACEHOLDER>

path to the changed field or attribute, represented as a sequence of field names or indices.

value_a: str | None = <PLACEHOLDER>

value_a is the value from workspace_a.

value_b: str | None = <PLACEHOLDER>

value_b is the value from workspace_b.

class cloudvision.api.arista.workspace.v1.DiffKey(workspace_id: str | None = <PLACEHOLDER>, diff_type: ~cloudvision.api.arista.workspace.v1.DiffType = <PLACEHOLDER>, entity_type: ~cloudvision.api.arista.workspace.v1.EntityType = <PLACEHOLDER>, entity_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)

Bases: Message

DiffKey represents the key that identifies a diff for an entity.

diff_type: DiffType = <PLACEHOLDER>

diff_type categorizes a diff by its purpose, a rebase or modification.

entity_ids: ___fmp__.RepeatedString = <PLACEHOLDER>

entity_ids uniquely identifies the entity in the workspace. It is represented by [key1, value1, key2, value2, …] studio_id are well known e.g studio-date-time e.g entity_ids for entity types studio, inputs, assigned tags: [“studio_id”, <id>] buildhook: [“studio_id”, <id>, “hook_id”, <id>] autofill: [“studio_id”, <id>, “input_field_id”, <id>] configlet: [“configlet_id”, <id>] configletassignment : [“configlet_assignment_id”, <id>] tags: element_type is one of “1” (device), “2” (interface) [“creator_type”, “2”, “element_type”, <element_type>, “element_sub_type”, “1”, “label”, <label>, “value”, <value>] tag assignments: For element_type = “1” (device) [“creator_type”, “2”, “element_type”, “1”, “element_sub_type”, “1”, “label”, <label>, “value”, <value>, “device_id”, <id>] For element_type = “2” (interface) [“creator_type”, “2”, “element_type”, “2”, “element_sub_type”, “1”, “label”, <label>, “value”, <value>, “device_id”, <id>, “interface_id”, <id>]

entity_type: EntityType = <PLACEHOLDER>

entity_type is the type of entity being compared.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the unique ID of the workspace.

class cloudvision.api.arista.workspace.v1.DiffOp(value: int)

Bases: Enum

DiffOp enumerates the types of operations that can occur within a diff.

ADD = DiffOp.ADD

DIFF_OP_ADD indicates the addition of a new item.

CHANGE = DiffOp.CHANGE

DIFF_OP_CHANGE indicates modification of an item.

DELETE = DiffOp.DELETE

DIFF_OP_DELETE indicates the deletion of an item.

MOVE = DiffOp.MOVE

DIFF_OP_MOVE indicates change in position of an item in a list.

UNSPECIFIED = DiffOp.UNSPECIFIED

DIFF_OP_UNSPECIFIED indicates an unspecified diff operation.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.DiffType(value: int)

Bases: Enum

DiffType enumerates types of diff.

REBASE = DiffType.REBASE

DIFF_TYPE_REBASE represents a diff generated during a workspace rebase operation. it means that we return two sets of diffs - one for what happened in the workspace relative to its original mainline, and another for what happened between original mainline and latest mainline.

UNSPECIFIED = DiffType.UNSPECIFIED

DIFF_TYPE_UNSPECIFIED is the default, unspecified value.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.EntityType(value: int)

Bases: Enum

EntityType enumerates the different types of entities that can be compared or referenced in a diff operation.

ASSIGNED_TAGS = EntityType.ASSIGNED_TAGS

ENTITY_TYPE_ASSIGNED_TAGS indicates the AssignedTags entity type.

AUTOFILL_ACTION = EntityType.AUTOFILL_ACTION

ENTITY_TYPE_AUTOFILL_ACTION indicates the AutofillAction entity type.

BUILD_HOOK = EntityType.BUILD_HOOK

ENTITY_TYPE_BUILD_HOOK indicates the BuildHook entity type.

CONFIGLET = EntityType.CONFIGLET

ENTITY_TYPE_CONFIGLET indicates the Configlet entity type for static configuration studio.

CONFIGLET_ASSIGNMENT = EntityType.CONFIGLET_ASSIGNMENT

ENTITY_TYPE_CONFIGLET_ASSIGNMENT indicates the ConfigletAssignment entity type for static configuration studio.

INPUTS = EntityType.INPUTS

ENTITY_TYPE_INPUTS indicates the Inputs entity type.

STUDIO = EntityType.STUDIO

ENTITY_TYPE_STUDIO indicates the Studio entity type.

TAG = EntityType.TAG

ENTITY_TYPE_TAG indicates the tags entity type.

TAG_ASSIGNMENT = EntityType.TAG_ASSIGNMENT

ENTITY_TYPE_TAG_ASSIGNMENT indicates the tag assignment entity type.

UNSPECIFIED = EntityType.UNSPECIFIED

ENTITY_TYPE_UNSPECIFIED indicates an unspecified entity type.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.HierarchyBuildStatus(build_id: str | None = <PLACEHOLDER>, build_status: ~cloudvision.api.arista.workspace.v1.HierarchyBuildStatusCode = <PLACEHOLDER>)

Bases: Message

HierarchyBuildStatus reference to the hierarchy build part of this workspace build

build_id: str | None = <PLACEHOLDER>

build_id is the reference to the hierarchy build. It uniquely identifies the hierarchy build

build_status: HierarchyBuildStatusCode = <PLACEHOLDER>

build_status ststus of the build on its completion

class cloudvision.api.arista.workspace.v1.HierarchyBuildStatusCode(value: int)

Bases: Enum

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

CANCELED = HierarchyBuildStatusCode.CANCELED

HIERARCHY_BUILD_STATUS_CODE_CANCELED indicates that the build was canceled.

FAILURE = HierarchyBuildStatusCode.FAILURE

HIERARCHY_BUILD_STATUS_CODE_FAILURE indicates that the build has completed unsuccesfully with errors.

RUNNING = HierarchyBuildStatusCode.RUNNING

HIERARCHY_BUILD_STATUS_CODE_RUNNING indicates that the build is running.

SUCCESS = HierarchyBuildStatusCode.SUCCESS

HIERARCHY_BUILD_STATUS_CODE_SUCCESS indicates that the build has completed successfully without any errors.

UNSPECIFIED = HierarchyBuildStatusCode.UNSPECIFIED

HIERARCHY_BUILD_STATUS_CODE_UNSPECIFIED is the default value indicating an unspecified build status.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.ImageValidationResult(summary: ~cloudvision.api.arista.imagestatus.v1.ImageSummary = <PLACEHOLDER>, errors: ~cloudvision.api.arista.imagestatus.v1.ImageErrors = <PLACEHOLDER>, warnings: ~cloudvision.api.arista.imagestatus.v1.ImageWarnings = <PLACEHOLDER>, image_input_error: str | None = <PLACEHOLDER>, infos: ~cloudvision.api.arista.imagestatus.v1.ImageInfos = <PLACEHOLDER>)

Bases: Message

ImageValidationResult holds the result of an image validation stage.

errors: __imagestatus_v1__.ImageErrors = <PLACEHOLDER>

errors are any errors detected in the generated image.

image_input_error: str | None = <PLACEHOLDER>

image_input_error indicates any errors in image inputs.

infos: __imagestatus_v1__.ImageInfos = <PLACEHOLDER>

infos are any info messages about the generated image.

summary: __imagestatus_v1__.ImageSummary = <PLACEHOLDER>

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

warnings: __imagestatus_v1__.ImageWarnings = <PLACEHOLDER>

warnings are any warnings about the generated image.

class cloudvision.api.arista.workspace.v1.ImageValidationSkipCause(value: int)

Bases: Enum

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

DEVICE_DECOMMISSIONED = ImageValidationSkipCause.DEVICE_DECOMMISSIONED

IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_DECOMMISSIONED indicates that the stage was skipped because the device is decommissioned.

DEVICE_REPLACED = ImageValidationSkipCause.DEVICE_REPLACED

IMAGE_VALIDATION_SKIP_CAUSE_DEVICE_REPLACED indicates that the stage was skipped because the device is replaced.

IMAGE_UNCHANGED = ImageValidationSkipCause.IMAGE_UNCHANGED

IMAGE_VALIDATION_SKIP_CAUSE_IMAGE_UNCHANGED indicates that the stage was skipped because the device has no image changes in the workspace.

INACTIVE = ImageValidationSkipCause.INACTIVE

IMAGE_VALIDATION_SKIP_CAUSE_INACTIVE indicates that the stage was skipped because the device is not streaming.

NO_PROPOSED_SOFTWARE = ImageValidationSkipCause.NO_PROPOSED_SOFTWARE

IMAGE_VALIDATION_SKIP_CAUSE_NO_PROPOSED_SOFTWARE indicates that the stage was skipped because the device has no proposed software changes in the workspace.

PRE_PROVISIONED = ImageValidationSkipCause.PRE_PROVISIONED

IMAGE_VALIDATION_SKIP_CAUSE_PRE_PROVISIONED indicates that the stage was skipped because the device is pre-provisioned.

UNSPECIFIED = ImageValidationSkipCause.UNSPECIFIED

IMAGE_VALIDATION_SKIP_CAUSE_UNSPECIFIED indicates image validation skip cause is unspecified.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.InputError(field_id: str | None = <PLACEHOLDER>, path: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, members: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, message: str | None = <PLACEHOLDER>)

Bases: Message

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

field_id: str | None = <PLACEHOLDER>

field_id is the ID of the input field.

members: ___fmp__.RepeatedString = <PLACEHOLDER>

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

message: str | None = <PLACEHOLDER>

message is the error message.

path: ___fmp__.RepeatedString = <PLACEHOLDER>

path is the path leading up to the input field.

class cloudvision.api.arista.workspace.v1.InputErrors(values: ~typing.List[~cloudvision.api.arista.workspace.v1.InputError] = <PLACEHOLDER>)

Bases: Message

InputErrors is a list of InputError.

values: List[InputError] = <PLACEHOLDER>

values is a list of InputError.

class cloudvision.api.arista.workspace.v1.InputValidationResult(input_schema_errors: ~cloudvision.api.arista.workspace.v1.InputErrors = <PLACEHOLDER>, input_value_errors: ~cloudvision.api.arista.workspace.v1.InputErrors = <PLACEHOLDER>, other_errors: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, input_warnings: ~cloudvision.api.arista.workspace.v1.InputWarnings = <PLACEHOLDER>)

Bases: Message

InputValidationResult holds the result of an input validation build stage.

input_schema_errors: InputErrors = <PLACEHOLDER>

input_schema_errors are errors for fields in the input schema.

input_value_errors: InputErrors = <PLACEHOLDER>

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

input_warnings: InputWarnings = <PLACEHOLDER>

input_warnings are warnings for values assigned to fields in the input schema.

other_errors: ___fmp__.RepeatedString = <PLACEHOLDER>

other_errors are other miscellaneous errors.

class cloudvision.api.arista.workspace.v1.InputValidationResults(values: ~typing.Dict[str, ~cloudvision.api.arista.workspace.v1.InputValidationResult] = <PLACEHOLDER>)

Bases: Message

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

values: Dict[str, InputValidationResult] = <PLACEHOLDER>

values is map from studio ID to InputValidationResult.

class cloudvision.api.arista.workspace.v1.InputWarning(field_id: str | None = <PLACEHOLDER>, path: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, members: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, message: str | None = <PLACEHOLDER>)

Bases: Message

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

field_id: str | None = <PLACEHOLDER>

field_id is the ID of the input field.

members: ___fmp__.RepeatedString = <PLACEHOLDER>

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

message: str | None = <PLACEHOLDER>

message is the warning message.

path: ___fmp__.RepeatedString = <PLACEHOLDER>

path is the path leading up to the input field.

class cloudvision.api.arista.workspace.v1.InputWarnings(values: ~typing.List[~cloudvision.api.arista.workspace.v1.InputWarning] = <PLACEHOLDER>)

Bases: Message

InputWarnings is a list of InputWarning.

values: List[InputWarning] = <PLACEHOLDER>

values is a list of InputWarning.

class cloudvision.api.arista.workspace.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)

Bases: Message

count: int | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.Request(value: int)

Bases: Enum

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

ABANDON = Request.ABANDON

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.

CANCEL_BUILD = Request.CANCEL_BUILD

REQUEST_CANCEL_BUILD describes a request to stop building a workspace.

REBASE = Request.REBASE

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.

ROLLBACK = Request.ROLLBACK

REQUEST_ROLLBACK describes a request to rollback a submitted workspace, undoing corresponding changes in the mainline.

START_BUILD = Request.START_BUILD

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

SUBMIT = Request.SUBMIT

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

SUBMIT_FORCE = Request.SUBMIT_FORCE

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.

UNSPECIFIED = Request.UNSPECIFIED

REQUEST_UNSPECIFIED describes unspecified request.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.RequestParams(request_id: str | None = <PLACEHOLDER>)

Bases: Message

RequestParams define the parameters for a Request.

request_id: str | None = <PLACEHOLDER>

request_id is the unique ID of the request. This is used to identify the Response for the request in Responses.

class cloudvision.api.arista.workspace.v1.Response(status: ~cloudvision.api.arista.workspace.v1.ResponseStatus = <PLACEHOLDER>, message: str | None = <PLACEHOLDER>, code: ~cloudvision.api.arista.workspace.v1.ResponseCode = <PLACEHOLDER>)

Bases: Message

Response is a response to a Request.

code: ResponseCode = <PLACEHOLDER>

code is the code of the response.

message: str | None = <PLACEHOLDER>

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

status: ResponseStatus = <PLACEHOLDER>

status is the execution status of the response.

class cloudvision.api.arista.workspace.v1.ResponseCode(value: int)

Bases: Enum

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

DECOMMISSION_DEVICES_INCOMPLETE = ResponseCode.DECOMMISSION_DEVICES_INCOMPLETE

RESPONSE_CODE_DECOMMISSION_DEVICES_INCOMPLETE indicates that the decommission process is incomplete for devices.

INACTIVE_DEVICES_EXIST = ResponseCode.INACTIVE_DEVICES_EXIST

RESPONSE_CODE_INACTIVE_DEVICES_EXIST indicates that there are devices that have inactive streaming status.

SYNCHRONIZATION_REQUIRED = ResponseCode.SYNCHRONIZATION_REQUIRED

RESPONSE_CODE_SYNCHRONIZATION_REQUIRED indicates that synchronization is required.

UNSPECIFIED = ResponseCode.UNSPECIFIED

RESPONSE_CODE_UNSPECIFIED indicates unspecified response code.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.ResponseStatus(value: int)

Bases: Enum

ResponseStatus enumerates the set of execution statuses of a Response.

FAIL = ResponseStatus.FAIL

RESPONSE_STATUS_FAIL indicates that the original Request was unsuccessful in its execution.

SUCCESS = ResponseStatus.SUCCESS

RESPONSE_STATUS_SUCCESS indicates that the original Request was successful in its execution.

UNSPECIFIED = ResponseStatus.UNSPECIFIED

RESPONSE_STATUS_UNSPECIFIED indicates unspecified response status.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.Responses(values: ~typing.Dict[str, ~cloudvision.api.arista.workspace.v1.Response] = <PLACEHOLDER>)

Bases: Message

Responses is a collection of responses for completed requests.

values: Dict[str, Response] = <PLACEHOLDER>

values is a map from request ID to Response.

class cloudvision.api.arista.workspace.v1.StudioBuildDetails(input_validation_results: ~cloudvision.api.arista.workspace.v1.InputValidationResults = <PLACEHOLDER>)

Bases: Message

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

input_validation_results: InputValidationResults = <PLACEHOLDER>

input_validation_results is a map from studio ID to InputValidationResult.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfiguration(key: ~cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationKey = <PLACEHOLDER>, generated_config: str | None = <PLACEHOLDER>)

Bases: Message

StudioGeneratedConfiguration returns the configuration generated by a studio for a given device.

generated_config: str | None = <PLACEHOLDER>

generated_config is the switch configuration generated by the studio.

key: StudioGeneratedConfigurationKey = <PLACEHOLDER>

key identifies the config.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationBatchedStreamRequest(partial_eq_filter: List[ForwardRef('StudioGeneratedConfiguration')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[StudioGeneratedConfiguration] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 StudioGeneratedConfiguration at end. * Each StudioGeneratedConfiguration response is fully-specified (all fields set).

• start: Returns the state of each StudioGeneratedConfiguration at start, followed by updates until now. * Each StudioGeneratedConfiguration response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each StudioGeneratedConfiguration at start, followed by updates until end. * Each StudioGeneratedConfiguration response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationBatchedStreamResponse(responses: List[ForwardRef('StudioGeneratedConfigurationStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[StudioGeneratedConfigurationStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationKey(workspace_id: str | None = <PLACEHOLDER>, build_id: str | None = <PLACEHOLDER>, device_id: str | None = <PLACEHOLDER>, studio: str | None = <PLACEHOLDER>)

Bases: Message

StudioGeneratedConfigurationKey identifies a generated config, either mainline or one unique to a workspace and build. To retrieve config from mainline, use “” for workspace_id and build_id.

build_id: str | None = <PLACEHOLDER>

build_id is the ID of the build.

device_id: str | None = <PLACEHOLDER>

device_id is the ID of the device.

studio: str | None = <PLACEHOLDER>

studio is the ID of the studio.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the ID of the workspace.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationRequest(key: 'StudioGeneratedConfigurationKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: StudioGeneratedConfigurationKey = <PLACEHOLDER>

Key uniquely identifies a StudioGeneratedConfiguration instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationResponse(value: 'StudioGeneratedConfiguration' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the StudioGeneratedConfiguration instance in this response.

value: StudioGeneratedConfiguration = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationServiceBase

Bases: ServiceBase

async get_all(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest) → AsyncIterator[StudioGeneratedConfigurationStreamResponse]

async get_all_batched(studio_generated_configuration_batched_stream_request: StudioGeneratedConfigurationBatchedStreamRequest) → AsyncIterator[StudioGeneratedConfigurationBatchedStreamResponse]

async get_meta(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest) → MetaResponse

async get_one(studio_generated_configuration_request: StudioGeneratedConfigurationRequest) → StudioGeneratedConfigurationResponse

async get_some(studio_generated_configuration_some_request: StudioGeneratedConfigurationSomeRequest) → AsyncIterator[StudioGeneratedConfigurationSomeResponse]

async subscribe(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest) → AsyncIterator[StudioGeneratedConfigurationStreamResponse]

async subscribe_batched(studio_generated_configuration_batched_stream_request: StudioGeneratedConfigurationBatchedStreamRequest) → AsyncIterator[StudioGeneratedConfigurationBatchedStreamResponse]

async subscribe_meta(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioGeneratedConfigurationStreamResponse]

async get_all_batched(studio_generated_configuration_batched_stream_request: StudioGeneratedConfigurationBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioGeneratedConfigurationBatchedStreamResponse]

async get_meta(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(studio_generated_configuration_request: StudioGeneratedConfigurationRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioGeneratedConfigurationResponse

async get_some(studio_generated_configuration_some_request: StudioGeneratedConfigurationSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioGeneratedConfigurationSomeResponse]

async subscribe(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioGeneratedConfigurationStreamResponse]

async subscribe_batched(studio_generated_configuration_batched_stream_request: StudioGeneratedConfigurationBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioGeneratedConfigurationBatchedStreamResponse]

async subscribe_meta(studio_generated_configuration_stream_request: StudioGeneratedConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationSomeRequest(keys: List[ForwardRef('StudioGeneratedConfigurationKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[StudioGeneratedConfigurationKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationSomeResponse(value: 'StudioGeneratedConfiguration' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the StudioGeneratedConfiguration instance in this response.

value: StudioGeneratedConfiguration = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationStreamRequest(partial_eq_filter: List[ForwardRef('StudioGeneratedConfiguration')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[StudioGeneratedConfiguration] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 StudioGeneratedConfiguration at end. * Each StudioGeneratedConfiguration response is fully-specified (all fields set).

• start: Returns the state of each StudioGeneratedConfiguration at start, followed by updates until now. * Each StudioGeneratedConfiguration response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each StudioGeneratedConfiguration at start, followed by updates until end. * Each StudioGeneratedConfiguration response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.StudioGeneratedConfigurationStreamResponse(value: 'StudioGeneratedConfiguration' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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

value: StudioGeneratedConfiguration = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.SyncOperation(value: int)

Bases: Enum

SyncOperation enumerates sync operations.

CONFIG = SyncOperation.CONFIG

SYNC_OPERATION_CONFIG indicates config sync operation.

UNSPECIFIED = SyncOperation.UNSPECIFIED

SYNC_OPERATION_UNSPECIFIED indicates unspecified sync operation.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.TemplateError(line_num: int | None = <PLACEHOLDER>, exception: str | None = <PLACEHOLDER>, detail: str | None = <PLACEHOLDER>, exception_msg: str | None = <PLACEHOLDER>)

Bases: Message

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

detail: str | None = <PLACEHOLDER>

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

exception: str | None = <PLACEHOLDER>

exception is the type of the exception thrown during the script execution. E.g., AssertionError, etc.

exception_msg: str | None = <PLACEHOLDER>

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

line_num: int | None = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.TemplateErrors(values: ~typing.List[~cloudvision.api.arista.workspace.v1.TemplateError] = <PLACEHOLDER>)

Bases: Message

TemplateErrors is a list of TemplateError.

values: List[TemplateError] = <PLACEHOLDER>

values is a list of TemplateError.

class cloudvision.api.arista.workspace.v1.Workspace(key: ~cloudvision.api.arista.workspace.v1.WorkspaceKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, state: ~cloudvision.api.arista.workspace.v1.WorkspaceState = <PLACEHOLDER>, last_build_id: str | None = <PLACEHOLDER>, responses: ~cloudvision.api.arista.workspace.v1.Responses = <PLACEHOLDER>, cc_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, needs_build: bool | None = <PLACEHOLDER>, last_rebased_at: ~datetime.datetime = <PLACEHOLDER>, needs_rebase: bool | None = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, exclude_network_provisioning: bool | None = <PLACEHOLDER>)

Bases: Message

Workspace holds the status of a workspace.

cc_ids: ___fmp__.RepeatedString = <PLACEHOLDER>

cc_ids are the IDs of any change controls that were created as a result of submitting this workspace.

created_at: datetime = <PLACEHOLDER>

created_at indicates when the workspace was created.

created_by: str | None = <PLACEHOLDER>

created_by indicates who created the workspace.

description: str | None = <PLACEHOLDER>

description is a brief description of the workspace.

display_name: str | None = <PLACEHOLDER>

display_name is the user-defined name of the workspace.

exclude_network_provisioning: bool | None = <PLACEHOLDER>

exclude_network_provisioning indicates whether the workspace is configured to exclude Network Provisioning.

key: WorkspaceKey = <PLACEHOLDER>

key identifies the workspace.

last_build_id: str | None = <PLACEHOLDER>

last_build_id is the last build ID that was set in a WorkspaceBuild for this workspace.

last_modified_at: datetime = <PLACEHOLDER>

last_modified_at indicates when the workspace was last updated.

last_modified_by: str | None = <PLACEHOLDER>

last_modified_by indicates who last updated the workspace.

last_rebased_at: datetime = <PLACEHOLDER>

last_rebased_at indicates when the workspace was last rebased.

needs_build: bool | None = <PLACEHOLDER>

needs_build indicates whether a rebuild of the workspace is necessary in order to submit it.

needs_rebase: bool | None = <PLACEHOLDER>

needs_rebase indicates whether a rebase of the workspace is necessary in order to submit it.

responses: Responses = <PLACEHOLDER>

responses are the responses for all requests that have been executed thusfar for this workspace.

state: WorkspaceState = <PLACEHOLDER>

state describes the status of the workspace.

class cloudvision.api.arista.workspace.v1.WorkspaceBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Workspace')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[Workspace] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBatchedStreamResponse(responses: List[ForwardRef('WorkspaceStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceBuild(key: ~cloudvision.api.arista.workspace.v1.WorkspaceBuildKey = <PLACEHOLDER>, state: ~cloudvision.api.arista.workspace.v1.BuildState = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, built_by: str | None = <PLACEHOLDER>, authz_result: ~cloudvision.api.arista.workspace.v1.AuthzResult = <PLACEHOLDER>, studio_build_details: ~cloudvision.api.arista.workspace.v1.StudioBuildDetails = <PLACEHOLDER>, hierarchy_build_status: ~cloudvision.api.arista.workspace.v1.HierarchyBuildStatus = <PLACEHOLDER>)

Bases: Message

WorkspaceBuild holds the details for a build of a workspace.

authz_result: AuthzResult = <PLACEHOLDER>

authz_result has the result of authorization check.

built_by: str | None = <PLACEHOLDER>

built_by is the details of subject who built the workspace.

error: str | None = <PLACEHOLDER>

error is an error message that is set if the build fails early before the per-device build result is computed.

hierarchy_build_status: HierarchyBuildStatus = <PLACEHOLDER>

hierarchy_build_status from the hierarchy build part of this workspace build

key: WorkspaceBuildKey = <PLACEHOLDER>

key identifies the build.

state: BuildState = <PLACEHOLDER>

state is the execution status of the build.

studio_build_details: StudioBuildDetails = <PLACEHOLDER>

studio_build_details has per studio results that are not specific to a device.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildBatchedStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceBuild')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[WorkspaceBuild] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildBatchedStreamResponse(responses: List[ForwardRef('WorkspaceBuildStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceBuildStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetails(key: ~cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsKey = <PLACEHOLDER>, state: ~cloudvision.api.arista.workspace.v1.BuildState = <PLACEHOLDER>, stage: ~cloudvision.api.arista.workspace.v1.BuildStage = <PLACEHOLDER>, input_validation_results: ~cloudvision.api.arista.workspace.v1.InputValidationResults = <PLACEHOLDER>, configlet_build_results: ~cloudvision.api.arista.workspace.v1.ConfigletBuildResults = <PLACEHOLDER>, config_validation_result: ~cloudvision.api.arista.workspace.v1.ConfigValidationResult = <PLACEHOLDER>, image_validation_result: ~cloudvision.api.arista.workspace.v1.ImageValidationResult = <PLACEHOLDER>, config_validation_skip_cause: ~cloudvision.api.arista.workspace.v1.ConfigValidationSkipCause = <PLACEHOLDER>, image_validation_skip_cause: ~cloudvision.api.arista.workspace.v1.ImageValidationSkipCause = <PLACEHOLDER>, build_stage_state: ~cloudvision.api.arista.workspace.v1.BuildStageState = <PLACEHOLDER>, authz_status: ~cloudvision.api.arista.workspace.v1.DeviceAuthzStatus = <PLACEHOLDER>, config_sync_result: ~cloudvision.api.arista.workspace.v1.ConfigSyncResult = <PLACEHOLDER>, config_sync_skip_cause: ~cloudvision.api.arista.workspace.v1.ConfigSyncSkipCause = <PLACEHOLDER>)

Bases: Message

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

authz_status: DeviceAuthzStatus = <PLACEHOLDER>

authz_status is the status of provision permission for the device.

build_stage_state: BuildStageState = <PLACEHOLDER>

build_stage_state is the state for each build stage.

config_sync_result: ConfigSyncResult = <PLACEHOLDER>

config_sync_result is the result of the config sync.

config_sync_skip_cause: ConfigSyncSkipCause = <PLACEHOLDER>

config_sync_skip_cause is the reason for skipping the config sync.

config_validation_result: ConfigValidationResult = <PLACEHOLDER>

config_validation_result is the result of the config validation stage.

config_validation_skip_cause: ConfigValidationSkipCause = <PLACEHOLDER>

config_validation_skip_cause is the reason, if any, that the config validation stage was skipped.

configlet_build_results: ConfigletBuildResults = <PLACEHOLDER>

configlet_build_results are the results of the configlet build stage.

image_validation_result: ImageValidationResult = <PLACEHOLDER>

image_validation_result is the result of the image validation stage.

image_validation_skip_cause: ImageValidationSkipCause = <PLACEHOLDER>

image_validation_skip_cause is the reason, if any, that the image validation stage was skipped.

input_validation_results: InputValidationResults = <PLACEHOLDER>

input_validation_results are the results of the input validation stage.

key: WorkspaceBuildDetailsKey = <PLACEHOLDER>

key identifies the build.

stage: BuildStage = <PLACEHOLDER>

stage is the stage of the build.

state: BuildState = <PLACEHOLDER>

state is the execution status of the build.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsBatchedStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceBuildDetails')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[WorkspaceBuildDetails] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsBatchedStreamResponse(responses: List[ForwardRef('WorkspaceBuildDetailsStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceBuildDetailsStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsKey(workspace_id: str | None = <PLACEHOLDER>, build_id: str | None = <PLACEHOLDER>, device_id: str | None = <PLACEHOLDER>)

Bases: Message

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

build_id: str | None = <PLACEHOLDER>

build_id is the ID of the build.

device_id: str | None = <PLACEHOLDER>

device_id is the ID of the device.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the ID of the workspace.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsRequest(key: 'WorkspaceBuildDetailsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceBuildDetailsKey = <PLACEHOLDER>

Key uniquely identifies a WorkspaceBuildDetails instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsResponse(value: 'WorkspaceBuildDetails' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceBuildDetails instance in this response.

value: WorkspaceBuildDetails = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsServiceBase

Bases: ServiceBase

async get_all(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest) → AsyncIterator[WorkspaceBuildDetailsStreamResponse]

async get_all_batched(workspace_build_details_batched_stream_request: WorkspaceBuildDetailsBatchedStreamRequest) → AsyncIterator[WorkspaceBuildDetailsBatchedStreamResponse]

async get_meta(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest) → MetaResponse

async get_one(workspace_build_details_request: WorkspaceBuildDetailsRequest) → WorkspaceBuildDetailsResponse

async get_some(workspace_build_details_some_request: WorkspaceBuildDetailsSomeRequest) → AsyncIterator[WorkspaceBuildDetailsSomeResponse]

async subscribe(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest) → AsyncIterator[WorkspaceBuildDetailsStreamResponse]

async subscribe_batched(workspace_build_details_batched_stream_request: WorkspaceBuildDetailsBatchedStreamRequest) → AsyncIterator[WorkspaceBuildDetailsBatchedStreamResponse]

async subscribe_meta(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildDetailsStreamResponse]

async get_all_batched(workspace_build_details_batched_stream_request: WorkspaceBuildDetailsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildDetailsBatchedStreamResponse]

async get_meta(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_build_details_request: WorkspaceBuildDetailsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceBuildDetailsResponse

async get_some(workspace_build_details_some_request: WorkspaceBuildDetailsSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildDetailsSomeResponse]

async subscribe(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildDetailsStreamResponse]

async subscribe_batched(workspace_build_details_batched_stream_request: WorkspaceBuildDetailsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildDetailsBatchedStreamResponse]

async subscribe_meta(workspace_build_details_stream_request: WorkspaceBuildDetailsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsSomeRequest(keys: List[ForwardRef('WorkspaceBuildDetailsKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceBuildDetailsKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsSomeResponse(value: 'WorkspaceBuildDetails' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceBuildDetails instance in this response.

value: WorkspaceBuildDetails = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceBuildDetails')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceBuildDetails] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildDetailsStreamResponse(value: 'WorkspaceBuildDetails' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: WorkspaceBuildDetails = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildKey(workspace_id: str | None = <PLACEHOLDER>, build_id: str | None = <PLACEHOLDER>)

Bases: Message

WorkspaceBuildKey uniquely identifies a build for a workspace.

build_id: str | None = <PLACEHOLDER>

build_id is the ID of the build.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the ID of the workspace.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildRequest(key: 'WorkspaceBuildKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceBuildKey = <PLACEHOLDER>

Key uniquely identifies a WorkspaceBuild instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildResponse(value: 'WorkspaceBuild' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceBuild instance in this response.

value: WorkspaceBuild = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildServiceBase

Bases: ServiceBase

async get_all(workspace_build_stream_request: WorkspaceBuildStreamRequest) → AsyncIterator[WorkspaceBuildStreamResponse]

async get_all_batched(workspace_build_batched_stream_request: WorkspaceBuildBatchedStreamRequest) → AsyncIterator[WorkspaceBuildBatchedStreamResponse]

async get_meta(workspace_build_stream_request: WorkspaceBuildStreamRequest) → MetaResponse

async get_one(workspace_build_request: WorkspaceBuildRequest) → WorkspaceBuildResponse

async get_some(workspace_build_some_request: WorkspaceBuildSomeRequest) → AsyncIterator[WorkspaceBuildSomeResponse]

async subscribe(workspace_build_stream_request: WorkspaceBuildStreamRequest) → AsyncIterator[WorkspaceBuildStreamResponse]

async subscribe_batched(workspace_build_batched_stream_request: WorkspaceBuildBatchedStreamRequest) → AsyncIterator[WorkspaceBuildBatchedStreamResponse]

async subscribe_meta(workspace_build_stream_request: WorkspaceBuildStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceBuildServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(workspace_build_stream_request: WorkspaceBuildStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildStreamResponse]

async get_all_batched(workspace_build_batched_stream_request: WorkspaceBuildBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildBatchedStreamResponse]

async get_meta(workspace_build_stream_request: WorkspaceBuildStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_build_request: WorkspaceBuildRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceBuildResponse

async get_some(workspace_build_some_request: WorkspaceBuildSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildSomeResponse]

async subscribe(workspace_build_stream_request: WorkspaceBuildStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildStreamResponse]

async subscribe_batched(workspace_build_batched_stream_request: WorkspaceBuildBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBuildBatchedStreamResponse]

async subscribe_meta(workspace_build_stream_request: WorkspaceBuildStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceBuildSomeRequest(keys: List[ForwardRef('WorkspaceBuildKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceBuildKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildSomeResponse(value: 'WorkspaceBuild' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceBuild instance in this response.

value: WorkspaceBuild = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceBuild')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceBuild] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceBuildStreamResponse(value: 'WorkspaceBuild' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: WorkspaceBuild = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfig(key: ~cloudvision.api.arista.workspace.v1.WorkspaceKey = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, request: ~cloudvision.api.arista.workspace.v1.Request = <PLACEHOLDER>, request_params: ~cloudvision.api.arista.workspace.v1.RequestParams = <PLACEHOLDER>, exclude_network_provisioning: bool | None = <PLACEHOLDER>)

Bases: Message

WorkspaceConfig holds the configuration of a workspace.

description: str | None = <PLACEHOLDER>

description is a brief description of the workspace.

display_name: str | None = <PLACEHOLDER>

display_name is the user-defined name of the workspace.

exclude_network_provisioning: bool | None = <PLACEHOLDER>

exclude_network_provisioning is a flag used to manage the migration from Network Provisioning to Studios. When set to true, it prevents Network Provisioning components from being included in the build process and in the designed config generated upon submission. This flag is set exclusively at the start of the migration process. This field must not be set for workspaces in “Studios-only” mode or after a migration is complete. Any attempt to submit a workspace where this field is true in these states will result in a failure.

key: WorkspaceKey = <PLACEHOLDER>

key identifies the workspace.

request: Request = <PLACEHOLDER>

request (if not REQUEST_UNSPECIFIED) kicks off an asynchronous operation on the workspace.

request_params: RequestParams = <PLACEHOLDER>

request_params specify the parameters for request.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[WorkspaceConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigBatchedStreamResponse(responses: List[ForwardRef('WorkspaceConfigStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceConfigStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('WorkspaceConfig')] = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceConfig] = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'WorkspaceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

This indicates the error message from the delete failure.

key: WorkspaceKey = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

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

type: ___fmp__.DeleteError = <PLACEHOLDER>

This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteRequest(key: 'WorkspaceKey' = <PLACEHOLDER>)

Bases: Message

key: WorkspaceKey = <PLACEHOLDER>

Key indicates which WorkspaceConfig instance to remove. This field must always be set.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteResponse(key: 'WorkspaceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceKey = <PLACEHOLDER>

Key echoes back the key of the deleted WorkspaceConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteSomeRequest(keys: List[ForwardRef('WorkspaceKey')] = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceKey] = <PLACEHOLDER>

key contains a list of WorkspaceConfig keys to delete

class cloudvision.api.arista.workspace.v1.WorkspaceConfigDeleteSomeResponse(key: ~cloudvision.api.arista.workspace.v1.WorkspaceKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

WorkspaceConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: WorkspaceKey = <PLACEHOLDER>

class cloudvision.api.arista.workspace.v1.WorkspaceConfigRequest(key: 'WorkspaceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceKey = <PLACEHOLDER>

Key uniquely identifies a WorkspaceConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigResponse(value: 'WorkspaceConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceConfig instance in this response.

value: WorkspaceConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigServiceBase

Bases: ServiceBase

async delete(workspace_config_delete_request: WorkspaceConfigDeleteRequest) → WorkspaceConfigDeleteResponse

async delete_all(workspace_config_delete_all_request: WorkspaceConfigDeleteAllRequest) → AsyncIterator[WorkspaceConfigDeleteAllResponse]

async delete_some(workspace_config_delete_some_request: WorkspaceConfigDeleteSomeRequest) → AsyncIterator[WorkspaceConfigDeleteSomeResponse]

async get_all(workspace_config_stream_request: WorkspaceConfigStreamRequest) → AsyncIterator[WorkspaceConfigStreamResponse]

async get_all_batched(workspace_config_batched_stream_request: WorkspaceConfigBatchedStreamRequest) → AsyncIterator[WorkspaceConfigBatchedStreamResponse]

async get_meta(workspace_config_stream_request: WorkspaceConfigStreamRequest) → MetaResponse

async get_one(workspace_config_request: WorkspaceConfigRequest) → WorkspaceConfigResponse

async get_some(workspace_config_some_request: WorkspaceConfigSomeRequest) → AsyncIterator[WorkspaceConfigSomeResponse]

async set(workspace_config_set_request: WorkspaceConfigSetRequest) → WorkspaceConfigSetResponse

async set_some(workspace_config_set_some_request: WorkspaceConfigSetSomeRequest) → AsyncIterator[WorkspaceConfigSetSomeResponse]

async subscribe(workspace_config_stream_request: WorkspaceConfigStreamRequest) → AsyncIterator[WorkspaceConfigStreamResponse]

async subscribe_batched(workspace_config_batched_stream_request: WorkspaceConfigBatchedStreamRequest) → AsyncIterator[WorkspaceConfigBatchedStreamResponse]

async subscribe_meta(workspace_config_stream_request: WorkspaceConfigStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceConfigServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async delete(workspace_config_delete_request: WorkspaceConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceConfigDeleteResponse

async delete_all(workspace_config_delete_all_request: WorkspaceConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigDeleteAllResponse]

async delete_some(workspace_config_delete_some_request: WorkspaceConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigDeleteSomeResponse]

async get_all(workspace_config_stream_request: WorkspaceConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigStreamResponse]

async get_all_batched(workspace_config_batched_stream_request: WorkspaceConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigBatchedStreamResponse]

async get_meta(workspace_config_stream_request: WorkspaceConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_config_request: WorkspaceConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceConfigResponse

async get_some(workspace_config_some_request: WorkspaceConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigSomeResponse]

async set(workspace_config_set_request: WorkspaceConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceConfigSetResponse

async set_some(workspace_config_set_some_request: WorkspaceConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigSetSomeResponse]

async subscribe(workspace_config_stream_request: WorkspaceConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigStreamResponse]

async subscribe_batched(workspace_config_batched_stream_request: WorkspaceConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceConfigBatchedStreamResponse]

async subscribe_meta(workspace_config_stream_request: WorkspaceConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSetRequest(value: 'WorkspaceConfig' = <PLACEHOLDER>)

Bases: Message

value: WorkspaceConfig = <PLACEHOLDER>

WorkspaceConfig carries the value to set into the datastore. See the documentation on the WorkspaceConfig struct for which fields are required.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSetResponse(value: 'WorkspaceConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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: WorkspaceConfig = <PLACEHOLDER>

Value carries all the values given in the WorkspaceConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSetSomeRequest(values: List[ForwardRef('WorkspaceConfig')] = <PLACEHOLDER>)

Bases: Message

values: List[WorkspaceConfig] = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSetSomeResponse(key: 'WorkspaceKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

error: str = <PLACEHOLDER>

key: WorkspaceKey = <PLACEHOLDER>

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSomeRequest(keys: List[ForwardRef('WorkspaceKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigSomeResponse(value: 'WorkspaceConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceConfig instance in this response.

value: WorkspaceConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceConfigStreamResponse(value: 'WorkspaceConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: WorkspaceConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffSet(workspace_a: str | None = <PLACEHOLDER>, workspace_b: str | None = <PLACEHOLDER>, entries: ~cloudvision.api.arista.workspace.v1.DiffEntries = <PLACEHOLDER>)

Bases: Message

WorkspaceDiffSet represents diffs between two specific workspaces.

entries: DiffEntries = <PLACEHOLDER>

entries indicates multiple entity diffs.

workspace_a: str | None = <PLACEHOLDER>

workspace_a is the unique identifier for the first workspace being compared.

workspace_b: str | None = <PLACEHOLDER>

workspace_b is the unique identifier for the second workspace being compared.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffSets(values: ~typing.List[~cloudvision.api.arista.workspace.v1.WorkspaceDiffSet] = <PLACEHOLDER>)

Bases: Message

WorkspaceDiffSets represents a collection of WorkspaceDiffSet messages, allowing for the representation of diffs across multiple pairs of workspaces.

values: List[WorkspaceDiffSet] = <PLACEHOLDER>

values contains a list of WorkspaceDiffSet messages, each detailing the differences between a pair of workspaces.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffs(key: ~cloudvision.api.arista.workspace.v1.DiffKey = <PLACEHOLDER>, diffs: ~cloudvision.api.arista.workspace.v1.WorkspaceDiffSets = <PLACEHOLDER>)

Bases: Message

WorkspaceDiffs represents diffs, or changes made in the workspace of a given type.

diffs: WorkspaceDiffSets = <PLACEHOLDER>

diffs contains a collection of comparisons between pairs of workspaces. Each entry within ‘values’ in WorkspaceDiffSets defines a specific pair of workspaces being compared: ‘workspace_a’ typically represents the “source”, e.g., the current mainline, or an older version. ‘workspace_b’ typically represents the “target”, e.g., the current workspace identified in the top-level DiffKey.workspace_id. The differences described in ‘entries’ are calculated from ‘workspace_a’ to ‘workspace_b’.

key: DiffKey = <PLACEHOLDER>

key uniquely identifies this particular collection of diffs. It sets the primary context, indicating which workspace (via DiffKey.workspace_id) is the subject of these diffs, the overall type of diff operation (e.g., rebase), and the kind of entity that is primarily being analyzed.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsBatchedStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceDiffs')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[WorkspaceDiffs] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 WorkspaceDiffs at end. * Each WorkspaceDiffs response is fully-specified (all fields set).

• start: Returns the state of each WorkspaceDiffs at start, followed by updates until now. * Each WorkspaceDiffs response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each WorkspaceDiffs at start, followed by updates until end. * Each WorkspaceDiffs response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsBatchedStreamResponse(responses: List[ForwardRef('WorkspaceDiffsStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceDiffsStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsRequest(key: 'DiffKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: DiffKey = <PLACEHOLDER>

Key uniquely identifies a WorkspaceDiffs instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsResponse(value: 'WorkspaceDiffs' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceDiffs instance in this response.

value: WorkspaceDiffs = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsServiceBase

Bases: ServiceBase

async get_all(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest) → AsyncIterator[WorkspaceDiffsStreamResponse]

async get_all_batched(workspace_diffs_batched_stream_request: WorkspaceDiffsBatchedStreamRequest) → AsyncIterator[WorkspaceDiffsBatchedStreamResponse]

async get_meta(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest) → MetaResponse

async get_one(workspace_diffs_request: WorkspaceDiffsRequest) → WorkspaceDiffsResponse

async get_some(workspace_diffs_some_request: WorkspaceDiffsSomeRequest) → AsyncIterator[WorkspaceDiffsSomeResponse]

async subscribe(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest) → AsyncIterator[WorkspaceDiffsStreamResponse]

async subscribe_batched(workspace_diffs_batched_stream_request: WorkspaceDiffsBatchedStreamRequest) → AsyncIterator[WorkspaceDiffsBatchedStreamResponse]

async subscribe_meta(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceDiffsStreamResponse]

async get_all_batched(workspace_diffs_batched_stream_request: WorkspaceDiffsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceDiffsBatchedStreamResponse]

async get_meta(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_diffs_request: WorkspaceDiffsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceDiffsResponse

async get_some(workspace_diffs_some_request: WorkspaceDiffsSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceDiffsSomeResponse]

async subscribe(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceDiffsStreamResponse]

async subscribe_batched(workspace_diffs_batched_stream_request: WorkspaceDiffsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceDiffsBatchedStreamResponse]

async subscribe_meta(workspace_diffs_stream_request: WorkspaceDiffsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsSomeRequest(keys: List[ForwardRef('DiffKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[DiffKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsSomeResponse(value: 'WorkspaceDiffs' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceDiffs instance in this response.

value: WorkspaceDiffs = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceDiffs')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceDiffs] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 WorkspaceDiffs at end. * Each WorkspaceDiffs response is fully-specified (all fields set).

• start: Returns the state of each WorkspaceDiffs at start, followed by updates until now. * Each WorkspaceDiffs response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each WorkspaceDiffs at start, followed by updates until end. * Each WorkspaceDiffs response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.WorkspaceDiffsStreamResponse(value: 'WorkspaceDiffs' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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

value: WorkspaceDiffs = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceKey(workspace_id: str | None = <PLACEHOLDER>)

Bases: Message

WorkspaceKey uniquely identifies a workspace.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the unique ID of the workspace.

class cloudvision.api.arista.workspace.v1.WorkspaceRequest(key: 'WorkspaceKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceKey = <PLACEHOLDER>

Key uniquely identifies a Workspace instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceResponse(value: 'Workspace' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the Workspace instance in this response.

value: Workspace = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceServiceBase

Bases: ServiceBase

async get_all(workspace_stream_request: WorkspaceStreamRequest) → AsyncIterator[WorkspaceStreamResponse]

async get_all_batched(workspace_batched_stream_request: WorkspaceBatchedStreamRequest) → AsyncIterator[WorkspaceBatchedStreamResponse]

async get_meta(workspace_stream_request: WorkspaceStreamRequest) → MetaResponse

async get_one(workspace_request: WorkspaceRequest) → WorkspaceResponse

async get_some(workspace_some_request: WorkspaceSomeRequest) → AsyncIterator[WorkspaceSomeResponse]

async subscribe(workspace_stream_request: WorkspaceStreamRequest) → AsyncIterator[WorkspaceStreamResponse]

async subscribe_batched(workspace_batched_stream_request: WorkspaceBatchedStreamRequest) → AsyncIterator[WorkspaceBatchedStreamResponse]

async subscribe_meta(workspace_stream_request: WorkspaceStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async get_all(workspace_stream_request: WorkspaceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceStreamResponse]

async get_all_batched(workspace_batched_stream_request: WorkspaceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBatchedStreamResponse]

async get_meta(workspace_stream_request: WorkspaceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_request: WorkspaceRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceResponse

async get_some(workspace_some_request: WorkspaceSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSomeResponse]

async subscribe(workspace_stream_request: WorkspaceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceStreamResponse]

async subscribe_batched(workspace_batched_stream_request: WorkspaceBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceBatchedStreamResponse]

async subscribe_meta(workspace_stream_request: WorkspaceStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceSomeRequest(keys: List[ForwardRef('WorkspaceKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSomeResponse(value: 'Workspace' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the Workspace instance in this response.

value: Workspace = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceState(value: int)

Bases: Enum

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

ABANDONED = WorkspaceState.ABANDONED

WORKSPACE_STATE_ABANDONED indicates that the workspace has been intentionally closed, and may no longer be updated.

CONFLICTS = WorkspaceState.CONFLICTS

WORKSPACE_STATE_CONFLICTS indicates that the changes in the workspace are in conflict with the current state of the system.

PENDING = WorkspaceState.PENDING

WORKSPACE_STATE_PENDING indicates that the changes in the workspace are open and have not been submitted.

ROLLED_BACK = WorkspaceState.ROLLED_BACK

WORKSPACE_STATE_ROLLED_BACK indicates that the workspace was submitted, but has been rolled back (the changes have been undone).

SUBMITTED = WorkspaceState.SUBMITTED

WORKSPACE_STATE_SUBMITTED indicates that the changes in the workspace have been submitted to the mainline.

UNSPECIFIED = WorkspaceState.UNSPECIFIED

WORKSPACE_STATE_UNSPECIFIED indicates unspecified workspace state.

name: str | None

value: int

class cloudvision.api.arista.workspace.v1.WorkspaceStreamRequest(partial_eq_filter: List[ForwardRef('Workspace')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[Workspace] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceStreamResponse(value: 'Workspace' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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.

value: Workspace = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfig(key: ~cloudvision.api.arista.workspace.v1.WorkspaceSyncKey = <PLACEHOLDER>, device_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)

Bases: Message

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

device_ids: ___fmp__.RepeatedString = <PLACEHOLDER>

device_ids is the list of device Ids to be synced in the workspace.

key: WorkspaceSyncKey = <PLACEHOLDER>

key uniquely identifies sync operations to be performed in workspace.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceSyncConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)

Bases: Message

max_messages: int | None = <PLACEHOLDER>

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.

partial_eq_filter: List[WorkspaceSyncConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 WorkspaceSyncConfig at end. * Each WorkspaceSyncConfig response is fully-specified (all fields set).

• start: Returns the state of each WorkspaceSyncConfig at start, followed by updates until now. * Each WorkspaceSyncConfig response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each WorkspaceSyncConfig at start, followed by updates until end. * Each WorkspaceSyncConfig response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigBatchedStreamResponse(responses: List[ForwardRef('WorkspaceSyncConfigStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[WorkspaceSyncConfigStreamResponse] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('WorkspaceSyncConfig')] = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceSyncConfig] = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'WorkspaceSyncKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

This indicates the error message from the delete failure.

key: WorkspaceSyncKey = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

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

type: ___fmp__.DeleteError = <PLACEHOLDER>

This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteRequest(key: 'WorkspaceSyncKey' = <PLACEHOLDER>)

Bases: Message

key: WorkspaceSyncKey = <PLACEHOLDER>

Key indicates which WorkspaceSyncConfig instance to remove. This field must always be set.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteResponse(key: 'WorkspaceSyncKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceSyncKey = <PLACEHOLDER>

Key echoes back the key of the deleted WorkspaceSyncConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteSomeRequest(keys: List[ForwardRef('WorkspaceSyncKey')] = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceSyncKey] = <PLACEHOLDER>

key contains a list of WorkspaceSyncConfig keys to delete

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigDeleteSomeResponse(key: ~cloudvision.api.arista.workspace.v1.WorkspaceSyncKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

WorkspaceSyncConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: WorkspaceSyncKey = <PLACEHOLDER>

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigRequest(key: 'WorkspaceSyncKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: WorkspaceSyncKey = <PLACEHOLDER>

Key uniquely identifies a WorkspaceSyncConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigResponse(value: 'WorkspaceSyncConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceSyncConfig instance in this response.

value: WorkspaceSyncConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigServiceBase

Bases: ServiceBase

async delete(workspace_sync_config_delete_request: WorkspaceSyncConfigDeleteRequest) → WorkspaceSyncConfigDeleteResponse

async delete_all(workspace_sync_config_delete_all_request: WorkspaceSyncConfigDeleteAllRequest) → AsyncIterator[WorkspaceSyncConfigDeleteAllResponse]

async delete_some(workspace_sync_config_delete_some_request: WorkspaceSyncConfigDeleteSomeRequest) → AsyncIterator[WorkspaceSyncConfigDeleteSomeResponse]

async get_all(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest) → AsyncIterator[WorkspaceSyncConfigStreamResponse]

async get_all_batched(workspace_sync_config_batched_stream_request: WorkspaceSyncConfigBatchedStreamRequest) → AsyncIterator[WorkspaceSyncConfigBatchedStreamResponse]

async get_meta(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest) → MetaResponse

async get_one(workspace_sync_config_request: WorkspaceSyncConfigRequest) → WorkspaceSyncConfigResponse

async get_some(workspace_sync_config_some_request: WorkspaceSyncConfigSomeRequest) → AsyncIterator[WorkspaceSyncConfigSomeResponse]

async set(workspace_sync_config_set_request: WorkspaceSyncConfigSetRequest) → WorkspaceSyncConfigSetResponse

async set_some(workspace_sync_config_set_some_request: WorkspaceSyncConfigSetSomeRequest) → AsyncIterator[WorkspaceSyncConfigSetSomeResponse]

async subscribe(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest) → AsyncIterator[WorkspaceSyncConfigStreamResponse]

async subscribe_batched(workspace_sync_config_batched_stream_request: WorkspaceSyncConfigBatchedStreamRequest) → AsyncIterator[WorkspaceSyncConfigBatchedStreamResponse]

async subscribe_meta(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async delete(workspace_sync_config_delete_request: WorkspaceSyncConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceSyncConfigDeleteResponse

async delete_all(workspace_sync_config_delete_all_request: WorkspaceSyncConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigDeleteAllResponse]

async delete_some(workspace_sync_config_delete_some_request: WorkspaceSyncConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigDeleteSomeResponse]

async get_all(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigStreamResponse]

async get_all_batched(workspace_sync_config_batched_stream_request: WorkspaceSyncConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigBatchedStreamResponse]

async get_meta(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse

async get_one(workspace_sync_config_request: WorkspaceSyncConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceSyncConfigResponse

async get_some(workspace_sync_config_some_request: WorkspaceSyncConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigSomeResponse]

async set(workspace_sync_config_set_request: WorkspaceSyncConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → WorkspaceSyncConfigSetResponse

async set_some(workspace_sync_config_set_some_request: WorkspaceSyncConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigSetSomeResponse]

async subscribe(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigStreamResponse]

async subscribe_batched(workspace_sync_config_batched_stream_request: WorkspaceSyncConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[WorkspaceSyncConfigBatchedStreamResponse]

async subscribe_meta(workspace_sync_config_stream_request: WorkspaceSyncConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse]

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSetRequest(value: 'WorkspaceSyncConfig' = <PLACEHOLDER>)

Bases: Message

value: WorkspaceSyncConfig = <PLACEHOLDER>

WorkspaceSyncConfig carries the value to set into the datastore. See the documentation on the WorkspaceSyncConfig struct for which fields are required.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSetResponse(value: 'WorkspaceSyncConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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: WorkspaceSyncConfig = <PLACEHOLDER>

Value carries all the values given in the WorkspaceSyncConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSetSomeRequest(values: List[ForwardRef('WorkspaceSyncConfig')] = <PLACEHOLDER>)

Bases: Message

values: List[WorkspaceSyncConfig] = <PLACEHOLDER>

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

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSetSomeResponse(key: 'WorkspaceSyncKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)

Bases: Message

error: str = <PLACEHOLDER>

key: WorkspaceSyncKey = <PLACEHOLDER>

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSomeRequest(keys: List[ForwardRef('WorkspaceSyncKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[WorkspaceSyncKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigSomeResponse(value: 'WorkspaceSyncConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the WorkspaceSyncConfig instance in this response.

value: WorkspaceSyncConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigStreamRequest(partial_eq_filter: List[ForwardRef('WorkspaceSyncConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

partial_eq_filter: List[WorkspaceSyncConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 WorkspaceSyncConfig at end. * Each WorkspaceSyncConfig response is fully-specified (all fields set).

• start: Returns the state of each WorkspaceSyncConfig at start, followed by updates until now. * Each WorkspaceSyncConfig response at start is fully-specified, but updates may be partial.

• start and end: Returns the state of each WorkspaceSyncConfig at start, followed by updates until end. * Each WorkspaceSyncConfig response at start is fully-specified, but updates until end may

  be partial.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncConfigStreamResponse(value: 'WorkspaceSyncConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

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

value: WorkspaceSyncConfig = <PLACEHOLDER>

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.

class cloudvision.api.arista.workspace.v1.WorkspaceSyncKey(workspace_id: str | None = <PLACEHOLDER>, sync_operation: ~cloudvision.api.arista.workspace.v1.SyncOperation = <PLACEHOLDER>)

Bases: Message

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

sync_operation: SyncOperation = <PLACEHOLDER>

sync_operation is type of sync operation to be performed on devices.

workspace_id: str | None = <PLACEHOLDER>

workspace_id is the ID of the workspace.