advisor

package
v5.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2026 License: BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advisor

type Advisor struct {
	// contains filtered or unexported fields
}

Advisor service

func New

func New(clt client.Client) *Advisor

func (*Advisor) DeleteReport

func (srv *Advisor) DeleteReport(ReportId string) (*interface{}, error)

DeleteReport delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.

func (*Advisor) GetInsight

func (srv *Advisor) GetInsight(ReportId string, InsightId string) (*models.Insight, error)

GetInsight get an insight by its unique ID, scoped to its parent report.

func (*Advisor) GetReport

func (srv *Advisor) GetReport(ReportId string) (*models.Report, error)

GetReport get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.

func (*Advisor) ListInsights

func (srv *Advisor) ListInsights(ReportId string, optionalSetters ...ListInsightsOption) (*models.InsightList, error)

ListInsights list the insights produced under a single analyzer report. You can use the query params to filter your results further.

func (*Advisor) ListReports

func (srv *Advisor) ListReports(optionalSetters ...ListReportsOption) (*models.ReportList, error)

ListReports get a list of all the project's analyzer reports. You can use the query params to filter your results.

func (*Advisor) WithListInsightsQueries

func (srv *Advisor) WithListInsightsQueries(v []string) ListInsightsOption

func (*Advisor) WithListInsightsTotal

func (srv *Advisor) WithListInsightsTotal(v bool) ListInsightsOption

func (*Advisor) WithListReportsQueries

func (srv *Advisor) WithListReportsQueries(v []string) ListReportsOption

func (*Advisor) WithListReportsTotal

func (srv *Advisor) WithListReportsTotal(v bool) ListReportsOption

type ListInsightsOption

type ListInsightsOption func(*ListInsightsOptions)

type ListInsightsOptions

type ListInsightsOptions struct {
	Queries []string
	Total   bool
	// contains filtered or unexported fields
}

func (ListInsightsOptions) New

type ListReportsOption

type ListReportsOption func(*ListReportsOptions)

type ListReportsOptions

type ListReportsOptions struct {
	Queries []string
	Total   bool
	// contains filtered or unexported fields
}

func (ListReportsOptions) New

func (options ListReportsOptions) New() *ListReportsOptions

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL