cloudvision.api.arista.configlet.v1 package

Module contents

class cloudvision.api.arista.configlet.v1.Configlet(key: ~cloudvision.api.arista.configlet.v1.ConfigletKey = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, migrated_from: str | None = <PLACEHOLDER>, body: str | None = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, digest: str | None = <PLACEHOLDER>, size: int | None = <PLACEHOLDER>)[source]

Bases: Message

Configlet is the state of a static configlet in a workspace or mainline. Subscribe and GetAll do not return the “body” Use GetOne to get the body of individual configlets

body: str | None = <PLACEHOLDER>: body is the static configlet body.

created_at: datetime = <PLACEHOLDER>: created_at is the time when the Configlet was created.

created_by: str | None = <PLACEHOLDER>: created_by is the user who created the Configlet.

description: str | None = <PLACEHOLDER>: description is the description of the static configlet.

digest: str | None = <PLACEHOLDER>: digest is the sha256 hash of the configlet body encoded in hexadecimal.

display_name: str | None = <PLACEHOLDER>: display_name is the display name of the static configlet.

key: ConfigletKey = <PLACEHOLDER>

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time when the Configlet was last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the user who last modified the Configlet.

migrated_from: str | None = <PLACEHOLDER>: migrated_from is populated with the source configlet name when migrated from network provisioning to studio.

size: int | None = <PLACEHOLDER>: size of configlet body in bytes.

