Documentation ¶
Index ¶
- Variables
- func ByOrganization(meta schema.ClientMeta) []schema.ClientMeta
- func MockTestHelper(t *testing.T, table *schema.Table, ...)
- func New(ctx context.Context, logger zerolog.Logger, spec Spec) (schema.ClientMeta, error)
- func ResolveOrganizationID(_ context.Context, meta schema.ClientMeta, r *schema.Resource, c schema.Column) error
- func SingleOrganization(meta schema.ClientMeta) []schema.ClientMeta
- func Transform(tables schema.Tables) schema.Tables
- type Client
- type SnykLogger
- type SnykReportingIssuesOptions
- type Spec
- type TableOptions
Constants ¶
This section is empty.
Variables ¶
View Source
var OrganizationID = schema.Column{ Name: "organization_id", Type: arrow.BinaryTypes.String, PrimaryKey: true, NotNull: true, Resolver: ResolveOrganizationID, }
Functions ¶
func ByOrganization ¶
func ByOrganization(meta schema.ClientMeta) []schema.ClientMeta
func MockTestHelper ¶
func ResolveOrganizationID ¶
func SingleOrganization ¶
func SingleOrganization(meta schema.ClientMeta) []schema.ClientMeta
Types ¶
type Client ¶
type Client struct { *snyk.Client Spec Spec OrganizationID string Organizations []snyk.Organization // contains filtered or unexported fields }
func (*Client) RetryOnError ¶
RetryOnError will run the given resolver function and retry on rate limit exceeded errors or other retryable errors (like internal server errors) after waiting some amount of time.
func (*Client) WantOrganization ¶
func (*Client) WithOrganization ¶
func (c *Client) WithOrganization(organizationID string) schema.ClientMeta
type SnykLogger ¶
type SnykLogger struct {
// contains filtered or unexported fields
}
func (*SnykLogger) Log ¶
func (l *SnykLogger) Log(args ...any)
type SnykReportingIssuesOptions ¶
type SnykReportingIssuesOptions struct { From string `json:"from"` // e.g. 2020-01-01 To string `json:"to"` // e.g. 2020-01-01 Period string `json:"period"` // e.g. 1d, 365d }
SnykReportingIssuesOptions accepts these combinations: - `from` + `to` - `from` (default `to` is now) - `period` (relative to now) Other combinations should fail validation.
func (SnykReportingIssuesOptions) FromTime ¶
func (s SnykReportingIssuesOptions) FromTime() time.Time
func (SnykReportingIssuesOptions) ToTime ¶
func (s SnykReportingIssuesOptions) ToTime() time.Time
type Spec ¶
type Spec struct { // APIKey required to access Snyk API APIKey string `json:"api_key,omitempty"` // Organizations is a list of organizations to fetch information from. // By default, will fetch from all organizations available for user. Organizations []string `json:"organizations,omitempty"` // EndpointURL is an optional parameter to override the API URL for snyk.Client. // It defaults to https://api.snyk.io/api/ EndpointURL string `json:"endpoint_url,omitempty"` // Retries is an optional parameter to override the default number of retries for retryable requests. Retries int `json:"retries,omitempty"` // RetryDelaySeconds is an optional parameter to override the default backoff time for retryable requests. RetryDelaySeconds int `json:"retry_delay_seconds,omitempty"` TableOptions TableOptions `json:"table_options,omitempty"` Concurrency int `json:"concurrency,omitempty"` }
func (*Spec) SetDefaults ¶
func (s *Spec) SetDefaults()
type TableOptions ¶
type TableOptions struct {
SnykReportingIssues SnykReportingIssuesOptions `json:"snyk_reporting_issues"`
}
func (TableOptions) Validate ¶
func (t TableOptions) Validate() error
Click to show internal directories.
Click to hide internal directories.