bugexposure.v1

Top

arista/bugexposure.v1/bugexposure.proto

BugExposure

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

Field NameTypeDescription
keyBugExposureKey

BugExposureKey is the key of

BugExposure

bug_idsfmp.RepeatedInt32

bug_ids is a list of bug alerts affecting the device

with type Bug

cve_idsfmp.RepeatedInt32

cve_ids is a list of bug alerts affecting the device

with type CVE

bug_countgoogle.protobuf.Int32Value

bug_count is the number of bug alerts

with type Bug

cve_countgoogle.protobuf.Int32Value

cve_count is the number of bug alerts

with type CVE

highest_bug_exposureHighestExposure

highest_bug_exposure is the highest exposure

with type Bug

highest_cve_exposureHighestExposure

highest_cve_exposure is the highest exposure

with type CVE

BugExposureKey

BugExposureKey is the key type for BugExposure model

Field NameTypeDescription
device_idgoogle.protobuf.StringValue

device_id is the device ID

acknowledgementAcknowledgement

acknowledgement is one of the options for

Acknowledgement enum

Acknowledgement

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

NameNumberDescription
ACKNOWLEDGEMENT_UNSPECIFIED0

Unacknowledged and acknowledged bugs will be computed

ACKNOWLEDGEMENT_UNACKNOWLEDGED1

Only unacknowledged bugs will be computed

ACKNOWLEDGEMENT_ACKNOWLEDGED2

Only acknowledged bugs will be computed

HighestExposure

HighestExposure is an enumeration that defines the options for highest exposure

NameNumberDescription
HIGHEST_EXPOSURE_UNSPECIFIED0

If not given this will be the default value

and it will compute devices with

any highest exposure

HIGHEST_EXPOSURE_NONE1

Not exposed to bugs

HIGHEST_EXPOSURE_LOW2

Highest exposure is to a low priority bug

HIGHEST_EXPOSURE_HIGH3

Highest exposure is to a high priority bug

Top

arista/bugexposure.v1/services.gen.proto

BugExposureRequest

Field NameTypeDescription
keyBugExposureKey

Key uniquely identifies a BugExposure instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

BugExposureResponse

Field NameTypeDescription
valueBugExposure

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

BugExposure instance in this response.

BugExposureStreamRequest

Field NameTypeDescription
partial_eq_filterBugExposure[…]

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.

timearista.time.TimeBounds

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.

BugExposureStreamResponse

Field NameTypeDescription
valueBugExposure

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.

timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

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.

MetaResponse

Field NameTypeDescription
timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

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.

countgoogle.protobuf.UInt32Value

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

BugExposureService

Method NameRequest TypeResponse TypeDescription
GetOneBugExposureRequestBugExposureResponse

GetAllBugExposureStreamRequestBugExposureStreamResponse stream

SubscribeBugExposureStreamRequestBugExposureStreamResponse stream

GetMetaBugExposureStreamRequestMetaResponse

SubscribeMetaBugExposureStreamRequestMetaResponse stream