class cloudvision.api.arista.configlet.v1.ConfigletAssignment(key: ~cloudvision.api.arista.configlet.v1.ConfigletAssignmentKey = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, configlet_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, query: str | None = <PLACEHOLDER>, match_policy: ~cloudvision.api.arista.configlet.v1.MatchPolicy = <PLACEHOLDER>, child_assignment_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigletAssignment is the state of this assignment in a workspace/mainline

child_assignment_ids: ___fmp__.RepeatedString = <PLACEHOLDER>: list of child assignments

configlet_ids: ___fmp__.RepeatedString = <PLACEHOLDER>: configlet_ids is the list of configlets which are assigned

created_at: datetime = <PLACEHOLDER>: created_at is the time when the ConfigletAssignment was created.

created_by: str | None = <PLACEHOLDER>: created_by is the user who created the ConfigletAssignment.

description: str | None = <PLACEHOLDER>

display_name: str | None = <PLACEHOLDER>

key: ConfigletAssignmentKey = <PLACEHOLDER>

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at is the time when the ConfigletAssignment was last modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by is the user who last modified the ConfigletAssignment.

match_policy: MatchPolicy = <PLACEHOLDER>: match_policy is the discriminator for the query field

query: str | None = <PLACEHOLDER>: query represents the tag query assigned

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentBatchedStreamRequest(partial_eq_filter: List[ForwardRef('ConfigletAssignment')] = <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[ConfigletAssignment] = <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 ConfigletAssignment at end. * Each ConfigletAssignment response is fully-specified (all fields set).

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

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

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentBatchedStreamResponse(responses: List[ForwardRef('ConfigletAssignmentStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigletAssignmentStreamResponse] = <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.configlet.v1.ConfigletAssignmentConfig(key: ~cloudvision.api.arista.configlet.v1.ConfigletAssignmentKey = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, configlet_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>, query: str | None = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, match_policy: ~cloudvision.api.arista.configlet.v1.MatchPolicy = <PLACEHOLDER>, child_assignment_ids: ~cloudvision.api.fmp.RepeatedString = <PLACEHOLDER>)[source]

Bases: Message

ConfigletAssignmentConfig are the the inputs to the static configlet studio. Each assignment assigns a list of configlets to the devices matching the tag query. Individual assignments can have a list of “child” assignments. The totality of these assignments form a list of tree hierarchies. Using the corresponding GUI workflow should help explain this structure. When traversing a tree and assigning static configlets to devices, the following rules are applied: 1) Tag queries at each level need to resolve to a subset of its parent’s queries. Devices resolved in child assignments but which do not resolve in that of its parent’s are skipped. 2) Match policy determines how the assignment’s devices get divied up amongst its children.

child_assignment_ids: ___fmp__.RepeatedString = <PLACEHOLDER>: list of child assignments

configlet_ids: ___fmp__.RepeatedString = <PLACEHOLDER>: configlet_ids is the list of configlets to be assigned

description: str | None = <PLACEHOLDER>

display_name: str | None = <PLACEHOLDER>

key: ConfigletAssignmentKey = <PLACEHOLDER>

match_policy: MatchPolicy = <PLACEHOLDER>: match_policy is the discriminator for the query field

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. malformed queries result in an error tags not matching devices are ignored

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigBatchedStreamResponse(responses: List[ForwardRef('ConfigletAssignmentConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigletAssignmentConfigStreamResponse] = <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.configlet.v1.ConfigletAssignmentConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ConfigletAssignmentConfig')] = <PLACEHOLDER>)[source]

Bases: Message

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

Bases: Message

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

key: ConfigletAssignmentKey = <PLACEHOLDER>: This is the key of the ConfigletAssignmentConfig 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.configlet.v1.ConfigletAssignmentConfigDeleteRequest(key: 'ConfigletAssignmentKey' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigDeleteResponse(key: 'ConfigletAssignmentKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletAssignmentKey = <PLACEHOLDER>: Key echoes back the key of the deleted ConfigletAssignmentConfig 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.configlet.v1.ConfigletAssignmentConfigDeleteSomeRequest(keys: List[ForwardRef('ConfigletAssignmentKey')] = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigDeleteSomeResponse(key: ~cloudvision.api.arista.configlet.v1.ConfigletAssignmentKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ConfigletAssignmentConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ConfigletAssignmentKey = <PLACEHOLDER>

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigRequest(key: 'ConfigletAssignmentKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletAssignmentKey = <PLACEHOLDER>: Key uniquely identifies a ConfigletAssignmentConfig 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.configlet.v1.ConfigletAssignmentConfigResponse(value: 'ConfigletAssignmentConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ConfigletAssignmentConfig = <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.configlet.v1.ConfigletAssignmentConfigServiceBase[source]

Bases: ServiceBase

async delete(configlet_assignment_config_delete_request: ConfigletAssignmentConfigDeleteRequest) → ConfigletAssignmentConfigDeleteResponse[source]

async delete_all(configlet_assignment_config_delete_all_request: ConfigletAssignmentConfigDeleteAllRequest) → AsyncIterator[ConfigletAssignmentConfigDeleteAllResponse][source]

async delete_some(configlet_assignment_config_delete_some_request: ConfigletAssignmentConfigDeleteSomeRequest) → AsyncIterator[ConfigletAssignmentConfigDeleteSomeResponse][source]

async get_all(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest) → AsyncIterator[ConfigletAssignmentConfigStreamResponse][source]

async get_all_batched(configlet_assignment_config_batched_stream_request: ConfigletAssignmentConfigBatchedStreamRequest) → AsyncIterator[ConfigletAssignmentConfigBatchedStreamResponse][source]

async get_meta(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest) → MetaResponse[source]

async get_one(configlet_assignment_config_request: ConfigletAssignmentConfigRequest) → ConfigletAssignmentConfigResponse[source]

async get_some(configlet_assignment_config_some_request: ConfigletAssignmentConfigSomeRequest) → AsyncIterator[ConfigletAssignmentConfigSomeResponse][source]

async set(configlet_assignment_config_set_request: ConfigletAssignmentConfigSetRequest) → ConfigletAssignmentConfigSetResponse[source]

async set_some(configlet_assignment_config_set_some_request: ConfigletAssignmentConfigSetSomeRequest) → AsyncIterator[ConfigletAssignmentConfigSetSomeResponse][source]

async subscribe(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest) → AsyncIterator[ConfigletAssignmentConfigStreamResponse][source]

async subscribe_batched(configlet_assignment_config_batched_stream_request: ConfigletAssignmentConfigBatchedStreamRequest) → AsyncIterator[ConfigletAssignmentConfigBatchedStreamResponse][source]

async subscribe_meta(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(configlet_assignment_config_delete_request: ConfigletAssignmentConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletAssignmentConfigDeleteResponse[source]

async delete_all(configlet_assignment_config_delete_all_request: ConfigletAssignmentConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigDeleteAllResponse][source]

async delete_some(configlet_assignment_config_delete_some_request: ConfigletAssignmentConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigDeleteSomeResponse][source]

async get_all(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigStreamResponse][source]

async get_all_batched(configlet_assignment_config_batched_stream_request: ConfigletAssignmentConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigBatchedStreamResponse][source]

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

async get_one(configlet_assignment_config_request: ConfigletAssignmentConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletAssignmentConfigResponse[source]

async get_some(configlet_assignment_config_some_request: ConfigletAssignmentConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigSomeResponse][source]

async set(configlet_assignment_config_set_request: ConfigletAssignmentConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletAssignmentConfigSetResponse[source]

async set_some(configlet_assignment_config_set_some_request: ConfigletAssignmentConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigSetSomeResponse][source]

async subscribe(configlet_assignment_config_stream_request: ConfigletAssignmentConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigStreamResponse][source]

async subscribe_batched(configlet_assignment_config_batched_stream_request: ConfigletAssignmentConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentConfigBatchedStreamResponse][source]

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

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigSetRequest(value: 'ConfigletAssignmentConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigSetResponse(value: 'ConfigletAssignmentConfig' = <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: ConfigletAssignmentConfig = <PLACEHOLDER>: Value carries all the values given in the ConfigletAssignmentConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentConfigSetSomeRequest(values: List[ForwardRef('ConfigletAssignmentConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ConfigletAssignmentConfig] = <PLACEHOLDER>

value contains a list of ConfigletAssignmentConfig 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.configlet.v1.ConfigletAssignmentConfigSetSomeResponse(key: 'ConfigletAssignmentKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ConfigletAssignmentKey = <PLACEHOLDER>

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

Bases: Message

keys: List[ConfigletAssignmentKey] = <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.configlet.v1.ConfigletAssignmentConfigSomeResponse(value: 'ConfigletAssignmentConfig' = <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>

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

Bases: Message

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ConfigletAssignmentConfig 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: ConfigletAssignmentConfig = <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.configlet.v1.ConfigletAssignmentKey(workspace_id: str | None = <PLACEHOLDER>, configlet_assignment_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigletAssignmentKey uniquely identifies a configlet assignment

configlet_assignment_id: str | None = <PLACEHOLDER>: configlet_assignment_id is the unique identifier of the configlet_assignment.

workspace_id: str | None = <PLACEHOLDER>: workspace_id is the unique identifier of the workspace.

class cloudvision.api.arista.configlet.v1.ConfigletAssignmentRequest(key: 'ConfigletAssignmentKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletAssignmentKey = <PLACEHOLDER>: Key uniquely identifies a ConfigletAssignment 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.configlet.v1.ConfigletAssignmentResponse(value: 'ConfigletAssignment' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ConfigletAssignment = <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.configlet.v1.ConfigletAssignmentServiceBase[source]

Bases: ServiceBase

async get_all(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest) → AsyncIterator[ConfigletAssignmentStreamResponse][source]

async get_all_batched(configlet_assignment_batched_stream_request: ConfigletAssignmentBatchedStreamRequest) → AsyncIterator[ConfigletAssignmentBatchedStreamResponse][source]

async get_meta(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest) → MetaResponse[source]

async get_one(configlet_assignment_request: ConfigletAssignmentRequest) → ConfigletAssignmentResponse[source]

async get_some(configlet_assignment_some_request: ConfigletAssignmentSomeRequest) → AsyncIterator[ConfigletAssignmentSomeResponse][source]

async subscribe(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest) → AsyncIterator[ConfigletAssignmentStreamResponse][source]

async subscribe_batched(configlet_assignment_batched_stream_request: ConfigletAssignmentBatchedStreamRequest) → AsyncIterator[ConfigletAssignmentBatchedStreamResponse][source]

async subscribe_meta(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentStreamResponse][source]

async get_all_batched(configlet_assignment_batched_stream_request: ConfigletAssignmentBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentBatchedStreamResponse][source]

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

async get_one(configlet_assignment_request: ConfigletAssignmentRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletAssignmentResponse[source]

async get_some(configlet_assignment_some_request: ConfigletAssignmentSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentSomeResponse][source]

async subscribe(configlet_assignment_stream_request: ConfigletAssignmentStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentStreamResponse][source]

async subscribe_batched(configlet_assignment_batched_stream_request: ConfigletAssignmentBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletAssignmentBatchedStreamResponse][source]

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

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

Bases: Message

keys: List[ConfigletAssignmentKey] = <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.configlet.v1.ConfigletAssignmentSomeResponse(value: 'ConfigletAssignment' = <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>

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

Bases: Message

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ConfigletAssignment 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: ConfigletAssignment = <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.configlet.v1.ConfigletBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Configlet')] = <PLACEHOLDER>, filter: 'Filter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

filter: Filter = <PLACEHOLDER>: For each Configlet in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Configlet is streamed to the user.

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.configlet.v1.ConfigletBatchedStreamResponse(responses: List[ForwardRef('ConfigletStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigletStreamResponse] = <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.configlet.v1.ConfigletConfig(key: ~cloudvision.api.arista.configlet.v1.ConfigletKey = <PLACEHOLDER>, remove: bool | None = <PLACEHOLDER>, display_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, migrated_from: str | None = <PLACEHOLDER>, body: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigletConfig updates a static configlet in a workspace.

body: str | None = <PLACEHOLDER>: body is the static configlet body.

description: str | None = <PLACEHOLDER>: description is the description of the static configlet.

display_name: str | None = <PLACEHOLDER>: display_name is the display name of the static configlet.

key: ConfigletKey = <PLACEHOLDER>

migrated_from: str | None = <PLACEHOLDER>: migrated_from is populated with the source configlet name when migrated from network provisioning to studio.

remove: bool | None = <PLACEHOLDER>: remove specifies the static configlet is to be removed from the workspace. Other data fields are not allowed when this field is set to true.

class cloudvision.api.arista.configlet.v1.ConfigletConfigBatchedStreamRequest(partial_eq_filter: List[ForwardRef('ConfigletConfig')] = <PLACEHOLDER>, filter: 'Filter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

filter: Filter = <PLACEHOLDER>: For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig is streamed to the user.

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.configlet.v1.ConfigletConfigBatchedStreamResponse(responses: List[ForwardRef('ConfigletConfigStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigletConfigStreamResponse] = <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.configlet.v1.ConfigletConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ConfigletConfig')] = <PLACEHOLDER>, filter: 'Filter' = <PLACEHOLDER>)[source]

Bases: Message

filter: Filter = <PLACEHOLDER>: For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig will be deleted.

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

Bases: Message

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

key: ConfigletKey = <PLACEHOLDER>: This is the key of the ConfigletConfig 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.configlet.v1.ConfigletConfigDeleteRequest(key: 'ConfigletKey' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletConfigDeleteResponse(key: 'ConfigletKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletKey = <PLACEHOLDER>: Key echoes back the key of the deleted ConfigletConfig 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.configlet.v1.ConfigletConfigDeleteSomeRequest(keys: List[ForwardRef('ConfigletKey')] = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletConfigDeleteSomeResponse(key: ~cloudvision.api.arista.configlet.v1.ConfigletKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ConfigletConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ConfigletKey = <PLACEHOLDER>

class cloudvision.api.arista.configlet.v1.ConfigletConfigRequest(key: 'ConfigletKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletKey = <PLACEHOLDER>: Key uniquely identifies a ConfigletConfig 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.configlet.v1.ConfigletConfigResponse(value: 'ConfigletConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ConfigletConfig = <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.configlet.v1.ConfigletConfigServiceBase[source]

Bases: ServiceBase

async delete(configlet_config_delete_request: ConfigletConfigDeleteRequest) → ConfigletConfigDeleteResponse[source]

async delete_all(configlet_config_delete_all_request: ConfigletConfigDeleteAllRequest) → AsyncIterator[ConfigletConfigDeleteAllResponse][source]

async delete_some(configlet_config_delete_some_request: ConfigletConfigDeleteSomeRequest) → AsyncIterator[ConfigletConfigDeleteSomeResponse][source]

async get_all(configlet_config_stream_request: ConfigletConfigStreamRequest) → AsyncIterator[ConfigletConfigStreamResponse][source]

async get_all_batched(configlet_config_batched_stream_request: ConfigletConfigBatchedStreamRequest) → AsyncIterator[ConfigletConfigBatchedStreamResponse][source]

async get_meta(configlet_config_stream_request: ConfigletConfigStreamRequest) → MetaResponse[source]

async get_one(configlet_config_request: ConfigletConfigRequest) → ConfigletConfigResponse[source]

async get_some(configlet_config_some_request: ConfigletConfigSomeRequest) → AsyncIterator[ConfigletConfigSomeResponse][source]

async set(configlet_config_set_request: ConfigletConfigSetRequest) → ConfigletConfigSetResponse[source]

async set_some(configlet_config_set_some_request: ConfigletConfigSetSomeRequest) → AsyncIterator[ConfigletConfigSetSomeResponse][source]

async subscribe(configlet_config_stream_request: ConfigletConfigStreamRequest) → AsyncIterator[ConfigletConfigStreamResponse][source]

async subscribe_batched(configlet_config_batched_stream_request: ConfigletConfigBatchedStreamRequest) → AsyncIterator[ConfigletConfigBatchedStreamResponse][source]

async subscribe_meta(configlet_config_stream_request: ConfigletConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(configlet_config_delete_request: ConfigletConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletConfigDeleteResponse[source]

async delete_all(configlet_config_delete_all_request: ConfigletConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigDeleteAllResponse][source]

async delete_some(configlet_config_delete_some_request: ConfigletConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigDeleteSomeResponse][source]

async get_all(configlet_config_stream_request: ConfigletConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigStreamResponse][source]

async get_all_batched(configlet_config_batched_stream_request: ConfigletConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigBatchedStreamResponse][source]

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

async get_one(configlet_config_request: ConfigletConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletConfigResponse[source]

async get_some(configlet_config_some_request: ConfigletConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigSomeResponse][source]

async set(configlet_config_set_request: ConfigletConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletConfigSetResponse[source]

async set_some(configlet_config_set_some_request: ConfigletConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigSetSomeResponse][source]

async subscribe(configlet_config_stream_request: ConfigletConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigStreamResponse][source]

async subscribe_batched(configlet_config_batched_stream_request: ConfigletConfigBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletConfigBatchedStreamResponse][source]

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

class cloudvision.api.arista.configlet.v1.ConfigletConfigSetRequest(value: 'ConfigletConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.configlet.v1.ConfigletConfigSetResponse(value: 'ConfigletConfig' = <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: ConfigletConfig = <PLACEHOLDER>: Value carries all the values given in the ConfigletConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.configlet.v1.ConfigletConfigSetSomeRequest(values: List[ForwardRef('ConfigletConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ConfigletConfig] = <PLACEHOLDER>

value contains a list of ConfigletConfig 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.configlet.v1.ConfigletConfigSetSomeResponse(key: 'ConfigletKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ConfigletKey = <PLACEHOLDER>

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

Bases: Message

keys: List[ConfigletKey] = <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.configlet.v1.ConfigletConfigSomeResponse(value: 'ConfigletConfig' = <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>

value: ConfigletConfig = <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.configlet.v1.ConfigletConfigStreamRequest(partial_eq_filter: List[ForwardRef('ConfigletConfig')] = <PLACEHOLDER>, filter: 'Filter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

filter: Filter = <PLACEHOLDER>: For each ConfigletConfig in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ConfigletConfig is streamed to the user.

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ConfigletConfig 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: ConfigletConfig = <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.configlet.v1.ConfigletKey(workspace_id: str | None = <PLACEHOLDER>, configlet_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigletKey uniquely identifies a static configlet.

configlet_id: str | None = <PLACEHOLDER>: configlet_id is the static configlet ID.

workspace_id: str | None = <PLACEHOLDER>: workspace_id identifies the workspace within which the static configlet resides empty string (“”) stands for the “mainline”.

class cloudvision.api.arista.configlet.v1.ConfigletRequest(key: 'ConfigletKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigletKey = <PLACEHOLDER>: Key uniquely identifies a Configlet 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.configlet.v1.ConfigletResponse(value: 'Configlet' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: Configlet = <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.configlet.v1.ConfigletServiceBase[source]

Bases: ServiceBase

async get_all(configlet_stream_request: ConfigletStreamRequest) → AsyncIterator[ConfigletStreamResponse][source]

async get_all_batched(configlet_batched_stream_request: ConfigletBatchedStreamRequest) → AsyncIterator[ConfigletBatchedStreamResponse][source]

async get_meta(configlet_stream_request: ConfigletStreamRequest) → MetaResponse[source]

async get_one(configlet_request: ConfigletRequest) → ConfigletResponse[source]

async get_some(configlet_some_request: ConfigletSomeRequest) → AsyncIterator[ConfigletSomeResponse][source]

async subscribe(configlet_stream_request: ConfigletStreamRequest) → AsyncIterator[ConfigletStreamResponse][source]

async subscribe_batched(configlet_batched_stream_request: ConfigletBatchedStreamRequest) → AsyncIterator[ConfigletBatchedStreamResponse][source]

async subscribe_meta(configlet_stream_request: ConfigletStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(configlet_stream_request: ConfigletStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletStreamResponse][source]

async get_all_batched(configlet_batched_stream_request: ConfigletBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletBatchedStreamResponse][source]

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

async get_one(configlet_request: ConfigletRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ConfigletResponse[source]

async get_some(configlet_some_request: ConfigletSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletSomeResponse][source]

async subscribe(configlet_stream_request: ConfigletStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletStreamResponse][source]

async subscribe_batched(configlet_batched_stream_request: ConfigletBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ConfigletBatchedStreamResponse][source]

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

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

Bases: Message

keys: List[ConfigletKey] = <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.configlet.v1.ConfigletSomeResponse(value: 'Configlet' = <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>

value: Configlet = <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.configlet.v1.ConfigletStreamRequest(partial_eq_filter: List[ForwardRef('Configlet')] = <PLACEHOLDER>, filter: 'Filter' = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

filter: Filter = <PLACEHOLDER>: For each Configlet in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given Configlet is streamed to the user.

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

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

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

be partial.

This field is not allowed in the Subscribe RPC.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Configlet 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: Configlet = <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.configlet.v1.Filter(include_body: bool | None = <PLACEHOLDER>)[source]

Bases: Message

Filter is used to filter static configlets.

include_body: bool | None = <PLACEHOLDER>: include_body specifies the static configlet body is to be included.

class cloudvision.api.arista.configlet.v1.MatchPolicy(value: int)[source]

Bases: Enum

MatchPolicy specifies how the tag query of a configlet assignment should be used to resolve devices for its children

MATCH_ALL = MatchPolicy.MATCH_ALL: MATCH_POLICY_MATCH_ALL dictates that matching devices are used across all children

MATCH_FIRST = MatchPolicy.MATCH_FIRST: MATCH_POLICY_MATCH_FIRST dictates that matching devices are used only for the first match amongst its children

UNSPECIFIED = MatchPolicy.UNSPECIFIED

name: str | None

value: int

class cloudvision.api.arista.configlet.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.