cloudvision.api.arista.studio.v1 package

Module contents

class cloudvision.api.arista.studio.v1.AssignedTags(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, query: str | None = <PLACEHOLDER>)[source]

Bases: Message

AssignedTags can be used to retrieve additional metadata about a studio’s AssignedTagsConfig.

created_at: datetime = <PLACEHOLDER>: created_at is the time at which the assignment was first created.

created_by: str | None = <PLACEHOLDER>: created_by is the name of the user that created the assignment.

key: StudioKey = <PLACEHOLDER>: key uniquely identifies the studio to which devices were assigned.

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the assignment was last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the name of the user that last modified the assignment.

query: str | None = <PLACEHOLDER>: query is a tag query string that conforms to the CloudVision tag query language. See AssignedTagsConfig.

class cloudvision.api.arista.studio.v1.AssignedTagsBatchedStreamRequest(partial_eq_filter: List[ForwardRef('AssignedTags')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.AssignedTagsBatchedStreamResponse(responses: List[ForwardRef('AssignedTagsStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[AssignedTagsStreamResponse] = <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.studio.v1.AssignedTagsConfig(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, query: str | None = <PLACEHOLDER>)[source]

Bases: Message

AssignedTagsConfig holds a configuration to assign a studio to a set of devices matching a tag query.

key: StudioKey = <PLACEHOLDER>: key uniquely identifies the studio to which to assign devices.

query: str | None = <PLACEHOLDER>: query is a tag query string that conforms to the CloudVision tag query language. E.g., the query, “datacenter:NYC,SFO AND sflow:enabled”, matches all devices with sflow enabled in data centers NYC and SFO.

remove: bool | None = <PLACEHOLDER>: remove indicates whether to remove (true) or add (false, unset) the tag assignments involving the studio identified by the key if the encompassing workspace merges. Other data fields are not allowed if this field is set to true.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('AssignedTagsConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigBatchedStreamResponse(responses: List[ForwardRef('AssignedTagsConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[AssignedTagsConfigStreamResponse] = <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.studio.v1.AssignedTagsConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('AssignedTagsConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AssignedTagsConfig] = <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.studio.v1.AssignedTagsConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: StudioKey = <PLACEHOLDER>: This is the key of the AssignedTagsConfig 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.studio.v1.AssignedTagsConfigDeleteRequest(key: 'StudioKey' = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key indicates which AssignedTagsConfig instance to remove. This field must always be set.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigDeleteResponse(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key echoes back the key of the deleted AssignedTagsConfig 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.studio.v1.AssignedTagsConfigDeleteSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <PLACEHOLDER>: key contains a list of AssignedTagsConfig keys to delete

class cloudvision.api.arista.studio.v1.AssignedTagsConfigDeleteSomeResponse(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

AssignedTagsConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: StudioKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.AssignedTagsConfigRequest(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key uniquely identifies a AssignedTagsConfig 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.studio.v1.AssignedTagsConfigResponse(value: 'AssignedTagsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the AssignedTagsConfig instance in this response.

value: AssignedTagsConfig = <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.studio.v1.AssignedTagsConfigServiceBase[source]

Bases: ServiceBase

async delete(assigned_tags_config_delete_request: AssignedTagsConfigDeleteRequest) → AssignedTagsConfigDeleteResponse[source]

async delete_all(assigned_tags_config_delete_all_request: AssignedTagsConfigDeleteAllRequest) → AsyncIterator[AssignedTagsConfigDeleteAllResponse][source]

async delete_some(assigned_tags_config_delete_some_request: AssignedTagsConfigDeleteSomeRequest) → AsyncIterator[AssignedTagsConfigDeleteSomeResponse][source]

async get_all(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest) → AsyncIterator[AssignedTagsConfigStreamResponse][source]

async get_all_batched(assigned_tags_config_batched_stream_request: AssignedTagsConfigBatchedStreamRequest) → AsyncIterator[AssignedTagsConfigBatchedStreamResponse][source]

async get_meta(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest) → MetaResponse[source]

async get_one(assigned_tags_config_request: AssignedTagsConfigRequest) → AssignedTagsConfigResponse[source]

async get_some(assigned_tags_config_some_request: AssignedTagsConfigSomeRequest) → AsyncIterator[AssignedTagsConfigSomeResponse][source]

async set(assigned_tags_config_set_request: AssignedTagsConfigSetRequest) → AssignedTagsConfigSetResponse[source]

async set_some(assigned_tags_config_set_some_request: AssignedTagsConfigSetSomeRequest) → AsyncIterator[AssignedTagsConfigSetSomeResponse][source]

async subscribe(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest) → AsyncIterator[AssignedTagsConfigStreamResponse][source]

async subscribe_batched(assigned_tags_config_batched_stream_request: AssignedTagsConfigBatchedStreamRequest) → AsyncIterator[AssignedTagsConfigBatchedStreamResponse][source]

async subscribe_meta(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(assigned_tags_config_delete_request: AssignedTagsConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AssignedTagsConfigDeleteResponse[source]

async delete_all(assigned_tags_config_delete_all_request: AssignedTagsConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigDeleteAllResponse][source]

async delete_some(assigned_tags_config_delete_some_request: AssignedTagsConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigDeleteSomeResponse][source]

async get_all(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigStreamResponse][source]

async get_all_batched(assigned_tags_config_batched_stream_request: AssignedTagsConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigBatchedStreamResponse][source]

async get_meta(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(assigned_tags_config_request: AssignedTagsConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AssignedTagsConfigResponse[source]

async get_some(assigned_tags_config_some_request: AssignedTagsConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigSomeResponse][source]

async set(assigned_tags_config_set_request: AssignedTagsConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AssignedTagsConfigSetResponse[source]

async set_some(assigned_tags_config_set_some_request: AssignedTagsConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigSetSomeResponse][source]

async subscribe(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigStreamResponse][source]

async subscribe_batched(assigned_tags_config_batched_stream_request: AssignedTagsConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsConfigBatchedStreamResponse][source]

async subscribe_meta(assigned_tags_config_stream_request: AssignedTagsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.AssignedTagsConfigSetRequest(value: 'AssignedTagsConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: AssignedTagsConfig = <PLACEHOLDER>: AssignedTagsConfig carries the value to set into the datastore. See the documentation on the AssignedTagsConfig struct for which fields are required.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigSetResponse(value: 'AssignedTagsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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: AssignedTagsConfig = <PLACEHOLDER>: Value carries all the values given in the AssignedTagsConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigSetSomeRequest(values: List[ForwardRef('AssignedTagsConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[AssignedTagsConfig] = <PLACEHOLDER>

value contains a list of AssignedTagsConfig 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.studio.v1.AssignedTagsConfigSetSomeResponse(key: 'StudioKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: StudioKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.AssignedTagsConfigSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <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.studio.v1.AssignedTagsConfigSomeResponse(value: 'AssignedTagsConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 AssignedTagsConfig instance in this response.

value: AssignedTagsConfig = <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.studio.v1.AssignedTagsConfigStreamRequest(partial_eq_filter: List[ForwardRef('AssignedTagsConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AssignedTagsConfig] = <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 AssignedTagsConfig at end. * Each AssignedTagsConfig response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.AssignedTagsConfigStreamResponse(value: 'AssignedTagsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this AssignedTagsConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the AssignedTagsConfig 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: AssignedTagsConfig = <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.studio.v1.AssignedTagsRequest(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key uniquely identifies a AssignedTags 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.studio.v1.AssignedTagsResponse(value: 'AssignedTags' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the AssignedTags instance in this response.

value: AssignedTags = <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.studio.v1.AssignedTagsServiceBase[source]

Bases: ServiceBase

async get_all(assigned_tags_stream_request: AssignedTagsStreamRequest) → AsyncIterator[AssignedTagsStreamResponse][source]

async get_all_batched(assigned_tags_batched_stream_request: AssignedTagsBatchedStreamRequest) → AsyncIterator[AssignedTagsBatchedStreamResponse][source]

async get_meta(assigned_tags_stream_request: AssignedTagsStreamRequest) → MetaResponse[source]

async get_one(assigned_tags_request: AssignedTagsRequest) → AssignedTagsResponse[source]

async get_some(assigned_tags_some_request: AssignedTagsSomeRequest) → AsyncIterator[AssignedTagsSomeResponse][source]

async subscribe(assigned_tags_stream_request: AssignedTagsStreamRequest) → AsyncIterator[AssignedTagsStreamResponse][source]

async subscribe_batched(assigned_tags_batched_stream_request: AssignedTagsBatchedStreamRequest) → AsyncIterator[AssignedTagsBatchedStreamResponse][source]

async subscribe_meta(assigned_tags_stream_request: AssignedTagsStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(assigned_tags_stream_request: AssignedTagsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsStreamResponse][source]

async get_all_batched(assigned_tags_batched_stream_request: AssignedTagsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsBatchedStreamResponse][source]

async get_meta(assigned_tags_stream_request: AssignedTagsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(assigned_tags_request: AssignedTagsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AssignedTagsResponse[source]

async get_some(assigned_tags_some_request: AssignedTagsSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsSomeResponse][source]

async subscribe(assigned_tags_stream_request: AssignedTagsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsStreamResponse][source]

async subscribe_batched(assigned_tags_batched_stream_request: AssignedTagsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignedTagsBatchedStreamResponse][source]

async subscribe_meta(assigned_tags_stream_request: AssignedTagsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.AssignedTagsSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <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.studio.v1.AssignedTagsSomeResponse(value: 'AssignedTags' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 AssignedTags instance in this response.

value: AssignedTags = <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.studio.v1.AssignedTagsStreamRequest(partial_eq_filter: List[ForwardRef('AssignedTags')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AssignedTags] = <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 AssignedTags at end. * Each AssignedTags response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.AssignedTagsStreamResponse(value: 'AssignedTags' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this AssignedTags’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the AssignedTags 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: AssignedTags = <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.studio.v1.AutofillAction(key: ~cloudvision.api.arista.studio.v1.AutofillActionKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, action_id: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, argument_providers: ~cloudvision.api.arista.studio.v1.AutofillArgumentProviders = <PLACEHOLDER>)[source]

Bases: Message

AutofillAction can be used to retrieve additional metadata about an autofill action.

action_id: str | None = <PLACEHOLDER>: action_id uniquely identifies the autofill action associated with the input field.

argument_providers: AutofillArgumentProviders = <PLACEHOLDER>: argument_providers is an optional field that specifies how dynamic arguments are to be provided to the autofill action when executed. If an argument is omitted from the provider map, it will not be defined in the arguments passed to the scripts. If the entire field is omitted, no additional argument values will be passed to the script beyond any statically defined arguments and the system-provided arguments which are always set in an autofill action execution context (namely InputPath, StudioID, and WorkspaceID).

created_at: datetime = <PLACEHOLDER>: created_at is the time at which the inputs were first set.

created_by: str | None = <PLACEHOLDER>: created_by is the name of the user that first set the inputs.

description: str | None = <PLACEHOLDER>: description is an optional field to describe the autofill action that will be displayed in a tooltip in the UI when the user hovers over the button to run the autofill action.

key: AutofillActionKey = <PLACEHOLDER>: key uniquely identifies the action-to-studio association.

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the inputs were last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the name of the user that last modified the inputs.

class cloudvision.api.arista.studio.v1.AutofillActionBatchedStreamRequest(partial_eq_filter: List[ForwardRef('AutofillAction')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.AutofillActionBatchedStreamResponse(responses: List[ForwardRef('AutofillActionStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[AutofillActionStreamResponse] = <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.studio.v1.AutofillActionConfig(key: ~cloudvision.api.arista.studio.v1.AutofillActionKey = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, action_id: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, argument_providers: ~cloudvision.api.arista.studio.v1.AutofillArgumentProviders = <PLACEHOLDER>)[source]

Bases: Message

AutofillActionConfig contains configuration information for an autofill action.

action_id: str | None = <PLACEHOLDER>: action_id uniquely identifies the autofill action associated with the input field.

argument_providers: AutofillArgumentProviders = <PLACEHOLDER>: argument_providers is an optional field that specifies how dynamic arguments are to be provided to the autofill action when executed. If an argument is omitted from the provider map, it will not be defined in the arguments passed to the scripts. If the entire field is omitted, no additional argument values will be passed to the script beyond any statically defined arguments and the system-provided arguments which are always set in an autofill action execution context (namely InputPath, StudioId, and WorkspaceId).

description: str | None = <PLACEHOLDER>: description is an optional field to describe the autofill action that will be displayed in a tooltip in the UI when the user hovers over the button to run the autofill action.

key: AutofillActionKey = <PLACEHOLDER>: key uniquely identifies the action-to-studio association.

remove: bool | None = <PLACEHOLDER>: remove indicates whether to remove (true) or add (false, unset) the autofill action configuration identified by the key if the encompassing workspace merges. Other data fields are not allowed if this field is set to true.

class cloudvision.api.arista.studio.v1.AutofillActionConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('AutofillActionConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.AutofillActionConfigBatchedStreamResponse(responses: List[ForwardRef('AutofillActionConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[AutofillActionConfigStreamResponse] = <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.studio.v1.AutofillActionConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('AutofillActionConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AutofillActionConfig] = <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.studio.v1.AutofillActionConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'AutofillActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: AutofillActionKey = <PLACEHOLDER>: This is the key of the AutofillActionConfig 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.studio.v1.AutofillActionConfigDeleteRequest(key: 'AutofillActionKey' = <PLACEHOLDER>)[source]

Bases: Message

key: AutofillActionKey = <PLACEHOLDER>: Key indicates which AutofillActionConfig instance to remove. This field must always be set.

class cloudvision.api.arista.studio.v1.AutofillActionConfigDeleteResponse(key: 'AutofillActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: AutofillActionKey = <PLACEHOLDER>: Key echoes back the key of the deleted AutofillActionConfig 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.studio.v1.AutofillActionConfigDeleteSomeRequest(keys: List[ForwardRef('AutofillActionKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[AutofillActionKey] = <PLACEHOLDER>: key contains a list of AutofillActionConfig keys to delete

class cloudvision.api.arista.studio.v1.AutofillActionConfigDeleteSomeResponse(key: ~cloudvision.api.arista.studio.v1.AutofillActionKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

AutofillActionConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: AutofillActionKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.AutofillActionConfigRequest(key: 'AutofillActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: AutofillActionKey = <PLACEHOLDER>: Key uniquely identifies a AutofillActionConfig 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.studio.v1.AutofillActionConfigResponse(value: 'AutofillActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the AutofillActionConfig instance in this response.

value: AutofillActionConfig = <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.studio.v1.AutofillActionConfigServiceBase[source]

Bases: ServiceBase

async delete(autofill_action_config_delete_request: AutofillActionConfigDeleteRequest) → AutofillActionConfigDeleteResponse[source]

async delete_all(autofill_action_config_delete_all_request: AutofillActionConfigDeleteAllRequest) → AsyncIterator[AutofillActionConfigDeleteAllResponse][source]

async delete_some(autofill_action_config_delete_some_request: AutofillActionConfigDeleteSomeRequest) → AsyncIterator[AutofillActionConfigDeleteSomeResponse][source]

async get_all(autofill_action_config_stream_request: AutofillActionConfigStreamRequest) → AsyncIterator[AutofillActionConfigStreamResponse][source]

async get_all_batched(autofill_action_config_batched_stream_request: AutofillActionConfigBatchedStreamRequest) → AsyncIterator[AutofillActionConfigBatchedStreamResponse][source]

async get_meta(autofill_action_config_stream_request: AutofillActionConfigStreamRequest) → MetaResponse[source]

async get_one(autofill_action_config_request: AutofillActionConfigRequest) → AutofillActionConfigResponse[source]

async get_some(autofill_action_config_some_request: AutofillActionConfigSomeRequest) → AsyncIterator[AutofillActionConfigSomeResponse][source]

async set(autofill_action_config_set_request: AutofillActionConfigSetRequest) → AutofillActionConfigSetResponse[source]

async set_some(autofill_action_config_set_some_request: AutofillActionConfigSetSomeRequest) → AsyncIterator[AutofillActionConfigSetSomeResponse][source]

async subscribe(autofill_action_config_stream_request: AutofillActionConfigStreamRequest) → AsyncIterator[AutofillActionConfigStreamResponse][source]

async subscribe_batched(autofill_action_config_batched_stream_request: AutofillActionConfigBatchedStreamRequest) → AsyncIterator[AutofillActionConfigBatchedStreamResponse][source]

async subscribe_meta(autofill_action_config_stream_request: AutofillActionConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(autofill_action_config_delete_request: AutofillActionConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AutofillActionConfigDeleteResponse[source]

async delete_all(autofill_action_config_delete_all_request: AutofillActionConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigDeleteAllResponse][source]

async delete_some(autofill_action_config_delete_some_request: AutofillActionConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigDeleteSomeResponse][source]

async get_all(autofill_action_config_stream_request: AutofillActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigStreamResponse][source]

async get_all_batched(autofill_action_config_batched_stream_request: AutofillActionConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigBatchedStreamResponse][source]

async get_meta(autofill_action_config_stream_request: AutofillActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(autofill_action_config_request: AutofillActionConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AutofillActionConfigResponse[source]

async get_some(autofill_action_config_some_request: AutofillActionConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigSomeResponse][source]

async set(autofill_action_config_set_request: AutofillActionConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AutofillActionConfigSetResponse[source]

async set_some(autofill_action_config_set_some_request: AutofillActionConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigSetSomeResponse][source]

async subscribe(autofill_action_config_stream_request: AutofillActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigStreamResponse][source]

async subscribe_batched(autofill_action_config_batched_stream_request: AutofillActionConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionConfigBatchedStreamResponse][source]

async subscribe_meta(autofill_action_config_stream_request: AutofillActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.AutofillActionConfigSetRequest(value: 'AutofillActionConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: AutofillActionConfig = <PLACEHOLDER>: AutofillActionConfig carries the value to set into the datastore. See the documentation on the AutofillActionConfig struct for which fields are required.

class cloudvision.api.arista.studio.v1.AutofillActionConfigSetResponse(value: 'AutofillActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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: AutofillActionConfig = <PLACEHOLDER>: Value carries all the values given in the AutofillActionConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.studio.v1.AutofillActionConfigSetSomeRequest(values: List[ForwardRef('AutofillActionConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[AutofillActionConfig] = <PLACEHOLDER>

value contains a list of AutofillActionConfig 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.studio.v1.AutofillActionConfigSetSomeResponse(key: 'AutofillActionKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: AutofillActionKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.AutofillActionConfigSomeRequest(keys: List[ForwardRef('AutofillActionKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[AutofillActionKey] = <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.studio.v1.AutofillActionConfigSomeResponse(value: 'AutofillActionConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 AutofillActionConfig instance in this response.

value: AutofillActionConfig = <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.studio.v1.AutofillActionConfigStreamRequest(partial_eq_filter: List[ForwardRef('AutofillActionConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AutofillActionConfig] = <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 AutofillActionConfig at end. * Each AutofillActionConfig response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.AutofillActionConfigStreamResponse(value: 'AutofillActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this AutofillActionConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the AutofillActionConfig 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: AutofillActionConfig = <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.studio.v1.AutofillActionKey(studio_id: str | None = <PLACEHOLDER>, workspace_id: str | None = <PLACEHOLDER>, input_field_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

AutofillActionKey identifies an autofill action.

input_field_id: str | None = <PLACEHOLDER>: input_field_id uniquely identifies the input field within the schema associated with the action indicated by action_id.

studio_id: str | None = <PLACEHOLDER>: studio_id uniquely identifies the studio in the workspace indicated by workspace_id.

workspace_id: str | None = <PLACEHOLDER>: workspace_id uniquely identifies the workspace in which the studio resides.

class cloudvision.api.arista.studio.v1.AutofillActionRequest(key: 'AutofillActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: AutofillActionKey = <PLACEHOLDER>: Key uniquely identifies a AutofillAction 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.studio.v1.AutofillActionResponse(value: 'AutofillAction' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the AutofillAction instance in this response.

value: AutofillAction = <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.studio.v1.AutofillActionServiceBase[source]

Bases: ServiceBase

async get_all(autofill_action_stream_request: AutofillActionStreamRequest) → AsyncIterator[AutofillActionStreamResponse][source]

async get_all_batched(autofill_action_batched_stream_request: AutofillActionBatchedStreamRequest) → AsyncIterator[AutofillActionBatchedStreamResponse][source]

async get_meta(autofill_action_stream_request: AutofillActionStreamRequest) → MetaResponse[source]

async get_one(autofill_action_request: AutofillActionRequest) → AutofillActionResponse[source]

async get_some(autofill_action_some_request: AutofillActionSomeRequest) → AsyncIterator[AutofillActionSomeResponse][source]

async subscribe(autofill_action_stream_request: AutofillActionStreamRequest) → AsyncIterator[AutofillActionStreamResponse][source]

async subscribe_batched(autofill_action_batched_stream_request: AutofillActionBatchedStreamRequest) → AsyncIterator[AutofillActionBatchedStreamResponse][source]

async subscribe_meta(autofill_action_stream_request: AutofillActionStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(autofill_action_stream_request: AutofillActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionStreamResponse][source]

async get_all_batched(autofill_action_batched_stream_request: AutofillActionBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionBatchedStreamResponse][source]

async get_meta(autofill_action_stream_request: AutofillActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(autofill_action_request: AutofillActionRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AutofillActionResponse[source]

async get_some(autofill_action_some_request: AutofillActionSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionSomeResponse][source]

async subscribe(autofill_action_stream_request: AutofillActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionStreamResponse][source]

async subscribe_batched(autofill_action_batched_stream_request: AutofillActionBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AutofillActionBatchedStreamResponse][source]

async subscribe_meta(autofill_action_stream_request: AutofillActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.AutofillActionSomeRequest(keys: List[ForwardRef('AutofillActionKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[AutofillActionKey] = <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.studio.v1.AutofillActionSomeResponse(value: 'AutofillAction' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 AutofillAction instance in this response.

value: AutofillAction = <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.studio.v1.AutofillActionStreamRequest(partial_eq_filter: List[ForwardRef('AutofillAction')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[AutofillAction] = <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 AutofillAction at end. * Each AutofillAction response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.AutofillActionStreamResponse(value: 'AutofillAction' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this AutofillAction’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the AutofillAction 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: AutofillAction = <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.studio.v1.AutofillArgumentProvider(type: ~cloudvision.api.arista.studio.v1.AutofillProviderType = <PLACEHOLDER>, value: str | None = <PLACEHOLDER>)[source]

Bases: Message

AutofillArgumentProvider describes a particular dynamic argument’s type and value (if applicable).

type: AutofillProviderType = <PLACEHOLDER>: type is the type of argument provider, describing how it is to be handled when the associated action is called.

value: str | None = <PLACEHOLDER>: value is the value of the argument, if provided. When the provider type is PROVIDER_TYPE_USER_SPECIFIED, the field may be nil. If non-nil, the field contains a default value for the user input. When the provider type is PROVIDER_TYPE_PREDEFINED, the field contains the predefined value. When the provider type is PROVIDER_TYPE_LINKED, the field contains the linked input field’s ID.

class cloudvision.api.arista.studio.v1.AutofillArgumentProviders(values: ~typing.Dict[str, ~cloudvision.api.arista.studio.v1.AutofillArgumentProvider] = <PLACEHOLDER>)[source]

Bases: Message

AutofillArgumentProviders is a map of dynamic argument name to argument provider information.

values: Dict[str, AutofillArgumentProvider] = <PLACEHOLDER>: values is a map of dynamic argument name to argument provider information.

class cloudvision.api.arista.studio.v1.AutofillProviderType(value: int)[source]

Bases: Enum

AutofillProviderType describes the set of possible provided argument types.

LINKED = AutofillProviderType.LINKED: AUTOFILL_PROVIDER_TYPE_LINKED is when an argument is linked to another studio input field.

PREDEFINED = AutofillProviderType.PREDEFINED: AUTOFILL_PROVIDER_TYPE_PREDEFINED is when an argument has a predefined value.

UNSPECIFIED = AutofillProviderType.UNSPECIFIED: AUTOFILL_PROVIDER_TYPE_UNSPECIFIED indicates that no provider type is specified.

USER_SPECIFIED = AutofillProviderType.USER_SPECIFIED: AUTOFILL_PROVIDER_TYPE_USER_SPECIFIED is when an argument is to be provided at runtime by the user.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.BooleanInputFieldProps(default_value: bool | None = <PLACEHOLDER>)[source]

Bases: Message

BooleanInputFieldProps defines the set of properties for a single boolean field in a studio input schema.

default_value: bool | None = <PLACEHOLDER>: default_value is the default value of the boolean.

class cloudvision.api.arista.studio.v1.CollectionInputFieldProps(base_field_id: str | None = <PLACEHOLDER>, key: str | None = <PLACEHOLDER>)[source]

Bases: Message

CollectionInputFieldProps defines the set of properties for a single collection field in a studio input schema.

base_field_id: str | None = <PLACEHOLDER>: base_field_id (required) identifies the field in the schema that should be used as the type for each element in the collection.

key: str | None = <PLACEHOLDER>: key can be used when base_field_id references a group field, and it identifies the field in that group that should be used as the key for each element in the collection. This is used for display purposes only.

class cloudvision.api.arista.studio.v1.Entities(values: ~typing.Dict[str, ~cloudvision.api.arista.studio.v1.Entity] = <PLACEHOLDER>)[source]

Bases: Message

Entities is a list of Entity.

values: Dict[str, Entity] = <PLACEHOLDER>: values is a map from entity type name to entity The possible keys to this map are ENTITY_TYPE_STUDIO, ENTITY_TYPE_INPUTS, ENTITY_TYPE_ASSIGNED_TAGS, ENTITY_TYPE_BUILD_HOOK and ENTITY_TYPE_AUTOFILL_ACTION.

class cloudvision.api.arista.studio.v1.Entity(entity_type: ~cloudvision.api.arista.studio.v1.EntityType = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, removed: bool | None = <PLACEHOLDER>)[source]

Bases: Message

Entity holds the basic information of an entity.

entity_type: EntityType = <PLACEHOLDER>: entity_type is the type of the entity.

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the entity was last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the name of the user that last modified the entity.

removed: bool | None = <PLACEHOLDER>: removed indicates if the entity is removed.

class cloudvision.api.arista.studio.v1.EntityType(value: int)[source]

Bases: Enum

EntityType enumerates the set of entity types.

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

CONFIGLET_ASSIGNMENT = EntityType.CONFIGLET_ASSIGNMENT: ENTITY_TYPE_CONFIGLET_ASSIGNMENT indicates the ConfigletAssignment entity type for static config studio.

INPUTS = EntityType.INPUTS: ENTITY_TYPE_INPUTS indicates the Inputs entity type.

STUDIO = EntityType.STUDIO: ENTITY_TYPE_STUDIO indicates the Studio entity type.

UNSPECIFIED = EntityType.UNSPECIFIED: ENTITY_TYPE_UNSPECIFIED indicates an unspecified entity type.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.FloatInputFieldProps(default_value: float | None = <PLACEHOLDER>, static_options: ~cloudvision.api.fmp.RepeatedFloat = <PLACEHOLDER>, dynamic_options: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, extra_values_allowed: bool | None = <PLACEHOLDER>)[source]

Bases: Message

FloatInputFieldProps defines the set of properties for a single float field in a studio input schema.

default_value: float | None = <PLACEHOLDER>: default_value is the default value of the float.

dynamic_options: ___fmp__.RepeatedString = <PLACEHOLDER>

dynamic_options defines the set of possible values for the float based on the possible values for other floats in the schema. Each field should be referenced by a JSON object of the form { fieldId: field_id }.

E.g, [

{ fieldId: floatField1ID }, { fieldId: floatField2ID }

] Here, the possible values for the floats identified by floatField1ID and floatField2ID are used as the possible values for this float.

extra_values_allowed: bool | None = <PLACEHOLDER>: extra_values_allowed allows adding values to the field in addition to what’s allowed by static_options/dynamic_options.

static_options: ___fmp__.RepeatedFloat = <PLACEHOLDER>: static_options defines the set of possible values for the float.

class cloudvision.api.arista.studio.v1.GroupInputFieldProps(members: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

GroupInputFieldProps defines the set of properties for a single group field in a studio input schema.

members: ___fmp__.RepeatedString = <PLACEHOLDER>: members (required) identifies the member fields of the group as defined in the schema.

class cloudvision.api.arista.studio.v1.InputField(id: str | None = <PLACEHOLDER>, type: ~cloudvision.api.arista.studio.v1.InputFieldType = <PLACEHOLDER>, name: str | None = <PLACEHOLDER>, label: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, required: bool | None = <PLACEHOLDER>, boolean_props: ~cloudvision.api.arista.studio.v1.BooleanInputFieldProps = <PLACEHOLDER>, integer_props: ~cloudvision.api.arista.studio.v1.IntegerInputFieldProps = <PLACEHOLDER>, float_props: ~cloudvision.api.arista.studio.v1.FloatInputFieldProps = <PLACEHOLDER>, string_props: ~cloudvision.api.arista.studio.v1.StringInputFieldProps = <PLACEHOLDER>, group_props: ~cloudvision.api.arista.studio.v1.GroupInputFieldProps = <PLACEHOLDER>, collection_props: ~cloudvision.api.arista.studio.v1.CollectionInputFieldProps = <PLACEHOLDER>, resolver_props: ~cloudvision.api.arista.studio.v1.ResolverInputFieldProps = <PLACEHOLDER>, auto_fill_action_id: str | None = <PLACEHOLDER>, tag_matcher_props: ~cloudvision.api.arista.studio.v1.TagMatcherInputFieldProps = <PLACEHOLDER>)[source]

Bases: Message

InputField defines the set of properties for a single field in a studio input schema.

auto_fill_action_id: str | None = <PLACEHOLDER>: auto_fill_action_id identifies the autofill action that can be used to automatically populate the value of this field on the UI.

boolean_props: BooleanInputFieldProps = <PLACEHOLDER>: boolean_props defines properties for the field if it is of type INPUT_FIELD_TYPE_BOOLEAN.

collection_props: CollectionInputFieldProps = <PLACEHOLDER>: collection_props defines properties for the field if it is of type INPUT_FIELD_TYPE_COLLECTION.

description: str | None = <PLACEHOLDER>: description is a short description of the field.

float_props: FloatInputFieldProps = <PLACEHOLDER>: float_props defines properties for the field if it is of type INPUT_FIELD_TYPE_FLOAT.

group_props: GroupInputFieldProps = <PLACEHOLDER>: group_props defines properties for the field if it is of type INPUT_FIELD_TYPE_GROUP.

id: str | None = <PLACEHOLDER>: id (required) uniquely identifies the field within the schema.

integer_props: IntegerInputFieldProps = <PLACEHOLDER>: integer_props defines properties for the field if it is of type INPUT_FIELD_TYPE_INTEGER.

label: str | None = <PLACEHOLDER>: label (required) is the label of the field as displayed on the UI.

name: str | None = <PLACEHOLDER>: name (required) is the variable name by which the field can be referenced in the template for the studio.

required: bool | None = <PLACEHOLDER>: required indicates whether the field always requires a value. This is false by default.

resolver_props: ResolverInputFieldProps = <PLACEHOLDER>: resolver_props defines properties for the field if it is of type INPUT_FIELD_TYPE_RESOLVER.

string_props: StringInputFieldProps = <PLACEHOLDER>: string_props defines properties for the field if it is of type INPUT_FIELD_TYPE_STRING.

tag_matcher_props: TagMatcherInputFieldProps = <PLACEHOLDER>: tag_matcher_props defines properties for the field if it is of type INPUT_FIELD_TYPE_TAG_MATCHER.

type: InputFieldType = <PLACEHOLDER>: type (required) specifies the type for the field.

class cloudvision.api.arista.studio.v1.InputFieldType(value: int)[source]

Bases: Enum

InputFieldType defines the set of possible data types for values that can be input into a studio.

BOOLEAN = InputFieldType.BOOLEAN: INPUT_FIELD_TYPE_BOOLEAN is the data type for a boolean value.

COLLECTION = InputFieldType.COLLECTION: INPUT_FIELD_TYPE_COLLECTION is the data type for an ordered collection of inputs of the same type. This type is used in cases where multiple input values of the same type should be given for a field, and where ordering matters.

FLOAT = InputFieldType.FLOAT: INPUT_FIELD_TYPE_FLOAT is the data type for a float value.

GROUP = InputFieldType.GROUP: INPUT_FIELD_TYPE_GROUP is the data type for an unordered group of inputs of any type. This type is used in cases where inputs are required to be consolidated into an object for use in the template or to attach multiple inputs under a resolver or collection.

INTEGER = InputFieldType.INTEGER: INPUT_FIELD_TYPE_INTEGER is the data type for an integer value.

RESOLVER = InputFieldType.RESOLVER: INPUT_FIELD_TYPE_RESOLVER is the data type for an input that allows its member input to be assigned based on a tag query match. This type is used in cases where the input value is conditional on a device or a group of devices. The query is resolved at run-time and each affected device is given the value that corresponds to the tag it is assigned to.

STRING = InputFieldType.STRING: INPUT_FIELD_TYPE_STRING is the data type for a string value.

TAG_MATCHER = InputFieldType.TAG_MATCHER: INPUT_FIELD_TYPE_TAG_MATCHER is the data type for an input that allows an unordered set of devices or interfaces to be selected. The set of devices or interfaces that are to be selected are specified by a tag query, resolved at run-time.

UNSPECIFIED = InputFieldType.UNSPECIFIED: INPUT_FIELD_TYPE_UNSPECIFIED indicates an unspecified input data type.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.InputFields(values: ~typing.Dict[str, ~cloudvision.api.arista.studio.v1.InputField] = <PLACEHOLDER>)[source]

Bases: Message

InputFields is a collection of InputField.

values: Dict[str, InputField] = <PLACEHOLDER>: values (required) is a map from input field ID to InputField.

class cloudvision.api.arista.studio.v1.InputSchema(fields: ~cloudvision.api.arista.studio.v1.InputFields = <PLACEHOLDER>, layout: ~cloudvision.api.arista.studio.v1.Layout = <PLACEHOLDER>)[source]

Bases: Message

InputSchema defines an input schema for a studio, which determines the values that can be input into the studio.

fields: InputFields = <PLACEHOLDER>: fields (required) are the set of fields that make up the schema.

layout: Layout = <PLACEHOLDER>: layout (UI only) defines the display properties for fields.

class cloudvision.api.arista.studio.v1.Inputs(key: ~cloudvision.api.arista.studio.v1.InputsKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, inputs: str | None = <PLACEHOLDER>)[source]

Bases: Message

Inputs is used to retrieve the existing inputs to a studio.

created_at: datetime = <PLACEHOLDER>: created_at is the time at which the inputs were first set.

created_by: str | None = <PLACEHOLDER>: created_by is the name of the user that first set the inputs.

inputs: str | None = <PLACEHOLDER>

inputs is the value of the input field at the path as a JSON string.

NOTE: For GetAll and Subscribe, if the JSON is too large, it will be split across multiple messages such that each is less than the Resource API message size limit (1MB).

key: InputsKey = <PLACEHOLDER>: key uniquely identifies the set of inputs for the studio (at some path).

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the inputs were last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the name of the user that last modified the inputs.

class cloudvision.api.arista.studio.v1.InputsBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Inputs')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.InputsBatchedStreamResponse(responses: List[ForwardRef('InputsStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[InputsStreamResponse] = <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.studio.v1.InputsConfig(key: ~cloudvision.api.arista.studio.v1.InputsKey = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, inputs: str | None = <PLACEHOLDER>)[source]

Bases: Message

InputsConfig is used to input values into a studio.

NOTE: Setting an input at a higher path overwrite any prior `Set`s at lower paths. E.g.,

Set [“A”, “X”] to “foo”
Set [“A”, “Y”] to “bar”
Set [“A”] to {“X”: “bar”}

The resulting inputs would be: ` { "A": { "X": "bar" } } `

inputs: str | None = <PLACEHOLDER>

inputs is the value of the input field at the path as a JSON string. It can be the value for a simple or complex input field.

Simple types (booleans, integers, floats, strings) map to their JSON equivalents.

Complex types map to either arrays or objects:

The group field type maps to a JSON object, where keys are group members.
The collection field type maps to a JSON array.
The resolver field type maps to a JSON array, where each element is an object of the form: ``` {

“tags”: { “query”: <query> }, “inputs”: <input>

Above, <input> is the value of the base field of the resolver. E.g., if the base field is a group with one string member “A”, the resolver inputs would be specified as: ` "inputs": { "A": <value> } `

key: InputsKey = <PLACEHOLDER>: key uniquely identifies the set of inputs for the studio (at some path).

remove: bool | None = <PLACEHOLDER>: remove indicates whether to remove (true) or add (false, unset) the inputs identified by the key if the encompassing workspace merges. Other data fields are not allowed if this field is set to true.

class cloudvision.api.arista.studio.v1.InputsConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('InputsConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.InputsConfigBatchedStreamResponse(responses: List[ForwardRef('InputsConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[InputsConfigStreamResponse] = <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.studio.v1.InputsConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('InputsConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[InputsConfig] = <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.studio.v1.InputsConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'InputsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: InputsKey = <PLACEHOLDER>: This is the key of the InputsConfig 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.studio.v1.InputsConfigDeleteRequest(key: 'InputsKey' = <PLACEHOLDER>)[source]

Bases: Message

key: InputsKey = <PLACEHOLDER>: Key indicates which InputsConfig instance to remove. This field must always be set.

class cloudvision.api.arista.studio.v1.InputsConfigDeleteResponse(key: 'InputsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: InputsKey = <PLACEHOLDER>: Key echoes back the key of the deleted InputsConfig 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.studio.v1.InputsConfigDeleteSomeRequest(keys: List[ForwardRef('InputsKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[InputsKey] = <PLACEHOLDER>: key contains a list of InputsConfig keys to delete

class cloudvision.api.arista.studio.v1.InputsConfigDeleteSomeResponse(key: ~cloudvision.api.arista.studio.v1.InputsKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

InputsConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: InputsKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.InputsConfigRequest(key: 'InputsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: InputsKey = <PLACEHOLDER>: Key uniquely identifies a InputsConfig 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.studio.v1.InputsConfigResponse(value: 'InputsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the InputsConfig instance in this response.

value: InputsConfig = <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.studio.v1.InputsConfigServiceBase[source]

Bases: ServiceBase

async delete(inputs_config_delete_request: InputsConfigDeleteRequest) → InputsConfigDeleteResponse[source]

async delete_all(inputs_config_delete_all_request: InputsConfigDeleteAllRequest) → AsyncIterator[InputsConfigDeleteAllResponse][source]

async delete_some(inputs_config_delete_some_request: InputsConfigDeleteSomeRequest) → AsyncIterator[InputsConfigDeleteSomeResponse][source]

async get_all(inputs_config_stream_request: InputsConfigStreamRequest) → AsyncIterator[InputsConfigStreamResponse][source]

async get_all_batched(inputs_config_batched_stream_request: InputsConfigBatchedStreamRequest) → AsyncIterator[InputsConfigBatchedStreamResponse][source]

async get_meta(inputs_config_stream_request: InputsConfigStreamRequest) → MetaResponse[source]

async get_one(inputs_config_request: InputsConfigRequest) → InputsConfigResponse[source]

async get_some(inputs_config_some_request: InputsConfigSomeRequest) → AsyncIterator[InputsConfigSomeResponse][source]

async set(inputs_config_set_request: InputsConfigSetRequest) → InputsConfigSetResponse[source]

async set_some(inputs_config_set_some_request: InputsConfigSetSomeRequest) → AsyncIterator[InputsConfigSetSomeResponse][source]

async subscribe(inputs_config_stream_request: InputsConfigStreamRequest) → AsyncIterator[InputsConfigStreamResponse][source]

async subscribe_batched(inputs_config_batched_stream_request: InputsConfigBatchedStreamRequest) → AsyncIterator[InputsConfigBatchedStreamResponse][source]

async subscribe_meta(inputs_config_stream_request: InputsConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(inputs_config_delete_request: InputsConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → InputsConfigDeleteResponse[source]

async delete_all(inputs_config_delete_all_request: InputsConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigDeleteAllResponse][source]

async delete_some(inputs_config_delete_some_request: InputsConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigDeleteSomeResponse][source]

async get_all(inputs_config_stream_request: InputsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigStreamResponse][source]

async get_all_batched(inputs_config_batched_stream_request: InputsConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigBatchedStreamResponse][source]

async get_meta(inputs_config_stream_request: InputsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(inputs_config_request: InputsConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → InputsConfigResponse[source]

async get_some(inputs_config_some_request: InputsConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigSomeResponse][source]

async set(inputs_config_set_request: InputsConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → InputsConfigSetResponse[source]

async set_some(inputs_config_set_some_request: InputsConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigSetSomeResponse][source]

async subscribe(inputs_config_stream_request: InputsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigStreamResponse][source]

async subscribe_batched(inputs_config_batched_stream_request: InputsConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsConfigBatchedStreamResponse][source]

async subscribe_meta(inputs_config_stream_request: InputsConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.InputsConfigSetRequest(value: 'InputsConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: InputsConfig = <PLACEHOLDER>: InputsConfig carries the value to set into the datastore. See the documentation on the InputsConfig struct for which fields are required.

class cloudvision.api.arista.studio.v1.InputsConfigSetResponse(value: 'InputsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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: InputsConfig = <PLACEHOLDER>: Value carries all the values given in the InputsConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.studio.v1.InputsConfigSetSomeRequest(values: List[ForwardRef('InputsConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[InputsConfig] = <PLACEHOLDER>

value contains a list of InputsConfig 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.studio.v1.InputsConfigSetSomeResponse(key: 'InputsKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: InputsKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.InputsConfigSomeRequest(keys: List[ForwardRef('InputsKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[InputsKey] = <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.studio.v1.InputsConfigSomeResponse(value: 'InputsConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 InputsConfig instance in this response.

value: InputsConfig = <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.studio.v1.InputsConfigStreamRequest(partial_eq_filter: List[ForwardRef('InputsConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[InputsConfig] = <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 InputsConfig at end. * Each InputsConfig response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.InputsConfigStreamResponse(value: 'InputsConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this InputsConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the InputsConfig 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: InputsConfig = <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.studio.v1.InputsKey(studio_id: str | None = <PLACEHOLDER>, workspace_id: str | None = <PLACEHOLDER>, path: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

InputsKey identifies a set of inputs for a particular studio.

path: ___fmp__.RepeatedString = <PLACEHOLDER>

path is the sequence of elements that uniquely identify an input field. An empty path ([]) stands for the root of the inputs, or the entire set of inputs for the studio.

The members of a group are referenced by field name. E.g., for a group A with a member B, the path to B would be [“A”, “B”].

The members of a collection or resolver are referenced by an integer string. E.g., for a collection A with three members, the path to the second member would be [“A”, “1”].

studio_id: str | None = <PLACEHOLDER>: studio_id uniquely identifies the studio in the workspace indicated by workspace_id.

workspace_id: str | None = <PLACEHOLDER>: workspace_id uniquely identifies the workspace in which the studio resides.

class cloudvision.api.arista.studio.v1.InputsRequest(key: 'InputsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: InputsKey = <PLACEHOLDER>: Key uniquely identifies a Inputs 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.studio.v1.InputsResponse(value: 'Inputs' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Inputs instance in this response.

value: Inputs = <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.studio.v1.InputsServiceBase[source]

Bases: ServiceBase

async get_all(inputs_stream_request: InputsStreamRequest) → AsyncIterator[InputsStreamResponse][source]

async get_all_batched(inputs_batched_stream_request: InputsBatchedStreamRequest) → AsyncIterator[InputsBatchedStreamResponse][source]

async get_meta(inputs_stream_request: InputsStreamRequest) → MetaResponse[source]

async get_one(inputs_request: InputsRequest) → InputsResponse[source]

async get_some(inputs_some_request: InputsSomeRequest) → AsyncIterator[InputsSomeResponse][source]

async subscribe(inputs_stream_request: InputsStreamRequest) → AsyncIterator[InputsStreamResponse][source]

async subscribe_batched(inputs_batched_stream_request: InputsBatchedStreamRequest) → AsyncIterator[InputsBatchedStreamResponse][source]

async subscribe_meta(inputs_stream_request: InputsStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(inputs_stream_request: InputsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsStreamResponse][source]

async get_all_batched(inputs_batched_stream_request: InputsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsBatchedStreamResponse][source]

async get_meta(inputs_stream_request: InputsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(inputs_request: InputsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → InputsResponse[source]

async get_some(inputs_some_request: InputsSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsSomeResponse][source]

async subscribe(inputs_stream_request: InputsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsStreamResponse][source]

async subscribe_batched(inputs_batched_stream_request: InputsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[InputsBatchedStreamResponse][source]

async subscribe_meta(inputs_stream_request: InputsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.InputsSomeRequest(keys: List[ForwardRef('InputsKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[InputsKey] = <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.studio.v1.InputsSomeResponse(value: 'Inputs' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 Inputs instance in this response.

value: Inputs = <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.studio.v1.InputsStreamRequest(partial_eq_filter: List[ForwardRef('Inputs')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Inputs] = <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 Inputs at end. * Each Inputs response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.InputsStreamResponse(value: 'Inputs' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Inputs’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Inputs 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: Inputs = <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.studio.v1.IntegerInputFieldProps(default_value: int | None = <PLACEHOLDER>, static_options: ~cloudvision.api.fmp.RepeatedInt64 = <PLACEHOLDER>, range: str | None = <PLACEHOLDER>, dynamic_options: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, extra_values_allowed: bool | None = <PLACEHOLDER>)[source]

Bases: Message

IntegerInputFieldProps defines the set of properties for a single integer field in a studio input schema.

default_value: int | None = <PLACEHOLDER>: default_value is the default value of the integer.

dynamic_options: ___fmp__.RepeatedString = <PLACEHOLDER>

dynamic_options defines the set of possible values for the integer based on the possible values for other integers in the schema. Each field should be referenced by a JSON object of the form { “fieldId”: <field_id> }.

E.g, ``` [

{ “fieldId”: “vlanFieldID” }, { “fieldId”: “vniFieldID” }

]

Here, the possible values for the integers identified by “vlanFieldID” and “vniFieldID” are used as the possible values for this integer.

extra_values_allowed: bool | None = <PLACEHOLDER>: extra_values_allowed allows adding values to the field in addition to what’s allowed by static_options/dynamic_options.

range: str | None = <PLACEHOLDER>: range imposes a range (inclusive) on the value of the integer. This should be of the form “<min>..<max>”. E.g., “-10..10” means the integer can be anything in between and including -10 and 10.

static_options: ___fmp__.RepeatedInt64 = <PLACEHOLDER>: static_options defines the set of possible values for the integer.

class cloudvision.api.arista.studio.v1.Layout(value: str | None = <PLACEHOLDER>)[source]

Bases: Message

Layout specifies the display properties for input fields. This is intended for UI usage only.

value: str | None = <PLACEHOLDER>: value is a JSON object containing the layout config.

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

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.studio.v1.ResolverFieldDisplayMode(value: int)[source]

Bases: Enum

ResolverFieldDisplayMode defines the set of ways in which the matching devices or interfaces should be displayed on the UI.

ALL = ResolverFieldDisplayMode.ALL: RESOLVER_FIELD_DISPLAY_MODE_ALL instructs the UI to show all matching devices or interfaces, including ones that have no inputs.

SPARSE = ResolverFieldDisplayMode.SPARSE: RESOLVER_FIELD_DISPLAY_MODE_SPARSE instructs the UI to show only matching devices or interfaces that have inputs.

UNSPECIFIED = ResolverFieldDisplayMode.UNSPECIFIED: RESOLVER_FIELD_DISPLAY_MODE_UNSPECIFIED indicates an unspecified resolver display mode.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.ResolverFieldInputMode(value: int)[source]

Bases: Enum

ResolverFieldInputMode defines the set of ways a resolver tag query can be specified in a studio.

MULTI_DEVICE_TAG = ResolverFieldInputMode.MULTI_DEVICE_TAG: RESOLVER_FIELD_INPUT_MODE_MULTI_DEVICE_TAG allows devices to be selected based on any tag label.

MULTI_INTERFACE_TAG = ResolverFieldInputMode.MULTI_INTERFACE_TAG: RESOLVER_FIELD_INPUT_MODE_MULTI_INTERFACE_TAG allows interfaces to be selected based on any tag label.

SINGLE_DEVICE_TAG = ResolverFieldInputMode.SINGLE_DEVICE_TAG: RESOLVER_FIELD_INPUT_MODE_SINGLE_DEVICE_TAG allows devices to be selected based on a single tag label.

SINGLE_INTERFACE_TAG = ResolverFieldInputMode.SINGLE_INTERFACE_TAG: RESOLVER_FIELD_INPUT_MODE_SINGLE_INTERFACE_TAG allows interfaces to be selected based on a single tag label.

UNSPECIFIED = ResolverFieldInputMode.UNSPECIFIED: RESOLVER_FIELD_INPUT_MODE_UNSPECIFIED indicates an unspecified resolver input mode.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.ResolverInputFieldProps(base_field_id: str | None = <PLACEHOLDER>, display_mode: ~cloudvision.api.arista.studio.v1.ResolverFieldDisplayMode = <PLACEHOLDER>, input_mode: ~cloudvision.api.arista.studio.v1.ResolverFieldInputMode = <PLACEHOLDER>, input_tag_label: str | None = <PLACEHOLDER>, tag_filter_query: str | None = <PLACEHOLDER>)[source]

Bases: Message

ResolverInputFieldProps defines the set of properties for a single resolver field in a studio input schema.

base_field_id: str | None = <PLACEHOLDER>: base_field_id (required) identifies the field in the schema to which the resolver query maps.

display_mode: ResolverFieldDisplayMode = <PLACEHOLDER>: display_mode (required) is the display mode of the resolver.

input_mode: ResolverFieldInputMode = <PLACEHOLDER>: input_mode (required) is the input mode of the resolver.

input_tag_label: str | None = <PLACEHOLDER>: input_tag_label can be used when input_mode is one of RESOLVER_FIELD_INPUT_MODE_SINGLE_*_TAG and it specifies the tag label must be used in the resolver query.

tag_filter_query: str | None = <PLACEHOLDER>: tag_filter_query limits the set of elements that the resolver query can return. E.g., “device:D1,D2” will constrain results to the devices D1 and D2.

class cloudvision.api.arista.studio.v1.SecretInput(key: ~cloudvision.api.arista.studio.v1.InputsKey = <PLACEHOLDER>, plain_text: str | None = <PLACEHOLDER>)[source]

Bases: Message

SecretInput can be used to retrieve the unmasked value of a secret in a studio.

key: InputsKey = <PLACEHOLDER>: key identifies the secret in the studio inputs.

plain_text: str | None = <PLACEHOLDER>: plain_text is the unmasked value of the secret.

class cloudvision.api.arista.studio.v1.SecretInputBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SecretInput')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.SecretInputBatchedStreamResponse(responses: List[ForwardRef('SecretInputStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SecretInputStreamResponse] = <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.studio.v1.SecretInputRequest(key: 'InputsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: InputsKey = <PLACEHOLDER>: Key uniquely identifies a SecretInput 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.studio.v1.SecretInputResponse(value: 'SecretInput' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the SecretInput instance in this response.

value: SecretInput = <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.studio.v1.SecretInputServiceBase[source]

Bases: ServiceBase

async get_all(secret_input_stream_request: SecretInputStreamRequest) → AsyncIterator[SecretInputStreamResponse][source]

async get_all_batched(secret_input_batched_stream_request: SecretInputBatchedStreamRequest) → AsyncIterator[SecretInputBatchedStreamResponse][source]

async get_meta(secret_input_stream_request: SecretInputStreamRequest) → MetaResponse[source]

async get_one(secret_input_request: SecretInputRequest) → SecretInputResponse[source]

async get_some(secret_input_some_request: SecretInputSomeRequest) → AsyncIterator[SecretInputSomeResponse][source]

async subscribe(secret_input_stream_request: SecretInputStreamRequest) → AsyncIterator[SecretInputStreamResponse][source]

async subscribe_batched(secret_input_batched_stream_request: SecretInputBatchedStreamRequest) → AsyncIterator[SecretInputBatchedStreamResponse][source]

async subscribe_meta(secret_input_stream_request: SecretInputStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(secret_input_stream_request: SecretInputStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SecretInputStreamResponse][source]

async get_all_batched(secret_input_batched_stream_request: SecretInputBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SecretInputBatchedStreamResponse][source]

async get_meta(secret_input_stream_request: SecretInputStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(secret_input_request: SecretInputRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → SecretInputResponse[source]

async get_some(secret_input_some_request: SecretInputSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SecretInputSomeResponse][source]

async subscribe(secret_input_stream_request: SecretInputStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SecretInputStreamResponse][source]

async subscribe_batched(secret_input_batched_stream_request: SecretInputBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[SecretInputBatchedStreamResponse][source]

async subscribe_meta(secret_input_stream_request: SecretInputStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.SecretInputSomeRequest(keys: List[ForwardRef('InputsKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[InputsKey] = <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.studio.v1.SecretInputSomeResponse(value: 'SecretInput' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 SecretInput instance in this response.

value: SecretInput = <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.studio.v1.SecretInputStreamRequest(partial_eq_filter: List[ForwardRef('SecretInput')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SecretInput] = <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 SecretInput at end. * Each SecretInput response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.SecretInputStreamResponse(value: 'SecretInput' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this SecretInput’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the SecretInput 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: SecretInput = <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.studio.v1.StringInputFieldProps(default_value: str | None = <PLACEHOLDER>, static_options: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, dynamic_options: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, length: str | None = <PLACEHOLDER>, pattern: str | None = <PLACEHOLDER>, format: str | None = <PLACEHOLDER>, is_secret: bool | None = <PLACEHOLDER>, extra_values_allowed: bool | None = <PLACEHOLDER>)[source]

Bases: Message

StringInputFieldProps defines the set of properties for a single string field in a studio input schema.

default_value: str | None = <PLACEHOLDER>: default_value is the default value of the string.

dynamic_options: ___fmp__.RepeatedString = <PLACEHOLDER>

dynamic_options defines the set of possible values for the string based on the possible values for other strings in the schema. Each field should be referenced by a JSON object of the form { “fieldId”: <field_id> }.

E.g, ``` [

{ “fieldId”: “deviceFieldID” }, { “fieldId”: “ipFieldID” }

]

Here, the possible values for the strings identified by “deviceFieldID” and “ipFieldID” are used as the possible values for this string.

extra_values_allowed: bool | None = <PLACEHOLDER>: extra_values_allowed allows adding values to the field in addition to what’s allowed by static_options/dynamic_options.

format: str | None = <PLACEHOLDER>

format imposes a well-known format on the value of the string. The supported formats are:

“ip”: an IPv4 or IPv6 address
“ipv4”: an IPv4 address
“ipv6”: an IPv6 address
“mac”: a MAC address
“cidr”: an IPv4 or IPv6 address in CIDR notation (e.g. 10.1.1.1/24, 2001:db8:a0b::1/32)
“cidrv4”: an IPv4 address in CIDR notation (e.g. 10.1.1.1/24)
“cidrv6”: an IPv6 address in CIDR notation (e.g. 2001:db8:a0b::1/32)
“url”: a URL (e.g., http://www.google.com)

is_secret: bool | None = <PLACEHOLDER>: is_secret specifies whether the string is a secret and its value should be masked. E.g., if this is set to true and the value of the string is “secret-value-1”, it will be masked as “**********”.

length: str | None = <PLACEHOLDER>: length imposes a length range (inclusive) on the value of the string. The should be of the form “<min>..<max>”. E.g., “3..7” means the value of the string can be three to seven characters long.

pattern: str | None = <PLACEHOLDER>: pattern imposes a regular expression matching constraint on the value of the string. This should be a Google RE2-compliant regular expression (https://github.com/google/re2/wiki/Syntax).

static_options: ___fmp__.RepeatedString = <PLACEHOLDER>: static_options defines the set of possible values for the string.

class cloudvision.api.arista.studio.v1.Studio(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, template: ~cloudvision.api.arista.studio.v1.Template = <PLACEHOLDER>, input_schema: ~cloudvision.api.arista.studio.v1.InputSchema = <PLACEHOLDER>, from_package: str | None = <PLACEHOLDER>)[source]

Bases: Message

Studio holds the active state for a studio.

created_at: datetime = <PLACEHOLDER>: created_at is the time at which the studio was created.

created_by: str | None = <PLACEHOLDER>: created_by is the name of the user that created the studio.

description: str | None = <PLACEHOLDER>: description is a brief description of the studio.

display_name: str | None = <PLACEHOLDER>: display_name is the name of this studio as displayed on the UI. This and remaining fields are config fields, with workspace changes applied on top of mainline. This resource will be present in the workspace only if the studio is modified (via the StudioConfig resource).

from_package: str | None = <PLACEHOLDER>: from_package indicates that this studio was created by a package, and can only be modified by the packaging service.

input_schema: InputSchema = <PLACEHOLDER>: input_schema is the schema for the studio inputs that are processed by template.

key: StudioKey = <PLACEHOLDER>: key uniquely identifies the studio.

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time at which the studio was last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the name of the user that last modified the studio.

template: Template = <PLACEHOLDER>: template is a script that builds the device configuration from the inputs that are described by input_schema.

class cloudvision.api.arista.studio.v1.StudioBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Studio')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioBatchedStreamResponse(responses: List[ForwardRef('StudioStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[StudioStreamResponse] = <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.studio.v1.StudioConfig(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, template: ~cloudvision.api.arista.studio.v1.Template = <PLACEHOLDER>, input_schema: ~cloudvision.api.arista.studio.v1.InputSchema = <PLACEHOLDER>)[source]

Bases: Message

StudioConfig holds a configuration for a studio.

Changes to fields other than key and remove are applied to a copy of the mainline.

description: str | None = <PLACEHOLDER>: description is a brief description of the studio.

display_name: str | None = <PLACEHOLDER>: display_name is the name of this studio as displayed on the UI. This and remaining fields are config fields, with workspace changes to be applied on top of mainline. The corresponding Studio will be present in the workspace only if the studio is modified (via this resource).

input_schema: InputSchema = <PLACEHOLDER>: input_schema is the schema for the studio inputs that are processed by template.

key: StudioKey = <PLACEHOLDER>: key uniquely identifies the studio.

remove: bool | None = <PLACEHOLDER>: remove indicates whether to remove (true) or add (false, unset) the studio identified by the key if the encompassing workspace merges. Other data fields are not allowed if this field is set to true.

template: Template = <PLACEHOLDER>: template is a script that builds the device configuration from the inputs that are described by input_schema.

class cloudvision.api.arista.studio.v1.StudioConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('StudioConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioConfigBatchedStreamResponse(responses: List[ForwardRef('StudioConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[StudioConfigStreamResponse] = <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.studio.v1.StudioConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('StudioConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[StudioConfig] = <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.studio.v1.StudioConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: StudioKey = <PLACEHOLDER>: This is the key of the StudioConfig 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.studio.v1.StudioConfigDeleteRequest(key: 'StudioKey' = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key indicates which StudioConfig instance to remove. This field must always be set.

class cloudvision.api.arista.studio.v1.StudioConfigDeleteResponse(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key echoes back the key of the deleted StudioConfig 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.studio.v1.StudioConfigDeleteSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <PLACEHOLDER>: key contains a list of StudioConfig keys to delete

class cloudvision.api.arista.studio.v1.StudioConfigDeleteSomeResponse(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

StudioConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: StudioKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.StudioConfigRequest(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key uniquely identifies a StudioConfig 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.studio.v1.StudioConfigResponse(value: 'StudioConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the StudioConfig instance in this response.

value: StudioConfig = <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.studio.v1.StudioConfigServiceBase[source]

Bases: ServiceBase

async delete(studio_config_delete_request: StudioConfigDeleteRequest) → StudioConfigDeleteResponse[source]

async delete_all(studio_config_delete_all_request: StudioConfigDeleteAllRequest) → AsyncIterator[StudioConfigDeleteAllResponse][source]

async delete_some(studio_config_delete_some_request: StudioConfigDeleteSomeRequest) → AsyncIterator[StudioConfigDeleteSomeResponse][source]

async get_all(studio_config_stream_request: StudioConfigStreamRequest) → AsyncIterator[StudioConfigStreamResponse][source]

async get_all_batched(studio_config_batched_stream_request: StudioConfigBatchedStreamRequest) → AsyncIterator[StudioConfigBatchedStreamResponse][source]

async get_meta(studio_config_stream_request: StudioConfigStreamRequest) → MetaResponse[source]

async get_one(studio_config_request: StudioConfigRequest) → StudioConfigResponse[source]

async get_some(studio_config_some_request: StudioConfigSomeRequest) → AsyncIterator[StudioConfigSomeResponse][source]

async set(studio_config_set_request: StudioConfigSetRequest) → StudioConfigSetResponse[source]

async set_some(studio_config_set_some_request: StudioConfigSetSomeRequest) → AsyncIterator[StudioConfigSetSomeResponse][source]

async subscribe(studio_config_stream_request: StudioConfigStreamRequest) → AsyncIterator[StudioConfigStreamResponse][source]

async subscribe_batched(studio_config_batched_stream_request: StudioConfigBatchedStreamRequest) → AsyncIterator[StudioConfigBatchedStreamResponse][source]

async subscribe_meta(studio_config_stream_request: StudioConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(studio_config_delete_request: StudioConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioConfigDeleteResponse[source]

async delete_all(studio_config_delete_all_request: StudioConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigDeleteAllResponse][source]

async delete_some(studio_config_delete_some_request: StudioConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigDeleteSomeResponse][source]

async get_all(studio_config_stream_request: StudioConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigStreamResponse][source]

async get_all_batched(studio_config_batched_stream_request: StudioConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigBatchedStreamResponse][source]

async get_meta(studio_config_stream_request: StudioConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(studio_config_request: StudioConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioConfigResponse[source]

async get_some(studio_config_some_request: StudioConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigSomeResponse][source]

async set(studio_config_set_request: StudioConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioConfigSetResponse[source]

async set_some(studio_config_set_some_request: StudioConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigSetSomeResponse][source]

async subscribe(studio_config_stream_request: StudioConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigStreamResponse][source]

async subscribe_batched(studio_config_batched_stream_request: StudioConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioConfigBatchedStreamResponse][source]

async subscribe_meta(studio_config_stream_request: StudioConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.StudioConfigSetRequest(value: 'StudioConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: StudioConfig = <PLACEHOLDER>: StudioConfig carries the value to set into the datastore. See the documentation on the StudioConfig struct for which fields are required.

class cloudvision.api.arista.studio.v1.StudioConfigSetResponse(value: 'StudioConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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: StudioConfig = <PLACEHOLDER>: Value carries all the values given in the StudioConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.studio.v1.StudioConfigSetSomeRequest(values: List[ForwardRef('StudioConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[StudioConfig] = <PLACEHOLDER>

value contains a list of StudioConfig 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.studio.v1.StudioConfigSetSomeResponse(key: 'StudioKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: StudioKey = <PLACEHOLDER>

class cloudvision.api.arista.studio.v1.StudioConfigSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <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.studio.v1.StudioConfigSomeResponse(value: 'StudioConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 StudioConfig instance in this response.

value: StudioConfig = <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.studio.v1.StudioConfigStreamRequest(partial_eq_filter: List[ForwardRef('StudioConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[StudioConfig] = <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 StudioConfig at end. * Each StudioConfig response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioConfigStreamResponse(value: 'StudioConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this StudioConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the StudioConfig 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: StudioConfig = <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.studio.v1.StudioKey(studio_id: str | None = <PLACEHOLDER>, workspace_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

StudioKey uniquely identifies a studio.

studio_id: str | None = <PLACEHOLDER>: studio_id uniquely identifies the studio in the workspace indicated by workspace_id.

workspace_id: str | None = <PLACEHOLDER>: workspace_id identifies the workspace within which the studio resides.

class cloudvision.api.arista.studio.v1.StudioRequest(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key uniquely identifies a Studio 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.studio.v1.StudioResponse(value: 'Studio' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Studio instance in this response.

value: Studio = <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.studio.v1.StudioServiceBase[source]

Bases: ServiceBase

async get_all(studio_stream_request: StudioStreamRequest) → AsyncIterator[StudioStreamResponse][source]

async get_all_batched(studio_batched_stream_request: StudioBatchedStreamRequest) → AsyncIterator[StudioBatchedStreamResponse][source]

async get_meta(studio_stream_request: StudioStreamRequest) → MetaResponse[source]

async get_one(studio_request: StudioRequest) → StudioResponse[source]

async get_some(studio_some_request: StudioSomeRequest) → AsyncIterator[StudioSomeResponse][source]

async subscribe(studio_stream_request: StudioStreamRequest) → AsyncIterator[StudioStreamResponse][source]

async subscribe_batched(studio_batched_stream_request: StudioBatchedStreamRequest) → AsyncIterator[StudioBatchedStreamResponse][source]

async subscribe_meta(studio_stream_request: StudioStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(studio_stream_request: StudioStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioStreamResponse][source]

async get_all_batched(studio_batched_stream_request: StudioBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioBatchedStreamResponse][source]

async get_meta(studio_stream_request: StudioStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(studio_request: StudioRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioResponse[source]

async get_some(studio_some_request: StudioSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSomeResponse][source]

async subscribe(studio_stream_request: StudioStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioStreamResponse][source]

async subscribe_batched(studio_batched_stream_request: StudioBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioBatchedStreamResponse][source]

async subscribe_meta(studio_stream_request: StudioStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.StudioSomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <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.studio.v1.StudioSomeResponse(value: 'Studio' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 Studio instance in this response.

value: Studio = <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.studio.v1.StudioStreamRequest(partial_eq_filter: List[ForwardRef('Studio')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Studio] = <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 Studio at end. * Each Studio response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioStreamResponse(value: 'Studio' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Studio’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Studio 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: Studio = <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.studio.v1.StudioSummary(key: ~cloudvision.api.arista.studio.v1.StudioKey = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, immutable: bool | None = <PLACEHOLDER>, entities: ~cloudvision.api.arista.studio.v1.Entities = <PLACEHOLDER>, in_use: bool | None = <PLACEHOLDER>, from_package: str | None = <PLACEHOLDER>)[source]

Bases: Message

StudioSummary holds basic information about a studio.

description: str | None = <PLACEHOLDER>: description is a brief description of the studio.

display_name: str | None = <PLACEHOLDER>: display_name is the name of this studio as displayed on the UI.

entities: Entities = <PLACEHOLDER>: entities indicate all the entities of the studio.

from_package: str | None = <PLACEHOLDER>: from_package indicates that this studio was created by a package, and can only be modified by the packaging service. It stores packageID.

immutable: bool | None = <PLACEHOLDER>: immutable indicates if read-write studio management access over a given studio is granted or not. If studio is immutable, its display name, description, schema and template cannot be modified.

in_use: bool | None = <PLACEHOLDER>: in_use indicates that the studio is in use, i.e. there are non-empty inputs, and assigned to some devices, either in a given workspace, or in mainline.

key: StudioKey = <PLACEHOLDER>: key uniquely identifies the studio.

class cloudvision.api.arista.studio.v1.StudioSummaryBatchedStreamRequest(partial_eq_filter: List[ForwardRef('StudioSummary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

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

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioSummaryBatchedStreamResponse(responses: List[ForwardRef('StudioSummaryStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[StudioSummaryStreamResponse] = <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.studio.v1.StudioSummaryRequest(key: 'StudioKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: StudioKey = <PLACEHOLDER>: Key uniquely identifies a StudioSummary 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.studio.v1.StudioSummaryResponse(value: 'StudioSummary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the StudioSummary instance in this response.

value: StudioSummary = <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.studio.v1.StudioSummaryServiceBase[source]

Bases: ServiceBase

async get_all(studio_summary_stream_request: StudioSummaryStreamRequest) → AsyncIterator[StudioSummaryStreamResponse][source]

async get_all_batched(studio_summary_batched_stream_request: StudioSummaryBatchedStreamRequest) → AsyncIterator[StudioSummaryBatchedStreamResponse][source]

async get_meta(studio_summary_stream_request: StudioSummaryStreamRequest) → MetaResponse[source]

async get_one(studio_summary_request: StudioSummaryRequest) → StudioSummaryResponse[source]

async get_some(studio_summary_some_request: StudioSummarySomeRequest) → AsyncIterator[StudioSummarySomeResponse][source]

async subscribe(studio_summary_stream_request: StudioSummaryStreamRequest) → AsyncIterator[StudioSummaryStreamResponse][source]

async subscribe_batched(studio_summary_batched_stream_request: StudioSummaryBatchedStreamRequest) → AsyncIterator[StudioSummaryBatchedStreamResponse][source]

async subscribe_meta(studio_summary_stream_request: StudioSummaryStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(studio_summary_stream_request: StudioSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSummaryStreamResponse][source]

async get_all_batched(studio_summary_batched_stream_request: StudioSummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSummaryBatchedStreamResponse][source]

async get_meta(studio_summary_stream_request: StudioSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(studio_summary_request: StudioSummaryRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → StudioSummaryResponse[source]

async get_some(studio_summary_some_request: StudioSummarySomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSummarySomeResponse][source]

async subscribe(studio_summary_stream_request: StudioSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSummaryStreamResponse][source]

async subscribe_batched(studio_summary_batched_stream_request: StudioSummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[StudioSummaryBatchedStreamResponse][source]

async subscribe_meta(studio_summary_stream_request: StudioSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.studio.v1.StudioSummarySomeRequest(keys: List[ForwardRef('StudioKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[StudioKey] = <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.studio.v1.StudioSummarySomeResponse(value: 'StudioSummary' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

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 StudioSummary instance in this response.

value: StudioSummary = <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.studio.v1.StudioSummaryStreamRequest(partial_eq_filter: List[ForwardRef('StudioSummary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[StudioSummary] = <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 StudioSummary at end. * Each StudioSummary response is fully-specified (all fields set).

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

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

be partial.

class cloudvision.api.arista.studio.v1.StudioSummaryStreamResponse(value: 'StudioSummary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this StudioSummary’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the StudioSummary 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: StudioSummary = <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.studio.v1.TagMatcherFieldMode(value: int)[source]

Bases: Enum

TagMatcherFieldMode defines the set of ways a tag query for matching device or interfaces can be specified in a studio.

MULTI_DEVICE_TAG = TagMatcherFieldMode.MULTI_DEVICE_TAG: TAG_MATCHER_FIELD_MODE_MULTI_DEVICE_TAG allows devices to be selected based on any tag label.

MULTI_INTERFACE_TAG = TagMatcherFieldMode.MULTI_INTERFACE_TAG: TAG_MATCHER_FIELD_MODE_MULTI_INTERFACE_TAG allows interfaces to be selected based on any tag label.

SINGLE_DEVICE_TAG = TagMatcherFieldMode.SINGLE_DEVICE_TAG: TAG_MATCHER_FIELD_MODE_SINGLE_DEVICE_TAG allows devices to be selected based on a single tag label.

SINGLE_INTERFACE_TAG = TagMatcherFieldMode.SINGLE_INTERFACE_TAG: TAG_MATCHER_FIELD_MODE_SINGLE_INTERFACE_TAG allows interfaces to be selected based on a single tag label.

UNSPECIFIED = TagMatcherFieldMode.UNSPECIFIED: TAG_MATCHER_FIELD_MODE_UNSPECIFIED indicates an unspecified tag matcher mode.

name: str | None

value: int

class cloudvision.api.arista.studio.v1.TagMatcherInputFieldProps(tag_matcher_mode: ~cloudvision.api.arista.studio.v1.TagMatcherFieldMode = <PLACEHOLDER>, tag_matcher_label: str | None = <PLACEHOLDER>, tag_filter_query: str | None = <PLACEHOLDER>, resolver_filtering_allowed: bool | None = <PLACEHOLDER>)[source]

Bases: Message

TagMatcherInputFieldProps defines the set of properties for a single selector field in a studio input schema.

resolver_filtering_allowed: bool | None = <PLACEHOLDER>: resolver_filtering_allowed indicates whether results of the match query be filtered based on what any parent resolvers allow. This is true by default.

tag_filter_query: str | None = <PLACEHOLDER>: tag_filter_query limits the set of devices that the match query can return. E.g., “device:D1,D2” will constrain results to the devices D1 and D2.

tag_matcher_label: str | None = <PLACEHOLDER>: tag_matcher_label can be used when tag_matcher_mode is one of TAG_MATCHER_FIELD_MODE_SINGLE_*_TAG and it specifies the tag label which must be used in the match query.

tag_matcher_mode: TagMatcherFieldMode = <PLACEHOLDER>: tag_matcher_mode (required) is the tag mode of the matcher.

class cloudvision.api.arista.studio.v1.Template(type: ~cloudvision.api.arista.studio.v1.TemplateType = <PLACEHOLDER>, body: str | None = <PLACEHOLDER>)[source]

Bases: Message

Template defines a template for a studio.

body: str | None = <PLACEHOLDER>: body contains the actual source code of the template.

type: TemplateType = <PLACEHOLDER>: type specifies the language that this template uses.

class cloudvision.api.arista.studio.v1.TemplateType(value: int)[source]

Bases: Enum

TemplateType defines the set of supported languages that can be used in studio templates.

GO = TemplateType.GO

TEMPLATE_TYPE_GO is the Go templating language. More information: https://pkg.go.dev/text/template

NOTE: Not all template functions are supported for this type.

JINJA = TemplateType.JINJA: TEMPLATE_TYPE_JINJA is the Jinja templating language for Python. More information: https://palletsprojects.com/p/jinja

MAKO = TemplateType.MAKO: TEMPLATE_TYPE_MAKO is the Mako templating language for Python. More information: https://www.makotemplates.org

UNSPECIFIED = TemplateType.UNSPECIFIED: TEMPLATE_TYPE_UNSPECIFIED indicates an unspecified template type.

name: str | None

value: int