hubclient

package

Go to main page

Versions in this module

v0

v0.9.11

Jan 26, 2023

Changes in this version

+ type ArrayChunkIterator struct

+ func NewArrayChunkIterator(chunks []string) ArrayChunkIterator

+ func (i *ArrayChunkIterator) HasNext() bool

+ func (i *ArrayChunkIterator) Next() (string, error)

+ type ChunkIterator interface

+ HasNext func() bool

+ Next func() (string, error)

type Client

+ func (c *Client) UploadBdioFilesByChunk(bdioUploadEndpoint string, chunkCount int, iterator ChunkIterator) error

v0.9.10

Jan 12, 2022

v0.9.9

Jan 11, 2022

Changes in this version

type Client

+ func (c *Client) SetBearerToken(token string)

v0.9.8

Jan 11, 2022

Changes in this version

+ const HeaderNameUserAgent

type Client

+ func (c *Client) CheckHubLiveness() (error, *hubapi.HealthCheckStatus)

+ func (c *Client) CheckHubReadiness() (error, *hubapi.HealthCheckStatus)

+ func (c *Client) FetchResults(rapidScanEndpoint string, offset int, pageLimit int) (err error, httpStatus int, result *hubapi.RapidScanResult)

+ func (c *Client) GetAuthTokenExpiryTime() int64

+ func (c *Client) GetUpgradeGuidanceForComponent(componentVariant hubapi.ComponentVariant) (*hubapi.ComponentUpgradeGuidance, error)

+ func (c *Client) GetUpgradeGuidanceForComponentVersion(componentVersion *hubapi.ComponentVersion) (*hubapi.ComponentUpgradeGuidance, error)

+ func (c *Client) HttpPostFile(url string, filePath string, contentType string) (string, int, error)

+ func (c *Client) HttpPutStringWithHeader(url string, data string, contentType string, expectedStatusCode int, ...) error

+ func (c *Client) SetUserAgent(agent string)

v0.9.7

Sep 28, 2021

Changes in this version

+ func HubClientStatusCodeErrorf(statusCode int, format string, args ...interface{}) error

type Client

+ func (c *Client) AddHeaderValue(key string, value string)

+ func (c *Client) DeleteHeaderValue(key string)

+ func (c *Client) DetectURI() (*hubapi.DetectURI, error)

+ func (c *Client) HttpGetString(url string, result *string, expectedStatusCode []int, mimetypes ...string) (error, int)

+ func (c *Client) HttpPostString(url string, data string, contentType string, expectedStatusCode int) (string, error)

+ func (c *Client) HttpPutString(url string, data string, contentType string, expectedStatusCode int) error

+ func (c *Client) PollRapidScanResults(rapidScanEndpoint string, interval, timeout time.Duration, pageLimit int) (error, *hubapi.RapidScanResult)

+ func (c *Client) SetHeaderValue(key string, value string)

+ func (c *Client) SsoStatus() (*hubapi.SsoStatus, error)

+ func (c *Client) StartRapidScan(bdioHeaderContent string) (error, string)

+ func (c *Client) UploadBdioFiles(bdioUploadEndpoint string, bdioContents []string) error

type HubClientError

+ func (e HubClientError) Cause() error

v0.9.6

Feb 10, 2020

v0.9.5

Dec 10, 2019

Changes in this version

+ func AnnotateHubClientError(old error, format string) error

+ func AnnotateHubClientErrorf(old error, format string, args ...interface{}) error

+ func HubClientErrorf(format string, args ...interface{}) error

+ func TraceHubClientError(old error) error

+ type BearerTokenResponse struct

+ BearerToken string

+ ExpiresInMilliseconds int64

type Client

+ func NewWithApiToken(baseURL string, apiToken string, debugFlags HubClientDebug, ...) (*Client, error)

+ func NewWithApiTokenAndClient(baseURL string, apiToken string, debugFlags HubClientDebug, ...) (*Client, error)

