Documentation
¶
Index ¶
- type XscService
- type XscServicesManager
- func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)
- func (sm *XscServicesManager) Client() *jfroghttpclient.JfrogHttpClient
- func (sm *XscServicesManager) Config() config.Config
- func (sm *XscServicesManager) GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error)
- func (sm *XscServicesManager) GetConfigProfile(profileName string) (*services.ConfigProfile, error)
- func (sm *XscServicesManager) GetVersion() (string, error)
- func (sm *XscServicesManager) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error
- func (sm *XscServicesManager) UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type XscService ¶ added in v1.48.1
type XscService interface {
// GetVersion will return the Xsc version
GetVersion() (string, error)
// AddAnalyticsGeneralEvent will send an analytics metrics general event to Xsc and return MSI (multi scan id) generated by Xsc.
AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)
// SendXscLogErrorRequest will send an error log to Xsc
SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error
// UpdateAnalyticsGeneralEvent upon completion of the scan and we have all the results to report on,
// we send a finalized analytics metrics event with information matching an existing event's msi.
UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error
// GetAnalyticsGeneralEvent returns general event that match the msi provided.
GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error)
// GetConfigProfile returns the configuration profile that match the profile name provided.
GetConfigProfile(profileName string) (*services.ConfigProfile, error)
}
XscService defines the API to interact with XSC
type XscServicesManager ¶
type XscServicesManager struct {
// contains filtered or unexported fields
}
XscServicesManager defines the http client and general configuration Deprecated from Xray version 3.107.13, XSC is transitioning to Xray as inner service.
func New ¶
func New(config config.Config) (*XscServicesManager, error)
New creates a service manager to interact with Xsc
func (*XscServicesManager) AddAnalyticsGeneralEvent ¶
func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)
AddAnalyticsGeneralEvent will send an analytics metrics general event to Xsc and return MSI (multi scan id) generated by Xsc.
func (*XscServicesManager) Client ¶
func (sm *XscServicesManager) Client() *jfroghttpclient.JfrogHttpClient
Client will return the http client
func (*XscServicesManager) Config ¶
func (sm *XscServicesManager) Config() config.Config
func (*XscServicesManager) GetAnalyticsGeneralEvent ¶
func (sm *XscServicesManager) GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error)
GetAnalyticsGeneralEvent returns general event that match the msi provided.
func (*XscServicesManager) GetConfigProfile ¶ added in v1.45.0
func (sm *XscServicesManager) GetConfigProfile(profileName string) (*services.ConfigProfile, error)
func (*XscServicesManager) GetVersion ¶
func (sm *XscServicesManager) GetVersion() (string, error)
GetVersion will return the Xsc version
func (*XscServicesManager) SendXscLogErrorRequest ¶
func (sm *XscServicesManager) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error
func (*XscServicesManager) UpdateAnalyticsGeneralEvent ¶
func (sm *XscServicesManager) UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error
UpdateAnalyticsGeneralEvent upon completion of the scan and we have all the results to report on, we send a finalized analytics metrics event with information matching an existing event's msi.