bugexposure.v1
Available Services
arista/bugexposure.v1/bugexposure.proto
BugExposure
BugExposure is the state model that represents the exposure a device has to bugs
| Field Name | Type | Description |
|---|---|---|
| key | BugExposureKey | BugExposureKey is the key of BugExposure |
| bug_ids | fmp.RepeatedInt32 | bug_ids is a list of bug alerts affecting the device with type Bug |
| cve_ids | fmp.RepeatedInt32 | cve_ids is a list of bug alerts affecting the device with type CVE |
| bug_count | google.protobuf.Int32Value | bug_count is the number of bug alerts with type Bug |
| cve_count | google.protobuf.Int32Value | cve_count is the number of bug alerts with type CVE |
| highest_bug_exposure | HighestExposure | highest_bug_exposure is the highest exposure with type Bug |
| highest_cve_exposure | HighestExposure | highest_cve_exposure is the highest exposure with type CVE |
BugExposureKey
BugExposureKey is the key type for BugExposure model
| Field Name | Type | Description |
|---|---|---|
| device_id | google.protobuf.StringValue | device_id is the device ID |
| acknowledgement | Acknowledgement | 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
| Name | Number | Description |
|---|---|---|
| ACKNOWLEDGEMENT_UNSPECIFIED | 0 | Unacknowledged and acknowledged bugs will be computed |
| ACKNOWLEDGEMENT_UNACKNOWLEDGED | 1 | Only unacknowledged bugs will be computed |
| ACKNOWLEDGEMENT_ACKNOWLEDGED | 2 | Only acknowledged bugs will be computed |
HighestExposure
HighestExposure is an enumeration that defines the options for highest exposure
| Name | Number | Description |
|---|---|---|
| HIGHEST_EXPOSURE_UNSPECIFIED | 0 | If not given this will be the default value and it will compute devices with any highest exposure |
| HIGHEST_EXPOSURE_NONE | 1 | Not exposed to bugs |
| HIGHEST_EXPOSURE_LOW | 2 | Highest exposure is to a low priority bug |
| HIGHEST_EXPOSURE_HIGH | 3 | Highest exposure is to a high priority bug |
arista/bugexposure.v1/services.gen.proto
BugExposureRequest
| Field Name | Type | Description |
|---|---|---|
| key | BugExposureKey | Key uniquely identifies a BugExposure instance to retrieve. This value must be populated. |
| time | google.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 Name | Type | Description |
|---|---|---|
| value | BugExposure | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the BugExposure instance in this response. |
BugExposureStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | BugExposure[...] | 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 | arista.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 Name | Type | Description |
|---|---|---|
| value | BugExposure | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this BugExposure's last modification. |
| type | arista.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 Name | Type | Description |
|---|---|---|
| time | google.protobuf.Timestamp | Time holds the timestamp of the last item included in the metadata calculation. |
| type | arista.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. |
| count | google.protobuf.UInt32Value | Count is the number of items present under the conditions of the request. |
BugExposureService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | BugExposureRequest | BugExposureResponse | |
| GetAll | BugExposureStreamRequest | BugExposureStreamResponse stream | |
| Subscribe | BugExposureStreamRequest | BugExposureStreamResponse stream | |
| GetMeta | BugExposureStreamRequest | MetaResponse | |
| SubscribeMeta | BugExposureStreamRequest | MetaResponse stream |