client

Documentation

Index

• Variables
• type Integration
  • func NewIntegration(host, apiKey string, checkAutoCreate bool) (*Integration, error)
  • func (d *Integration) Validate(_ context.Context) error
• type SBOMUploader
  • func NewSBOMUploader(host, apiKey string, sbom io.Reader, projectID, projectName string) (*SBOMUploader, error)
  • func (d *SBOMUploader) Do(_ context.Context) error
  • func (d *SBOMUploader) Validate(ctx context.Context) error

Variables

var ErrValidation = errors.New("validation error")

Types

type Integration

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

func NewIntegration

func NewIntegration(host, apiKey string, checkAutoCreate bool) (*Integration, error)

The integration definition

func (*Integration) Validate

func (d *Integration) Validate(_ context.Context) error

type SBOMUploader

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

func NewSBOMUploader

func NewSBOMUploader(host, apiKey string, sbom io.Reader, projectID, projectName string) (*SBOMUploader, error)

func (*SBOMUploader) Do

func (d *SBOMUploader) Do(_ context.Context) error

func (*SBOMUploader) Validate

func (d *SBOMUploader) Validate(ctx context.Context) error

Validate before uploading an sbom This method will take into account validations from two different life-cycles - Validation used to make sure that the dependency track instance is correctly setup - That the provided parameters, i.e project_id is valid, meaning it exists in the instance