+ func NewWithClient(baseURL string, debugFlags HubClientDebug, httpClient *http.Client) (*Client, error)

+ func NewWithTokenAndClient(baseURL string, authToken string, debugFlags HubClientDebug, ...) (*Client, error)

+ func (c *Client) Count(link string) (int, error)

+ func (c *Client) CreateApiToken(name, description string, readOnly bool) (location string, token string, err error)

+ func (c *Client) CreateComponent(componentRequest *hubapi.ComponentRequest) (string, error)

+ func (c *Client) CreatePolicyRule(policyRuleRequest *hubapi.PolicyRuleRequest) (string, error)

+ func (c *Client) DeleteApiToken(tokenUrl string) error

+ func (c *Client) DeleteComponent(componentURL string) error

+ func (c *Client) DeletePolicyRule(policyRuleURL string) error

+ func (c *Client) ForEachPage(link string, listOptions *hubapi.GetListOptions, list interface{}, ...) (err error)

+ func (c *Client) GetComponent(link hubapi.ResourceLink) (*hubapi.Component, error)

+ func (c *Client) GetComponentVersion(link hubapi.ResourceLink) (*hubapi.ComponentVersion, error)

+ func (c *Client) GetComponentVersionRemediation(componentVersionHref string) (*hubapi.ComponentRemediation, error)

+ func (c *Client) GetCurrentUser() (response *hubapi.CurrentUserResponse, err error)

+ func (c *Client) GetPage(link string, options *hubapi.GetListOptions, list interface{}) error

+ func (c *Client) GetPolicyRule(link hubapi.ResourceLink) (*hubapi.PolicyRule, error)

+ func (c *Client) GetUser(link hubapi.ResourceLink) (*hubapi.User, error)

+ func (c *Client) GetVulnerability(link hubapi.ResourceLink) (*hubapi.Vulnerability, error)

+ func (c *Client) ListAllCodeLocations(options *hubapi.GetListOptions) (*hubapi.CodeLocationList, error)

+ func (c *Client) ListAllComponents(options *hubapi.GetListOptions) (*hubapi.ComponentList, error)

+ func (c *Client) ListApiTokens(options *hubapi.GetListOptions) (*hubapi.ApiTokenList, error)

+ func (c *Client) ListComponents(options *hubapi.GetListOptions) (*hubapi.ComponentList, error)

+ func (c *Client) ListPolicyRules(options *hubapi.GetListOptions) (*hubapi.PolicyRuleList, error)

+ func (c *Client) SetTimeout(timeout time.Duration)

+ type HubClientError struct

+ Err error

+ HubError HubResponseError

+ StatusCode int

+ func (e HubClientError) Error() string

+ type HubResponseError struct

+ Arguments HubResponseErrorArgument

+ ErrorCode string

+ ErrorMessage string

+ Errors []HubResponseError

+ type HubResponseErrorArgument struct

+ FieldName string

+ InvalidValue string

+ Message string

+ Type string

v0.9.4

May 11, 2018

Changes in this version

type Client

+ func (c *Client) BaseURL() string

v0.9.3

May 8, 2018

Changes in this version

+ func BaseURL(c *Client) string

type Client

+ func (c *Client) AssignUserToProject(link hubapi.ResourceLink, userAssignmentRequest *hubapi.UserAssignmentRequest) (string, error)

+ func (c *Client) CreateUser(userRequest *hubapi.UserRequest) (*hubapi.User, error)

+ func (c *Client) HttpDelete(url string, contentType string, expectedStatusCode int) error

+ func (c *Client) HttpGetJSON(url string, result interface{}, expectedStatusCode int) error

+ func (c *Client) HttpPostJSON(url string, data interface{}, contentType string, expectedStatusCode int) (string, error)

+ func (c *Client) HttpPostJSONExpectResult(url string, data interface{}, result interface{}, contentType string, ...) (string, error)

