cloudvision.api.arista.bugexposure.v1 package

Module contents

class cloudvision.api.arista.bugexposure.v1.Acknowledgement(value: int)[source]

Bases: Enum

Acknowledgement is an enumeration key for a BugExposure model that defines the acknowledgement state for the computed bugs

ACKNOWLEDGED = Acknowledgement.ACKNOWLEDGED

Only acknowledged bugs will be computed

UNACKNOWLEDGED = Acknowledgement.UNACKNOWLEDGED

Only unacknowledged bugs will be computed

UNSPECIFIED = Acknowledgement.UNSPECIFIED

Unacknowledged and acknowledged bugs will be computed

name: str | None
value: int
class cloudvision.api.arista.bugexposure.v1.BugExposure(key: ~cloudvision.api.arista.bugexposure.v1.BugExposureKey = <PLACEHOLDER>, bug_ids: ~cloudvision.api.fmp.RepeatedInt32 = <PLACEHOLDER>, cve_ids: ~cloudvision.api.fmp.RepeatedInt32 = <PLACEHOLDER>, bug_count: int | None = <PLACEHOLDER>, cve_count: int | None = <PLACEHOLDER>, highest_bug_exposure: ~cloudvision.api.arista.bugexposure.v1.HighestExposure = <PLACEHOLDER>, highest_cve_exposure: ~cloudvision.api.arista.bugexposure.v1.HighestExposure = <PLACEHOLDER>)[source]

Bases: Message

BugExposure is the state model that represents the exposure a device has to bugs

bug_count: int | None = <PLACEHOLDER>

bug_count is the number of bug alerts with type Bug

bug_ids: ___fmp__.RepeatedInt32 = <PLACEHOLDER>

bug_ids is a list of bug alerts affecting the device with type Bug

cve_count: int | None = <PLACEHOLDER>

cve_count is the number of bug alerts with type CVE

cve_ids: ___fmp__.RepeatedInt32 = <PLACEHOLDER>

cve_ids is a list of bug alerts affecting the device with type CVE

highest_bug_exposure: HighestExposure = <PLACEHOLDER>

highest_bug_exposure is the highest exposure with type Bug

highest_cve_exposure: HighestExposure = <PLACEHOLDER>

highest_cve_exposure is the highest exposure with type CVE

key: BugExposureKey = <PLACEHOLDER>

BugExposureKey is the key of BugExposure

class cloudvision.api.arista.bugexposure.v1.BugExposureKey(device_id: str | None = <PLACEHOLDER>, acknowledgement: ~cloudvision.api.arista.bugexposure.v1.Acknowledgement = <PLACEHOLDER>)[source]

Bases: Message

BugExposureKey is the key type for BugExposure model

acknowledgement: Acknowledgement = <PLACEHOLDER>

acknowledgement is one of the options for Acknowledgement enum

device_id: str | None = <PLACEHOLDER>

device_id is the device ID

class cloudvision.api.arista.bugexposure.v1.BugExposureRequest(key: 'BugExposureKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: BugExposureKey = <PLACEHOLDER>

Key uniquely identifies a BugExposure 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.bugexposure.v1.BugExposureResponse(value: 'BugExposure' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

value: BugExposure = <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.bugexposure.v1.BugExposureServiceBase[source]

Bases: ServiceBase

async get_all(bug_exposure_stream_request: BugExposureStreamRequest) → AsyncIterator[BugExposureStreamResponse][source]
async get_meta(bug_exposure_stream_request: BugExposureStreamRequest) → MetaResponse[source]
async get_one(bug_exposure_request: BugExposureRequest) → BugExposureResponse[source]
async subscribe(bug_exposure_stream_request: BugExposureStreamRequest) → AsyncIterator[BugExposureStreamResponse][source]
async subscribe_meta(bug_exposure_stream_request: BugExposureStreamRequest) → AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.bugexposure.v1.BugExposureServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(bug_exposure_stream_request: BugExposureStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[BugExposureStreamResponse][source]
async get_meta(bug_exposure_stream_request: BugExposureStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]
async get_one(bug_exposure_request: BugExposureRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → BugExposureResponse[source]
async subscribe(bug_exposure_stream_request: BugExposureStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[BugExposureStreamResponse][source]
async subscribe_meta(bug_exposure_stream_request: BugExposureStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.bugexposure.v1.BugExposureStreamRequest(partial_eq_filter: List[ForwardRef('BugExposure')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

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

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

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

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the BugExposure 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: BugExposure = <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.bugexposure.v1.HighestExposure(value: int)[source]

Bases: Enum

HighestExposure is an enumeration that defines the options for highest exposure

HIGH = HighestExposure.HIGH

Highest exposure is to a high priority bug

LOW = HighestExposure.LOW

Highest exposure is to a low priority bug

NONE = HighestExposure.NONE

Not exposed to bugs

UNSPECIFIED = HighestExposure.UNSPECIFIED

If not given this will be the default value and it will compute devices with any highest exposure

name: str | None
value: int
class cloudvision.api.arista.bugexposure.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.