Documentation
¶
Overview ¶
Code generated by apigen; DO NOT EDIT. package logtypesapi documents github.com/panther-labs/panther/internal/core/logtypesapi.LogTypesAPI
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DelCustomLogInput ¶ added in v1.15.0
type DelCustomLogResponse ¶ added in v1.15.0
type GetCustomLogInput ¶ added in v1.15.0
type GetCustomLogResponse ¶ added in v1.15.0
type GetCustomLogResponse struct {
Result struct {
LogType string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
Revision int64 `json:"revision" validate:"required,min=1" description:"Log record revision"`
UpdatedAt time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
Description string `json:"description" description:"Log type description"`
ReferenceURL string `json:"referenceURL" description:"A URL with reference docs for the log type"`
LogSpec string `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
} `json:"record,omitempty" description:"The custom log record (field omitted if an error occurred)"`
Error struct {
Code string `json:"code" validate:"required"`
Message string `json:"message" validate:"required"`
} `json:"error,omitempty" description:"An error that occurred while fetching the record"`
}
type ListAvailableLogTypesResponse ¶
type ListAvailableLogTypesResponse struct {
LogTypes []string `json:"logTypes"`
}
type ListCustomLogsResponse ¶ added in v1.15.0
type ListCustomLogsResponse struct {
CustomLogs []struct {
LogType string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
Revision int64 `json:"revision" validate:"required,min=1" description:"Log record revision"`
UpdatedAt time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
Description string `json:"description" description:"Log type description"`
ReferenceURL string `json:"referenceURL" description:"A URL with reference docs for the log type"`
LogSpec string `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
} `json:"customLogs" description:"Custom log records stored"`
Error struct {
Code string `json:"code" validate:"required"`
Message string `json:"message" validate:"required"`
} `json:"error,omitempty" description:"An error that occurred during the operation"`
}
type ListDeletedCustomLogsResponse ¶ added in v1.15.0
type ListDeletedCustomLogsResponse struct {
LogTypes []string `json:"logTypes,omitempty" description:"A list of ids of deleted log types (omitted if an error occurred)"`
Error struct {
Code string `json:"code" validate:"required"`
Message string `json:"message" validate:"required"`
} `json:"error,omitempty" description:"An error that occurred while fetching the list"`
}
type LogTypesAPI ¶
type LogTypesAPI interface {
ListAvailableLogTypes() (ListAvailableLogTypesResponse, error)
ListDeletedCustomLogs() (ListDeletedCustomLogsResponse, error)
GetCustomLog(input GetCustomLogInput) (GetCustomLogResponse, error)
PutCustomLog(input PutCustomLogInput) (PutCustomLogResponse, error)
DelCustomLog(input DelCustomLogInput) (DelCustomLogResponse, error)
ListCustomLogs() (ListCustomLogsResponse, error)
}
LogTypesAPI available endpoints
type LogTypesAPIPayload ¶
type LogTypesAPIPayload struct {
ListAvailableLogTypes *struct{}
ListDeletedCustomLogs *struct{}
GetCustomLog *GetCustomLogInput
PutCustomLog *PutCustomLogInput
DelCustomLog *DelCustomLogInput
ListCustomLogs *struct{}
}
LogTypesAPIPayload is the payload for calls to LogTypesAPI endpoints.
type PutCustomLogInput ¶ added in v1.15.0
type PutCustomLogInput struct {
LogType string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
Revision int64 `` /* 145-byte string literal not displayed */
Description string `json:"description" description:"Log type description"`
ReferenceURL string `json:"referenceURL" description:"A URL with reference docs for the log type"`
LogSpec string `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
}
type PutCustomLogResponse ¶ added in v1.15.0
type PutCustomLogResponse struct {
Result struct {
LogType string `json:"logType" validate:"required,startswith=Custom." description:"The log type id"`
Revision int64 `json:"revision" validate:"required,min=1" description:"Log record revision"`
UpdatedAt time.Time `json:"updatedAt" description:"Last update timestamp of the record"`
Description string `json:"description" description:"Log type description"`
ReferenceURL string `json:"referenceURL" description:"A URL with reference docs for the log type"`
LogSpec string `json:"logSpec" validate:"required" description:"The log spec in YAML or JSON format"`
} `json:"record,omitempty" description:"The modified record (field is omitted if an error occurred)"`
Error struct {
Code string `json:"code" validate:"required"`
Message string `json:"message" validate:"required"`
} `json:"error,omitempty" description:"An error that occurred during the operation"`
}
Click to show internal directories.
Click to hide internal directories.