Documentation
¶
Index ¶
Constants ¶
View Source
const TypeEvent = "Box.Event"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Event ¶
type Event struct {
AdditionalDetails *jsoniter.RawMessage `json:"additional_details,omitempty" description:"This object provides additional information about the event if available."`
CreatedAt *timestamp.RFC3339 `json:"created_at,omitempty" description:"The timestamp of the event"`
CreatedBy *UserMini `json:"created_by,omitempty" description:"The user that performed the action represented by the event."`
EventID string `json:"event_id" validate:"required" description:"The ID of the event object. You can use this to detect duplicate events"`
EventType string `json:"event_type" validate:"required" description:"The event type that triggered this event"`
Type string `json:"type" validate:"required,eq=event" description:"The object type (always 'event')"`
Source EventSourceOrUser `json:"source" validate:"required" description:"The item that triggered this event"`
SessionID null.String `json:"session_id,omitempty" description:"The event type that triggered this event"`
IPAddress null.String `json:"ip_address,omitempty" description:"The IP address the request was made from."`
parsers.PantherLog
}
nolint:lll
type EventParser ¶
type EventParser struct{}
func NewEventParser ¶
func NewEventParser() *EventParser
func (*EventParser) LogType ¶
func (p *EventParser) LogType() string
func (*EventParser) New ¶
func (p *EventParser) New() parsers.LogParser
func (*EventParser) Parse ¶
func (p *EventParser) Parse(log string) ([]*parsers.PantherLog, error)
type EventSource ¶
type EventSource struct {
ItemID string `json:"item_id,omitempty" description:"The unique identifier that represents the item."`
ItemName string `json:"item_name,omitempty" description:"The name of the item."`
ItemType string `json:"item_type,omitempty" description:"The type of the item that the event represents. Can be file or folder."`
OwnedBy *UserMini `json:"owned_by,omitempty" description:"The user who owns this item."`
Parent *FolderMini `json:"parent,omitempty" description:"The optional folder that this folder is located within."`
}
nolint:lll The fields are declared 'omitempty' on purpose so we can use them in the EventSourceOrUser enum
type EventSourceOrUser ¶
type EventSourceOrUser struct {
UserMini
EventSource
}
type FolderMini ¶
type FolderMini struct {
Etag string `json:"etag" description:"The HTTP etag of this folder."`
ID string `json:"id" description:"The unique identifier that represent a folder."`
Type string `json:"type" validate:"required,eq=folder" description:"The type of the object (always 'folder')"`
Name string `json:"name" description:"The name of the folder"`
SequenceID string `` /* 142-byte string literal not displayed */
}
nolint:lll
type UserMini ¶
type UserMini struct {
ID string `json:"id,omitempty" description:"The unique identifier for this object"`
Type string `json:"type,omitempty" validate:"omitempty,eq=user" description:"The object type (always 'user')"`
Login string `json:"login,omitempty" description:"The primary email address of this user"`
Name string `json:"name,omitempty" description:"The display name of this user" `
}
nolint:lll The fields are declared 'omitempty' on purpose so we can use them in the EventSourceOrUser enum
Click to show internal directories.
Click to hide internal directories.