+ func (c *Client) HttpPutJSON(url string, data interface{}, contentType string, expectedStatusCode int) error

+ func (c *Client) ListUsers(options *hubapi.GetListOptions) (*hubapi.UserList, error)

v0.9.2

Apr 10, 2018

Changes in this version

type Client

+ func (c *Client) DeleteCodeLocation(codeLocationURL string) error

+ func (c *Client) DeleteProjectVersion(projectVersionURL string) error

v0.9.1

Mar 13, 2018

Changes in this version

type Client

+ func (c *Client) CurrentVersion() (*hubapi.CurrentVersion, error)

+ func (c *Client) DownloadScanClientLinux(path string) error

+ func (c *Client) DownloadScanClientMac(path string) error

+ func (c *Client) DownloadScanClientWindows(path string) error

v0.9.0

Feb 9, 2018

Changes in this version

+ const HeaderNameAccept

+ const HeaderNameAuthorization

+ const HeaderNameContentType

+ const HeaderNameCsrfToken

+ type Client struct

+ func NewWithSession(baseURL string, debugFlags HubClientDebug) (*Client, error)

+ func NewWithToken(baseURL string, authToken string, debugFlags HubClientDebug) (*Client, error)

+ func (c *Client) CountProjectVersionVulnerableComponents(link hubapi.ResourceLink) (uint32, error)

+ func (c *Client) CreateProject(projectRequest *hubapi.ProjectRequest) (string, error)

+ func (c *Client) CreateProjectVersion(link hubapi.ResourceLink, projectVersionRequest *hubapi.ProjectVersionRequest) (string, error)

+ func (c *Client) DeleteProject(projectURL string) error

+ func (c *Client) GetCodeLocation(link hubapi.ResourceLink) (*hubapi.CodeLocation, error)

+ func (c *Client) GetExternalExtension(link hubapi.ResourceLink) (*hubapi.ExternalExtension, error)

+ func (c *Client) GetProject(link hubapi.ResourceLink) (*hubapi.Project, error)

+ func (c *Client) GetProjectVersion(link hubapi.ResourceLink) (*hubapi.ProjectVersion, error)

+ func (c *Client) GetProjectVersionPolicyStatus(link hubapi.ResourceLink) (*hubapi.ProjectVersionPolicyStatus, error)

+ func (c *Client) GetProjectVersionRiskProfile(link hubapi.ResourceLink) (*hubapi.ProjectVersionRiskProfile, error)

+ func (c *Client) GetScanSummary(link hubapi.ResourceLink) (*hubapi.ScanSummary, error)

+ func (c *Client) ListAllProjectVersionVulnerableComponents(link hubapi.ResourceLink) ([]hubapi.BomVulnerableComponent, error)

+ func (c *Client) ListCodeLocations(link hubapi.ResourceLink) (*hubapi.CodeLocationList, error)

+ func (c *Client) ListProjectVersionComponents(link hubapi.ResourceLink) (*hubapi.BomComponentList, error)

+ func (c *Client) ListProjectVersionVulnerableComponents(link hubapi.ResourceLink) (*hubapi.BomVulnerableComponentList, error)

+ func (c *Client) ListProjectVersions(link hubapi.ResourceLink, options *hubapi.GetListOptions) (*hubapi.ProjectVersionList, error)

+ func (c *Client) ListProjects(options *hubapi.GetListOptions) (*hubapi.ProjectList, error)

+ func (c *Client) ListScanSummaries(link hubapi.ResourceLink) (*hubapi.ScanSummaryList, error)

+ func (c *Client) Login(username string, password string) error

+ func (c *Client) PageProjectVersionVulnerableComponents(link hubapi.ResourceLink, offset uint32, limit uint32) (*hubapi.BomVulnerableComponentList, error)

+ func (c *Client) UpdateExternalExtension(extension *hubapi.ExternalExtension) error

+ type HubClientDebug uint16

+ const HubClientDebugContent

+ const HubClientDebugTimings

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