cloudvision.api.arista.connectivitymonitor.v1 package

Module contents

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

Bases: Message

count: int | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again.

class cloudvision.api.arista.connectivitymonitor.v1.Probe(key: ~cloudvision.api.arista.connectivitymonitor.v1.ProbeKey = <PLACEHOLDER>, ip_addr: str | None = <PLACEHOLDER>, host_name: str | None = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>)

Bases: Message

Probe is identifying information of a connectivity monitor probe. It is used to retrieve probe information without getting the corresponding stats so that probe information can be displayed without streaming all related data, such as in the UI.

description: str | None = <PLACEHOLDER>

description is the description of the probe.

host_name: str | None = <PLACEHOLDER>

host_name is the name of the host of the probe.

ip_addr: str | None = <PLACEHOLDER>

ip_addr is the IP Address of the probe.

key: ProbeKey = <PLACEHOLDER>

key uniquely identifies the connectivity monitor probe.

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

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

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

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

• start and end: Returns the state of each Probe at start, followed by updates until end. * Each Probe 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.connectivitymonitor.v1.ProbeBatchedStreamResponse(responses: List[ForwardRef('ProbeStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[ProbeStreamResponse] = <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.connectivitymonitor.v1.ProbeKey(device_id: str | None = <PLACEHOLDER>, host: str | None = <PLACEHOLDER>, vrf: str | None = <PLACEHOLDER>)

Bases: Message

ProbeKey uniquely identifies a connectivity monitor probe.

device_id: str | None = <PLACEHOLDER>

device_id is the id of the device in the probe.

host: str | None = <PLACEHOLDER>

host is the hostname used in the probe.

vrf: str | None = <PLACEHOLDER>

vrf is the name of the VRF in the probe.

class cloudvision.api.arista.connectivitymonitor.v1.ProbeRequest(key: 'ProbeKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: ProbeKey = <PLACEHOLDER>

Key uniquely identifies a Probe 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.connectivitymonitor.v1.ProbeResponse(value: 'Probe' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

value: Probe = <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.connectivitymonitor.v1.ProbeServiceBase

Bases: ServiceBase

async get_all(probe_stream_request: ProbeStreamRequest) → AsyncIterator[ProbeStreamResponse]

async get_all_batched(probe_batched_stream_request: ProbeBatchedStreamRequest) → AsyncIterator[ProbeBatchedStreamResponse]

async get_meta(probe_stream_request: ProbeStreamRequest) → MetaResponse

async get_one(probe_request: ProbeRequest) → ProbeResponse

async get_some(probe_some_request: ProbeSomeRequest) → AsyncIterator[ProbeSomeResponse]

async subscribe(probe_stream_request: ProbeStreamRequest) → AsyncIterator[ProbeStreamResponse]

async subscribe_batched(probe_batched_stream_request: ProbeBatchedStreamRequest) → AsyncIterator[ProbeBatchedStreamResponse]

async subscribe_meta(probe_stream_request: ProbeStreamRequest) → AsyncIterator[MetaResponse]

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

Bases: ServiceStub

async get_all(probe_stream_request: ProbeStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStreamResponse]

async get_all_batched(probe_batched_stream_request: ProbeBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeBatchedStreamResponse]

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

async get_one(probe_request: ProbeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ProbeResponse

async get_some(probe_some_request: ProbeSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeSomeResponse]

async subscribe(probe_stream_request: ProbeStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStreamResponse]

async subscribe_batched(probe_batched_stream_request: ProbeBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeBatchedStreamResponse]

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

class cloudvision.api.arista.connectivitymonitor.v1.ProbeSomeRequest(keys: List[ForwardRef('ProbeKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[ProbeKey] = <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.connectivitymonitor.v1.ProbeSomeResponse(value: 'Probe' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

value: Probe = <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.connectivitymonitor.v1.ProbeStats(key: ~cloudvision.api.arista.connectivitymonitor.v1.ProbeStatsKey = <PLACEHOLDER>, latency_millis: float | None = <PLACEHOLDER>, jitter_millis: float | None = <PLACEHOLDER>, http_response_time_millis: float | None = <PLACEHOLDER>, packet_loss_percent: int | None = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>)

Bases: Message

ProbeStats is the connectivity monitor statistics related to the specified probe.

error: str | None = <PLACEHOLDER>

error is the error reported on the connection.

http_response_time_millis: float | None = <PLACEHOLDER>

http_response_time_millis is the amount of time taken to respond to a http request between the device interface and the host. Value is in milliseconds.

jitter_millis: float | None = <PLACEHOLDER>

jitter_millis is the amount of jitter experienced by requests between the device interface and host. Value is in milliseconds.

key: ProbeStatsKey = <PLACEHOLDER>

key uniquely identifies the connectivity monitor probe.

latency_millis: float | None = <PLACEHOLDER>

latency_millis is the latency between the device interface and the host. Value is in milliseconds.

packet_loss_percent: int | None = <PLACEHOLDER>

packet_loss_percent is the amount of packet loss experienced by requests between the device interface and host. Value is a percentage.

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

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

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

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

• start and end: Returns the state of each ProbeStats at start, followed by updates until end. * Each ProbeStats 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.connectivitymonitor.v1.ProbeStatsBatchedStreamResponse(responses: List[ForwardRef('ProbeStatsStreamResponse')] = <PLACEHOLDER>)

Bases: Message

responses: List[ProbeStatsStreamResponse] = <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.connectivitymonitor.v1.ProbeStatsKey(device_id: str | None = <PLACEHOLDER>, host: str | None = <PLACEHOLDER>, vrf: str | None = <PLACEHOLDER>, source_intf: str | None = <PLACEHOLDER>)

Bases: Message

ProbeStatsKey uniquely identifies a connectivity monitor probe’s statistics, per source interface.

device_id: str | None = <PLACEHOLDER>

device_id is the id of the device in the probe.

host: str | None = <PLACEHOLDER>

host is the hostname used in the probe.

source_intf: str | None = <PLACEHOLDER>

source_intf is the name of the interface in the probe.

vrf: str | None = <PLACEHOLDER>

vrf is the name of the VRF in the probe.

class cloudvision.api.arista.connectivitymonitor.v1.ProbeStatsRequest(key: 'ProbeStatsKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

key: ProbeStatsKey = <PLACEHOLDER>

Key uniquely identifies a ProbeStats 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.connectivitymonitor.v1.ProbeStatsResponse(value: 'ProbeStats' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

value: ProbeStats = <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.connectivitymonitor.v1.ProbeStatsServiceBase

Bases: ServiceBase

async get_all(probe_stats_stream_request: ProbeStatsStreamRequest) → AsyncIterator[ProbeStatsStreamResponse]

async get_all_batched(probe_stats_batched_stream_request: ProbeStatsBatchedStreamRequest) → AsyncIterator[ProbeStatsBatchedStreamResponse]

async get_meta(probe_stats_stream_request: ProbeStatsStreamRequest) → MetaResponse

async get_one(probe_stats_request: ProbeStatsRequest) → ProbeStatsResponse

async get_some(probe_stats_some_request: ProbeStatsSomeRequest) → AsyncIterator[ProbeStatsSomeResponse]

async subscribe(probe_stats_stream_request: ProbeStatsStreamRequest) → AsyncIterator[ProbeStatsStreamResponse]

async subscribe_batched(probe_stats_batched_stream_request: ProbeStatsBatchedStreamRequest) → AsyncIterator[ProbeStatsBatchedStreamResponse]

async subscribe_meta(probe_stats_stream_request: ProbeStatsStreamRequest) → AsyncIterator[MetaResponse]

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

Bases: ServiceStub

async get_all(probe_stats_stream_request: ProbeStatsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStatsStreamResponse]

async get_all_batched(probe_stats_batched_stream_request: ProbeStatsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStatsBatchedStreamResponse]

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

async get_one(probe_stats_request: ProbeStatsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ProbeStatsResponse

async get_some(probe_stats_some_request: ProbeStatsSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStatsSomeResponse]

async subscribe(probe_stats_stream_request: ProbeStatsStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStatsStreamResponse]

async subscribe_batched(probe_stats_batched_stream_request: ProbeStatsBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ProbeStatsBatchedStreamResponse]

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

class cloudvision.api.arista.connectivitymonitor.v1.ProbeStatsSomeRequest(keys: List[ForwardRef('ProbeStatsKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

keys: List[ProbeStatsKey] = <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.connectivitymonitor.v1.ProbeStatsSomeResponse(value: 'ProbeStats' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)

Bases: Message

error: str | None = <PLACEHOLDER>

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

time: datetime = <PLACEHOLDER>

value: ProbeStats = <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.connectivitymonitor.v1.ProbeStatsStreamRequest(partial_eq_filter: List[ForwardRef('ProbeStats')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

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

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

• start and end: Returns the state of each ProbeStats at start, followed by updates until end. * Each ProbeStats 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.connectivitymonitor.v1.ProbeStatsStreamResponse(value: 'ProbeStats' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the ProbeStats 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: ProbeStats = <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.connectivitymonitor.v1.ProbeStreamRequest(partial_eq_filter: List[ForwardRef('Probe')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)

Bases: Message

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

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

• start and end: Returns the state of each Probe at start, followed by updates until end. * Each Probe 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.connectivitymonitor.v1.ProbeStreamResponse(value: 'Probe' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the Probe 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: Probe = <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.