cloudvision.api.arista.redirector.v1 package

Module contents

class cloudvision.api.arista.redirector.v1.Assignment(key: ~cloudvision.api.arista.redirector.v1.AssignmentKey = <PLACEHOLDER>, clusters: ~cloudvision.api.arista.redirector.v1.Clusters = <PLACEHOLDER>)[source]

Bases: Message

Assignment returns the information about the regional clusters that the system is assigned to. Each cluster consists of a series of hosts, each of which the client can use to connect.

clusters: Clusters = <PLACEHOLDER>: clusters that the system is assigned to.

key: AssignmentKey = <PLACEHOLDER>: key uniquely identifies the assignment of system_id to the cluster.

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

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

start and end: Returns the state of each Assignment at start, followed by updates until end. * Each Assignment 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.redirector.v1.AssignmentBatchedStreamResponse(responses: List[ForwardRef('AssignmentStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[AssignmentStreamResponse] = <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.redirector.v1.AssignmentKey(system_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

AssignmentKey allows to uniquely identify an assignment.

system_id: str | None = <PLACEHOLDER>: system_id is the unique identifier of a device.

class cloudvision.api.arista.redirector.v1.AssignmentRequest(key: 'AssignmentKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: AssignmentKey = <PLACEHOLDER>: Key uniquely identifies a Assignment 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.redirector.v1.AssignmentResponse(value: 'Assignment' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: Assignment = <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.redirector.v1.AssignmentServiceBase[source]

Bases: ServiceBase

async get_all(assignment_stream_request: AssignmentStreamRequest) → AsyncIterator[AssignmentStreamResponse][source]

async get_all_batched(assignment_batched_stream_request: AssignmentBatchedStreamRequest) → AsyncIterator[AssignmentBatchedStreamResponse][source]

async get_meta(assignment_stream_request: AssignmentStreamRequest) → MetaResponse[source]

async get_one(assignment_request: AssignmentRequest) → AssignmentResponse[source]

async get_some(assignment_some_request: AssignmentSomeRequest) → AsyncIterator[AssignmentSomeResponse][source]

async subscribe(assignment_stream_request: AssignmentStreamRequest) → AsyncIterator[AssignmentStreamResponse][source]

async subscribe_batched(assignment_batched_stream_request: AssignmentBatchedStreamRequest) → AsyncIterator[AssignmentBatchedStreamResponse][source]

async subscribe_meta(assignment_stream_request: AssignmentStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(assignment_stream_request: AssignmentStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignmentStreamResponse][source]

async get_all_batched(assignment_batched_stream_request: AssignmentBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignmentBatchedStreamResponse][source]

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

async get_one(assignment_request: AssignmentRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AssignmentResponse[source]

async get_some(assignment_some_request: AssignmentSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignmentSomeResponse][source]

async subscribe(assignment_stream_request: AssignmentStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignmentStreamResponse][source]

async subscribe_batched(assignment_batched_stream_request: AssignmentBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[AssignmentBatchedStreamResponse][source]

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

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

Bases: Message

keys: List[AssignmentKey] = <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.redirector.v1.AssignmentSomeResponse(value: 'Assignment' = <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: Assignment = <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.redirector.v1.AssignmentStreamRequest(partial_eq_filter: List[ForwardRef('Assignment')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

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

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

start and end: Returns the state of each Assignment at start, followed by updates until end. * Each Assignment 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.redirector.v1.AssignmentStreamResponse(value: 'Assignment' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Assignment 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: Assignment = <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.redirector.v1.Cluster(name: str | None = <PLACEHOLDER>, hosts: '___fmp__.RepeatedString' = <PLACEHOLDER>)[source]

Bases: Message

hosts: ___fmp__.RepeatedString = <PLACEHOLDER>: hosts in the cluster that the devices can connect to.

name: str | None = <PLACEHOLDER>: name of the cluster. The name can change over time as new clusters are added or removed.

class cloudvision.api.arista.redirector.v1.Clusters(values: ~typing.List[~cloudvision.api.arista.redirector.v1.Cluster] = <PLACEHOLDER>)[source]

Bases: Message

Clusters wraps a cluster list which contain the information about the hosts.

values: List[Cluster] = <PLACEHOLDER>: values contains the list of clusters associated with the region

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