event.v1

Top

arista/event.v1/event.proto

Event

Event is a telemetry event

Field NameTypeDescription
keyEventKey

key is the event instance identifier

severityEventSeverity

severity is the severity of the event

titlegoogle.protobuf.StringValue

title is the title of the event

descriptiongoogle.protobuf.StringValue

description is the description of the event

event_typegoogle.protobuf.StringValue

event_type is the type of the event

dataEventData

data is the data of the event

componentsEventComponents

components is the components on which the event occurred

ackEventAck

ack is the acknowledgement status of the event

notesEventNotes

notes is the notes of the event

last_updated_timegoogle.protobuf.Timestamp

last_updated_time is the time of the most recent update to the event

EventAck

EventAck contains acknowledgement information of an event

Field NameTypeDescription
ackgoogle.protobuf.BoolValue

ack is the acknowledgement state of an event

ackergoogle.protobuf.StringValue

acker is the user that acknowledged the event

ack_timegoogle.protobuf.Timestamp

ack_time is the time of acknowledgement

EventAnnotationConfig

EventAnnotationConfig configures an event annotation

Field NameTypeDescription
keyEventKey

key is the event instance identifier

ackgoogle.protobuf.BoolValue

ack is the acknowledgement state of an event

notesEventNotesConfig

notes is the notes on an event

EventComponent

EventComponent describes an entity on which the event occured

Field NameTypeDescription
typeComponentType

type is the type of component

componentsEventComponent.ComponentsEntry[…]

components identifies the entity on which the event occured

EventComponent.ComponentsEntry

Field NameTypeDescription
keystring

valuestring

EventComponents

EventComponents contains entities on which an event occured

Field NameTypeDescription
componentsEventComponent[…]

components describes the components on which an event occured

EventData

EventData is additional event data

Field NameTypeDescription
dataEventData.DataEntry[…]

data is event data specific to the type of this event

EventData.DataEntry

Field NameTypeDescription
keystring

valuestring

EventKey

EventKey uniquely identifies an event

Field NameTypeDescription
keygoogle.protobuf.StringValue

key is the event data identifier

timestampgoogle.protobuf.Timestamp

timestamp is the time the event occured

EventNote

Eventnote is the state of a note

Field NameTypeDescription
notegoogle.protobuf.StringValue

note is the text of the note

note_creatorgoogle.protobuf.StringValue

note_creator is the creator of the note

EventNoteConfig

EventNoteConfig configures a note

Field NameTypeDescription
notegoogle.protobuf.StringValue

note is the text of the note

EventNotes

EventNotes is the notes of an event state

Field NameTypeDescription
notesEventNotes.NotesEntry[…]

notes is keyed by the time desired

EventNotes.NotesEntry

Field NameTypeDescription
keyint64

valueEventNote

EventNotesConfig

EventNotesConfig configures the notes of an event

Field NameTypeDescription
notesEventNotesConfig.NotesEntry[…]

notes is keyed by desired note time in Unix time, in milliseconds

EventNotesConfig.NotesEntry

Field NameTypeDescription
keyint64

valueEventNoteConfig

ComponentType

ComponentType describes the type of entity on which the event occured

NameNumberDescription
COMPONENT_TYPE_UNSPECIFIED0

COMPONENT_TYPE_DEVICE1

COMPONENT_TYPE_INTERFACE2

COMPONENT_TYPE_TURBINE3

EventSeverity

EventSeverity is the severity level of the event

NameNumberDescription
EVENT_SEVERITY_UNSPECIFIED0

EVENT_SEVERITY_INFO1

EVENT_SEVERITY_WARNING2

EVENT_SEVERITY_ERROR3

EVENT_SEVERITY_CRITICAL4

Top

arista/event.v1/services.gen.proto

EventAnnotationConfigDeleteRequest

Field NameTypeDescription
keyEventKey

Key indicates which EventAnnotationConfig instance to remove.

This field (and all keys, unless otherwise specified) must always be set.

EventAnnotationConfigDeleteResponse

Field NameTypeDescription
keyEventKey

Key echoes back the key of the deleted EventAnnotationConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

EventAnnotationConfigRequest

Field NameTypeDescription
keyEventKey

Key uniquely identifies a EventAnnotationConfig instance to retrieve.

This value (and all fields, unless otherwise specified) 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 twhich it makes the request.

EventAnnotationConfigResponse

Field NameTypeDescription
valueEventAnnotationConfig

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

EventAnnotationConfig instance in this response.

EventAnnotationConfigSetRequest

Field NameTypeDescription
valueEventAnnotationConfig

EventAnnotationConfig carries the value to set into the datastore.

See the documentation on the EventAnnotationConfig struct for which fields are required.

EventAnnotationConfigSetResponse

Field NameTypeDescription
valueEventAnnotationConfig

Value carries all the values given in the EventAnnotationConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

EventAnnotationConfigStreamRequest

Field NameTypeDescription
partial_eq_filterEventAnnotationConfig[…]

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.

This field is not allowed in the Subscribe RPC.

EventAnnotationConfigStreamResponse

Field NameTypeDescription
valueEventAnnotationConfig

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 EventAnnotationConfig’s last modification.

typearista.subscriptions.Operation

Operation indicates how the EventAnnotationConfig 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.

EventRequest

Field NameTypeDescription
keyEventKey

Key uniquely identifies a Event instance to retrieve.

This value (and all fields, unless otherwise specified) 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 twhich it makes the request.

EventResponse

Field NameTypeDescription
valueEvent

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

Event instance in this response.

EventStreamRequest

Field NameTypeDescription
partial_eq_filterEvent[…]

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.

This field is not allowed in the Subscribe RPC.

EventStreamResponse

Field NameTypeDescription
valueEvent

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 Event’s last modification.

typearista.subscriptions.Operation

Operation indicates how the Event 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.

EventAnnotationConfigService

Method NameRequest TypeResponse TypeDescription
GetOneEventAnnotationConfigRequestEventAnnotationConfigResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.

SetEventAnnotationConfigSetRequestEventAnnotationConfigSetResponse

Set allows setting values for the entity specified by the key in the request.

The key must be provided and all fields set (unless otherwise specified).

DeleteEventAnnotationConfigDeleteRequestEventAnnotationConfigDeleteResponse

Delete will remove the entity specified by the key within the request.

The key must be provided and all fields populated (unless otherwise specified).

EventService

Method NameRequest TypeResponse TypeDescription
GetOneEventRequestEventResponse

GetOne returns a unary model as specified by the key in the request.

The key must be provided and all fields populated (unless otherwise specified).

GetAllEventStreamRequestEventStreamResponse stream

GetAll returns all entities for this model, with optional filtering.

SubscribeEventStreamRequestEventStreamResponse stream

Subscribe first returns all initial state known to the system,

then will send deltas as entities are changed.