Documentation
¶
Overview ¶
Package ar_v3 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- func NewAddBuildInfoRequest(server string, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody) (*http.Request, error)
- func NewAddBuildInfoRequestWithBody(server string, params *AddBuildInfoParams, contentType string, body io.Reader) (*http.Request, error)
- func NewBulkDeleteArtifactsRequest(server string, params *BulkDeleteArtifactsParams, ...) (*http.Request, error)
- func NewBulkDeleteArtifactsRequestWithBody(server string, params *BulkDeleteArtifactsParams, contentType string, ...) (*http.Request, error)
- func NewEvaluateArtifactScanRequest(server string, params *EvaluateArtifactScanParams, ...) (*http.Request, error)
- func NewEvaluateArtifactScanRequestWithBody(server string, params *EvaluateArtifactScanParams, contentType string, ...) (*http.Request, error)
- func NewGetArtifactScanDetailsRequest(server string, scanId ScanIDParam, params *GetArtifactScanDetailsParams) (*http.Request, error)
- func NewGetArtifactScansRequest(server string, params *GetArtifactScansParams) (*http.Request, error)
- func NewGetBulkScanEvaluationStatusRequest(server string, evaluationId EvaluationIdParam, ...) (*http.Request, error)
- func NewGetSystemInfoRequest(server string, params *GetSystemInfoParams) (*http.Request, error)
- func NewInitiateBulkScanEvaluationRequest(server string, params *InitiateBulkScanEvaluationParams, ...) (*http.Request, error)
- func NewInitiateBulkScanEvaluationRequestWithBody(server string, params *InitiateBulkScanEvaluationParams, contentType string, ...) (*http.Request, error)
- func NewListFilesV3Request(server string, params *ListFilesV3Params) (*http.Request, error)
- func NewListPackagesV3Request(server string, params *ListPackagesV3Params) (*http.Request, error)
- func NewListRegistriesV3Request(server string, params *ListRegistriesV3Params) (*http.Request, error)
- func NewListVersionsV3Request(server string, params *ListVersionsV3Params) (*http.Request, error)
- type AccountIdentifier
- type AddBuildInfoJSONRequestBody
- type AddBuildInfoParams
- type AddBuildInfoResp
- type ApiErrors
- type ApiErrorsType
- type ArtifactScan
- type ArtifactScanDetails
- type ArtifactScanDetailsResponse
- type ArtifactScanDetailsScanStatus
- type ArtifactScanEvaluateRequest
- type ArtifactScanEvaluateRequestAccepted
- type ArtifactScanEvaluateRequestStatus
- type ArtifactScanInput
- type ArtifactScanScanStatus
- type BuildInfoNode
- type BuildInfoRequest
- type BuildInfoRequestInput
- type BuildInfoRequestInputStatus
- type BulkDeleteArtifactsJSONRequestBody
- type BulkDeleteArtifactsParams
- type BulkDeleteArtifactsResp
- type BulkDeleteRequest
- type BulkScanEvaluationAccepted
- type BulkScanEvaluationAcceptedData
- type BulkScanEvaluationRequest
- type BulkScanEvaluationStatusData
- type BulkScanEvaluationStatusDataStatus
- type BulkScanEvaluationStatusResponse
- type BulkScanResultItem
- type BulkScanResultItemScanStatus
- type Client
- func (c *Client) AddBuildInfo(ctx context.Context, params *AddBuildInfoParams, ...) (*http.Response, error)
- func (c *Client) AddBuildInfoWithBody(ctx context.Context, params *AddBuildInfoParams, contentType string, ...) (*http.Response, error)
- func (c *Client) BulkDeleteArtifacts(ctx context.Context, params *BulkDeleteArtifactsParams, ...) (*http.Response, error)
- func (c *Client) BulkDeleteArtifactsWithBody(ctx context.Context, params *BulkDeleteArtifactsParams, contentType string, ...) (*http.Response, error)
- func (c *Client) EvaluateArtifactScan(ctx context.Context, params *EvaluateArtifactScanParams, ...) (*http.Response, error)
- func (c *Client) EvaluateArtifactScanWithBody(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, ...) (*http.Response, error)
- func (c *Client) GetArtifactScanDetails(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, ...) (*http.Response, error)
- func (c *Client) GetArtifactScans(ctx context.Context, params *GetArtifactScansParams, ...) (*http.Response, error)
- func (c *Client) GetBulkScanEvaluationStatus(ctx context.Context, evaluationId EvaluationIdParam, ...) (*http.Response, error)
- func (c *Client) GetSystemInfo(ctx context.Context, params *GetSystemInfoParams, ...) (*http.Response, error)
- func (c *Client) InitiateBulkScanEvaluation(ctx context.Context, params *InitiateBulkScanEvaluationParams, ...) (*http.Response, error)
- func (c *Client) InitiateBulkScanEvaluationWithBody(ctx context.Context, params *InitiateBulkScanEvaluationParams, ...) (*http.Response, error)
- func (c *Client) ListFilesV3(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListPackagesV3(ctx context.Context, params *ListPackagesV3Params, ...) (*http.Response, error)
- func (c *Client) ListRegistriesV3(ctx context.Context, params *ListRegistriesV3Params, ...) (*http.Response, error)
- func (c *Client) ListVersionsV3(ctx context.Context, params *ListVersionsV3Params, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) AddBuildInfoWithBodyWithResponse(ctx context.Context, params *AddBuildInfoParams, contentType string, ...) (*AddBuildInfoResp, error)
- func (c *ClientWithResponses) AddBuildInfoWithResponse(ctx context.Context, params *AddBuildInfoParams, ...) (*AddBuildInfoResp, error)
- func (c *ClientWithResponses) BulkDeleteArtifactsWithBodyWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, contentType string, ...) (*BulkDeleteArtifactsResp, error)
- func (c *ClientWithResponses) BulkDeleteArtifactsWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, ...) (*BulkDeleteArtifactsResp, error)
- func (c *ClientWithResponses) EvaluateArtifactScanWithBodyWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, ...) (*EvaluateArtifactScanResp, error)
- func (c *ClientWithResponses) EvaluateArtifactScanWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, ...) (*EvaluateArtifactScanResp, error)
- func (c *ClientWithResponses) GetArtifactScanDetailsWithResponse(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, ...) (*GetArtifactScanDetailsResp, error)
- func (c *ClientWithResponses) GetArtifactScansWithResponse(ctx context.Context, params *GetArtifactScansParams, ...) (*GetArtifactScansResp, error)
- func (c *ClientWithResponses) GetBulkScanEvaluationStatusWithResponse(ctx context.Context, evaluationId EvaluationIdParam, ...) (*GetBulkScanEvaluationStatusResp, error)
- func (c *ClientWithResponses) GetSystemInfoWithResponse(ctx context.Context, params *GetSystemInfoParams, ...) (*GetSystemInfoResp, error)
- func (c *ClientWithResponses) InitiateBulkScanEvaluationWithBodyWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, ...) (*InitiateBulkScanEvaluationResp, error)
- func (c *ClientWithResponses) InitiateBulkScanEvaluationWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, ...) (*InitiateBulkScanEvaluationResp, error)
- func (c *ClientWithResponses) ListFilesV3WithResponse(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*ListFilesV3Resp, error)
- func (c *ClientWithResponses) ListPackagesV3WithResponse(ctx context.Context, params *ListPackagesV3Params, ...) (*ListPackagesV3Resp, error)
- func (c *ClientWithResponses) ListRegistriesV3WithResponse(ctx context.Context, params *ListRegistriesV3Params, ...) (*ListRegistriesV3Resp, error)
- func (c *ClientWithResponses) ListVersionsV3WithResponse(ctx context.Context, params *ListVersionsV3Params, ...) (*ListVersionsV3Resp, error)
- type ClientWithResponsesInterface
- type ConanPackageRevisionOptionalParam
- type ConanRecipeRevisionOptionalParam
- type DeleteFilterParam
- type DeletedAtMs
- type EvaluateArtifactScanJSONRequestBody
- type EvaluateArtifactScanParams
- type EvaluateArtifactScanResp
- type EvaluationIdParam
- type FileMetadata
- type FixVersionDetails
- type GetArtifactScanDetailsParams
- type GetArtifactScanDetailsResp
- type GetArtifactScansParams
- type GetArtifactScansParamsScope
- type GetArtifactScansParamsSortOrder
- type GetArtifactScansResp
- type GetBulkScanEvaluationStatusParams
- type GetBulkScanEvaluationStatusResp
- type GetSystemInfoParams
- type GetSystemInfoResp
- type HttpRequestDoer
- type IncludeMetaParam
- type InitiateBulkScanEvaluationJSONRequestBody
- type InitiateBulkScanEvaluationParams
- type InitiateBulkScanEvaluationResp
- type LastModifiedAtMs
- type LicensePolicyFailureDetailConfig
- type ListArtifactScanResponse
- type ListFilesResponse
- type ListFilesV3Params
- type ListFilesV3Resp
- type ListPackageResponse
- type ListPackagesV3Params
- type ListPackagesV3ParamsDeleted
- type ListPackagesV3Resp
- type ListRegistriesV3Params
- type ListRegistriesV3ParamsDeleted
- type ListRegistriesV3ParamsScope
- type ListRegistriesV3ParamsType
- type ListRegistriesV3Resp
- type ListRegistryResponse
- type ListVersionResponse
- type ListVersionsV3Params
- type ListVersionsV3ParamsDeleted
- type ListVersionsV3Resp
- type Meta
- type MetadataFilterListParam
- type OrgIdentifier
- type Package
- type PackageAgeViolationPolicyFailureDetailConfig
- type PackageIdOptionalParam
- type PackageIdsListParam
- type PackageKind
- type PackageKindQueryParam
- type PackageType
- type PackageTypeListParam
- type PackageTypesListParam
- type PageInfo
- type PageNumber
- type PageSize
- type PipelineContext
- type PolicyFailureDetail
- func (t PolicyFailureDetail) AsLicensePolicyFailureDetailConfig() (LicensePolicyFailureDetailConfig, error)
- func (t PolicyFailureDetail) AsPackageAgeViolationPolicyFailureDetailConfig() (PackageAgeViolationPolicyFailureDetailConfig, error)
- func (t PolicyFailureDetail) AsSecurityPolicyFailureDetailConfig() (SecurityPolicyFailureDetailConfig, error)
- func (t PolicyFailureDetail) Discriminator() (string, error)
- func (t *PolicyFailureDetail) FromLicensePolicyFailureDetailConfig(v LicensePolicyFailureDetailConfig) error
- func (t *PolicyFailureDetail) FromPackageAgeViolationPolicyFailureDetailConfig(v PackageAgeViolationPolicyFailureDetailConfig) error
- func (t *PolicyFailureDetail) FromSecurityPolicyFailureDetailConfig(v SecurityPolicyFailureDetailConfig) error
- func (t PolicyFailureDetail) MarshalJSON() ([]byte, error)
- func (t *PolicyFailureDetail) MergeLicensePolicyFailureDetailConfig(v LicensePolicyFailureDetailConfig) error
- func (t *PolicyFailureDetail) MergePackageAgeViolationPolicyFailureDetailConfig(v PackageAgeViolationPolicyFailureDetailConfig) error
- func (t *PolicyFailureDetail) MergeSecurityPolicyFailureDetailConfig(v SecurityPolicyFailureDetailConfig) error
- func (t *PolicyFailureDetail) UnmarshalJSON(b []byte) error
- func (t PolicyFailureDetail) ValueByDiscriminator() (interface{}, error)
- type PolicyFailureDetailCategory
- type PolicySetFailureDetail
- type PolicySetRefParam
- type PolicySets
- type ProjectIdentifier
- type Registry
- type RegistryIdListParam
- type RegistryIdOptionalParam
- type RegistryIdsListParam
- type RegistryScope
- type RegistryType
- type RegistryTypeParam
- type RequestEditorFn
- type RootPackage
- type ScanIDParam
- type ScanIDQueryParam
- type ScanMeta
- type ScanStatusParam
- type SearchTerm
- type SecurityPolicyFailureDetailConfig
- type SecurityPolicyFailureVulnerability
- type SortField
- type SortOrder
- type SortParam
- type UploadedByParam
- type UserInfo
- type V3Error
- type Version
- type VersionFirewallMode
- type VersionIdOptionalParam
- type VersionScanStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAddBuildInfoRequest ¶ added in v1.3.18
func NewAddBuildInfoRequest(server string, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody) (*http.Request, error)
NewAddBuildInfoRequest calls the generic AddBuildInfo builder with application/json body
func NewAddBuildInfoRequestWithBody ¶ added in v1.3.18
func NewAddBuildInfoRequestWithBody(server string, params *AddBuildInfoParams, contentType string, body io.Reader) (*http.Request, error)
NewAddBuildInfoRequestWithBody generates requests for AddBuildInfo with any type of body
func NewBulkDeleteArtifactsRequest ¶ added in v1.3.18
func NewBulkDeleteArtifactsRequest(server string, params *BulkDeleteArtifactsParams, body BulkDeleteArtifactsJSONRequestBody) (*http.Request, error)
NewBulkDeleteArtifactsRequest calls the generic BulkDeleteArtifacts builder with application/json body
func NewBulkDeleteArtifactsRequestWithBody ¶ added in v1.3.18
func NewBulkDeleteArtifactsRequestWithBody(server string, params *BulkDeleteArtifactsParams, contentType string, body io.Reader) (*http.Request, error)
NewBulkDeleteArtifactsRequestWithBody generates requests for BulkDeleteArtifacts with any type of body
func NewEvaluateArtifactScanRequest ¶
func NewEvaluateArtifactScanRequest(server string, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody) (*http.Request, error)
NewEvaluateArtifactScanRequest calls the generic EvaluateArtifactScan builder with application/json body
func NewEvaluateArtifactScanRequestWithBody ¶
func NewEvaluateArtifactScanRequestWithBody(server string, params *EvaluateArtifactScanParams, contentType string, body io.Reader) (*http.Request, error)
NewEvaluateArtifactScanRequestWithBody generates requests for EvaluateArtifactScan with any type of body
func NewGetArtifactScanDetailsRequest ¶
func NewGetArtifactScanDetailsRequest(server string, scanId ScanIDParam, params *GetArtifactScanDetailsParams) (*http.Request, error)
NewGetArtifactScanDetailsRequest generates requests for GetArtifactScanDetails
func NewGetArtifactScansRequest ¶
func NewGetArtifactScansRequest(server string, params *GetArtifactScansParams) (*http.Request, error)
NewGetArtifactScansRequest generates requests for GetArtifactScans
func NewGetBulkScanEvaluationStatusRequest ¶
func NewGetBulkScanEvaluationStatusRequest(server string, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams) (*http.Request, error)
NewGetBulkScanEvaluationStatusRequest generates requests for GetBulkScanEvaluationStatus
func NewGetSystemInfoRequest ¶ added in v1.3.15
func NewGetSystemInfoRequest(server string, params *GetSystemInfoParams) (*http.Request, error)
NewGetSystemInfoRequest generates requests for GetSystemInfo
func NewInitiateBulkScanEvaluationRequest ¶
func NewInitiateBulkScanEvaluationRequest(server string, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody) (*http.Request, error)
NewInitiateBulkScanEvaluationRequest calls the generic InitiateBulkScanEvaluation builder with application/json body
func NewInitiateBulkScanEvaluationRequestWithBody ¶
func NewInitiateBulkScanEvaluationRequestWithBody(server string, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader) (*http.Request, error)
NewInitiateBulkScanEvaluationRequestWithBody generates requests for InitiateBulkScanEvaluation with any type of body
func NewListFilesV3Request ¶ added in v1.3.31
func NewListFilesV3Request(server string, params *ListFilesV3Params) (*http.Request, error)
NewListFilesV3Request generates requests for ListFilesV3
func NewListPackagesV3Request ¶ added in v1.3.31
func NewListPackagesV3Request(server string, params *ListPackagesV3Params) (*http.Request, error)
NewListPackagesV3Request generates requests for ListPackagesV3
func NewListRegistriesV3Request ¶ added in v1.3.31
func NewListRegistriesV3Request(server string, params *ListRegistriesV3Params) (*http.Request, error)
NewListRegistriesV3Request generates requests for ListRegistriesV3
func NewListVersionsV3Request ¶ added in v1.3.31
func NewListVersionsV3Request(server string, params *ListVersionsV3Params) (*http.Request, error)
NewListVersionsV3Request generates requests for ListVersionsV3
Types ¶
type AccountIdentifier ¶
type AccountIdentifier = string
AccountIdentifier defines model for AccountIdentifier.
type AddBuildInfoJSONRequestBody ¶ added in v1.3.18
type AddBuildInfoJSONRequestBody = BuildInfoRequestInput
AddBuildInfoJSONRequestBody defines body for AddBuildInfo for application/json ContentType.
type AddBuildInfoParams ¶ added in v1.3.18
type AddBuildInfoParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
}
AddBuildInfoParams defines parameters for AddBuildInfo.
type AddBuildInfoResp ¶ added in v1.3.18
func ParseAddBuildInfoResp ¶ added in v1.3.18
func ParseAddBuildInfoResp(rsp *http.Response) (*AddBuildInfoResp, error)
ParseAddBuildInfoResp parses an HTTP response from a AddBuildInfoWithResponse call
func (AddBuildInfoResp) Status ¶ added in v1.3.18
func (r AddBuildInfoResp) Status() string
Status returns HTTPResponse.Status
func (AddBuildInfoResp) StatusCode ¶ added in v1.3.18
func (r AddBuildInfoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ApiErrors ¶
type ApiErrors struct {
// Code For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
Code *string `json:"code,omitempty"`
// Message A human-readable message providing more details about the error. These messages can be shown to users.
Message *string `json:"message,omitempty"`
// Param If the error is parameter-specific, the parameter related to the error. For example, we can use this to display a message near the correct form field.
Param *string `json:"param,omitempty"`
// Type The type of error returned.
Type ApiErrorsType `json:"type"`
}
ApiErrors defines model for ApiErrors.
type ApiErrorsType ¶
type ApiErrorsType string
ApiErrorsType The type of error returned.
const ( APIERROR ApiErrorsType = "API_ERROR" AUTHENTICATIONERROR ApiErrorsType = "AUTHENTICATION_ERROR" INVALIDREQUESTERROR ApiErrorsType = "INVALID_REQUEST_ERROR" PERMISSIONERROR ApiErrorsType = "PERMISSION_ERROR" )
Defines values for ApiErrorsType.
type ArtifactScan ¶
type ArtifactScan struct {
Id string `json:"id"`
LastEvaluatedAt *string `json:"lastEvaluatedAt,omitempty"`
LastEvaluatedBy *string `json:"lastEvaluatedBy,omitempty"`
// PackageName Package name
PackageName string `json:"packageName"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
// PolicySets List of opa policy sets.
PolicySets PolicySets `json:"policySets"`
// RegistryId Registry name
RegistryId string `json:"registryId"`
// RegistryName Registry name
RegistryName string `json:"registryName"`
// ScanStatus Scan status
ScanStatus ArtifactScanScanStatus `json:"scanStatus"`
// Version Version
Version string `json:"version"`
// VersionId Version
VersionId *string `json:"versionId,omitempty"`
}
ArtifactScan defines model for ArtifactScan.
type ArtifactScanDetails ¶
type ArtifactScanDetails struct {
CreatedAt *string `json:"createdAt,omitempty"`
// FixVersionDetails Fix version Details
FixVersionDetails *FixVersionDetails `json:"fixVersionDetails,omitempty"`
// Id Unique identifier for this artifact scan details
Id openapi_types.UUID `json:"id"`
LastEvaluatedAt *string `json:"lastEvaluatedAt,omitempty"`
// PackageName Package name
PackageName string `json:"packageName"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
PolicySetFailureDetails *[]PolicySetFailureDetail `json:"policySetFailureDetails,omitempty"`
// RegistryId Registry ID
RegistryId *openapi_types.UUID `json:"registryId,omitempty"`
// RegistryName Registry name
RegistryName string `json:"registryName"`
// ScanStatus Scan status
ScanStatus ArtifactScanDetailsScanStatus `json:"scanStatus"`
// Version Version
Version string `json:"version"`
// VersionId Version
VersionId *openapi_types.UUID `json:"versionId,omitempty"`
}
ArtifactScanDetails Artifact scans details
type ArtifactScanDetailsResponse ¶
type ArtifactScanDetailsResponse struct {
// Data Artifact scans details
Data *ArtifactScanDetails `json:"data,omitempty"`
}
ArtifactScanDetailsResponse defines model for ArtifactScanDetailsResponse.
type ArtifactScanDetailsScanStatus ¶
type ArtifactScanDetailsScanStatus string
ArtifactScanDetailsScanStatus Scan status
const ( ArtifactScanDetailsScanStatusBLOCKED ArtifactScanDetailsScanStatus = "BLOCKED" ArtifactScanDetailsScanStatusWARN ArtifactScanDetailsScanStatus = "WARN" )
Defines values for ArtifactScanDetailsScanStatus.
type ArtifactScanEvaluateRequest ¶
type ArtifactScanEvaluateRequest struct {
// ScanId Scan identifier
ScanId *string `json:"scanId,omitempty"`
// VersionId Artifact version identifier
VersionId *string `json:"versionId,omitempty"`
}
ArtifactScanEvaluateRequest Input for re-evaluate artifact scan. Exactly one of scanId or versionId must be provided.
type ArtifactScanEvaluateRequestAccepted ¶
type ArtifactScanEvaluateRequestAccepted struct {
// Data Status of the Artifact Scan Evaluate Request
Data *ArtifactScanEvaluateRequestStatus `json:"data,omitempty"`
}
ArtifactScanEvaluateRequestAccepted defines model for ArtifactScanEvaluateRequestAccepted.
type ArtifactScanEvaluateRequestStatus ¶
type ArtifactScanEvaluateRequestStatus string
ArtifactScanEvaluateRequestStatus Status of the Artifact Scan Evaluate Request
const ( ArtifactScanEvaluateRequestStatusFAILED ArtifactScanEvaluateRequestStatus = "FAILED" ArtifactScanEvaluateRequestStatusPENDING ArtifactScanEvaluateRequestStatus = "PENDING" ArtifactScanEvaluateRequestStatusPROCESSING ArtifactScanEvaluateRequestStatus = "PROCESSING" ArtifactScanEvaluateRequestStatusSUCCESS ArtifactScanEvaluateRequestStatus = "SUCCESS" )
Defines values for ArtifactScanEvaluateRequestStatus.
type ArtifactScanInput ¶
type ArtifactScanInput struct {
// PackageName Name of the package
PackageName string `json:"packageName"`
// Version Version of the package
Version string `json:"version"`
}
ArtifactScanInput Artifact to be scanned
type ArtifactScanScanStatus ¶
type ArtifactScanScanStatus string
ArtifactScanScanStatus Scan status
const ( ArtifactScanScanStatusBLOCKED ArtifactScanScanStatus = "BLOCKED" ArtifactScanScanStatusWARN ArtifactScanScanStatus = "WARN" )
Defines values for ArtifactScanScanStatus.
type BuildInfoNode ¶ added in v1.3.18
type BuildInfoNode struct {
// NodeKey package@version
NodeKey string `json:"nodeKey"`
// ParentNodeKey Parent node key
ParentNodeKey *string `json:"parentNodeKey,omitempty"`
}
BuildInfoNode Node in the dependency graph
type BuildInfoRequest ¶ added in v1.3.18
type BuildInfoRequest = BuildInfoRequestInput
BuildInfoRequest Request to add build info
type BuildInfoRequestInput ¶ added in v1.3.18
type BuildInfoRequestInput struct {
// Metadata List of dependency graph nodes
Metadata []BuildInfoNode `json:"metadata"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
// PipelineContext Pipeline execution context
PipelineContext *PipelineContext `json:"pipelineContext,omitempty"`
// RegistryId UUID of the registry
RegistryId openapi_types.UUID `json:"registryId"`
// RootPackage Root package of the build
RootPackage RootPackage `json:"rootPackage"`
// Status Status of the install
Status BuildInfoRequestInputStatus `json:"status"`
}
BuildInfoRequestInput Request to add build info
type BuildInfoRequestInputStatus ¶ added in v1.3.18
type BuildInfoRequestInputStatus string
BuildInfoRequestInputStatus Status of the install
const ( BuildInfoRequestInputStatusFAILURE BuildInfoRequestInputStatus = "FAILURE" BuildInfoRequestInputStatusPENDING BuildInfoRequestInputStatus = "PENDING" BuildInfoRequestInputStatusPROCESSING BuildInfoRequestInputStatus = "PROCESSING" BuildInfoRequestInputStatusSUCCESS BuildInfoRequestInputStatus = "SUCCESS" )
Defines values for BuildInfoRequestInputStatus.
type BulkDeleteArtifactsJSONRequestBody ¶ added in v1.3.18
type BulkDeleteArtifactsJSONRequestBody = BulkDeleteRequest
BulkDeleteArtifactsJSONRequestBody defines body for BulkDeleteArtifacts for application/json ContentType.
type BulkDeleteArtifactsParams ¶ added in v1.3.18
type BulkDeleteArtifactsParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
}
BulkDeleteArtifactsParams defines parameters for BulkDeleteArtifacts.
type BulkDeleteArtifactsResp ¶ added in v1.3.18
type BulkDeleteArtifactsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
JSONDefault *V3Error
}
func ParseBulkDeleteArtifactsResp ¶ added in v1.3.18
func ParseBulkDeleteArtifactsResp(rsp *http.Response) (*BulkDeleteArtifactsResp, error)
ParseBulkDeleteArtifactsResp parses an HTTP response from a BulkDeleteArtifactsWithResponse call
func (BulkDeleteArtifactsResp) Status ¶ added in v1.3.18
func (r BulkDeleteArtifactsResp) Status() string
Status returns HTTPResponse.Status
func (BulkDeleteArtifactsResp) StatusCode ¶ added in v1.3.18
func (r BulkDeleteArtifactsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type BulkDeleteRequest ¶ added in v1.3.18
type BulkDeleteRequest struct {
// DryRun If true, only simulates deletion without actually deleting
DryRun *bool `json:"dryRun,omitempty"`
// Force Force delete even if artifact is in use
Force *bool `json:"force,omitempty"`
// Packages Package name pattern (supports wildcards)
Packages string `json:"packages"`
// Registry Registry name
Registry string `json:"registry"`
// Versions Version pattern (supports wildcards)
Versions string `json:"versions"`
}
BulkDeleteRequest Request to bulk delete artifacts
type BulkScanEvaluationAccepted ¶
type BulkScanEvaluationAccepted struct {
// Data Response data for bulk evaluation request
Data *BulkScanEvaluationAcceptedData `json:"data,omitempty"`
}
BulkScanEvaluationAccepted defines model for BulkScanEvaluationAccepted.
type BulkScanEvaluationAcceptedData ¶
type BulkScanEvaluationAcceptedData struct {
// EvaluationId Unique evaluation ID for tracking the bulk evaluation
EvaluationId *string `json:"evaluationId,omitempty"`
}
BulkScanEvaluationAcceptedData Response data for bulk evaluation request
type BulkScanEvaluationRequest ¶
type BulkScanEvaluationRequest struct {
// Artifacts List of artifacts to evaluate (max 50)
Artifacts []ArtifactScanInput `json:"artifacts"`
// RegistryId Registry identifier
RegistryId openapi_types.UUID `json:"registryId"`
}
BulkScanEvaluationRequest Request to initiate bulk evaluation
type BulkScanEvaluationStatusData ¶
type BulkScanEvaluationStatusData struct {
// Error Error message (only present when status is failure)
Error *string `json:"error"`
// EvaluationId The evaluation ID
EvaluationId *string `json:"evaluationId,omitempty"`
// Scans List of scan results (only present when status is success)
Scans *[]BulkScanResultItem `json:"scans"`
// Status Status of the evaluation
Status *BulkScanEvaluationStatusDataStatus `json:"status,omitempty"`
}
BulkScanEvaluationStatusData Response data for bulk evaluation status
type BulkScanEvaluationStatusDataStatus ¶
type BulkScanEvaluationStatusDataStatus string
BulkScanEvaluationStatusDataStatus Status of the evaluation
const ( FAILURE BulkScanEvaluationStatusDataStatus = "FAILURE" PENDING BulkScanEvaluationStatusDataStatus = "PENDING" PROCESSING BulkScanEvaluationStatusDataStatus = "PROCESSING" SUCCESS BulkScanEvaluationStatusDataStatus = "SUCCESS" )
Defines values for BulkScanEvaluationStatusDataStatus.
type BulkScanEvaluationStatusResponse ¶
type BulkScanEvaluationStatusResponse struct {
// Data Response data for bulk evaluation status
Data *BulkScanEvaluationStatusData `json:"data,omitempty"`
}
BulkScanEvaluationStatusResponse defines model for BulkScanEvaluationStatusResponse.
type BulkScanResultItem ¶
type BulkScanResultItem struct {
// PackageName Name of the package
PackageName *string `json:"packageName,omitempty"`
// ScanId Scan identifier
ScanId *openapi_types.UUID `json:"scanId,omitempty"`
// ScanStatus Scan status
ScanStatus *BulkScanResultItemScanStatus `json:"scanStatus,omitempty"`
// Version Version of the package
Version *string `json:"version,omitempty"`
}
BulkScanResultItem Individual scan result item
type BulkScanResultItemScanStatus ¶
type BulkScanResultItemScanStatus string
BulkScanResultItemScanStatus Scan status
const ( BulkScanResultItemScanStatusALLOWED BulkScanResultItemScanStatus = "ALLOWED" BulkScanResultItemScanStatusBLOCKED BulkScanResultItemScanStatus = "BLOCKED" BulkScanResultItemScanStatusUNKNOWN BulkScanResultItemScanStatus = "UNKNOWN" BulkScanResultItemScanStatusWARN BulkScanResultItemScanStatus = "WARN" )
Defines values for BulkScanResultItemScanStatus.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) AddBuildInfo ¶ added in v1.3.18
func (c *Client) AddBuildInfo(ctx context.Context, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) AddBuildInfoWithBody ¶ added in v1.3.18
func (*Client) BulkDeleteArtifacts ¶ added in v1.3.18
func (c *Client) BulkDeleteArtifacts(ctx context.Context, params *BulkDeleteArtifactsParams, body BulkDeleteArtifactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) BulkDeleteArtifactsWithBody ¶ added in v1.3.18
func (*Client) EvaluateArtifactScan ¶
func (c *Client) EvaluateArtifactScan(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) EvaluateArtifactScanWithBody ¶
func (*Client) GetArtifactScanDetails ¶
func (c *Client) GetArtifactScanDetails(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetArtifactScans ¶
func (c *Client) GetArtifactScans(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetBulkScanEvaluationStatus ¶
func (c *Client) GetBulkScanEvaluationStatus(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetSystemInfo ¶ added in v1.3.15
func (c *Client) GetSystemInfo(ctx context.Context, params *GetSystemInfoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) InitiateBulkScanEvaluation ¶
func (c *Client) InitiateBulkScanEvaluation(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) InitiateBulkScanEvaluationWithBody ¶
func (*Client) ListFilesV3 ¶ added in v1.3.31
func (c *Client) ListFilesV3(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListPackagesV3 ¶ added in v1.3.31
func (c *Client) ListPackagesV3(ctx context.Context, params *ListPackagesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListRegistriesV3 ¶ added in v1.3.31
func (c *Client) ListRegistriesV3(ctx context.Context, params *ListRegistriesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListVersionsV3 ¶ added in v1.3.31
func (c *Client) ListVersionsV3(ctx context.Context, params *ListVersionsV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// AddBuildInfoWithBody request with any body
AddBuildInfoWithBody(ctx context.Context, params *AddBuildInfoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
AddBuildInfo(ctx context.Context, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// BulkDeleteArtifactsWithBody request with any body
BulkDeleteArtifactsWithBody(ctx context.Context, params *BulkDeleteArtifactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
BulkDeleteArtifacts(ctx context.Context, params *BulkDeleteArtifactsParams, body BulkDeleteArtifactsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListFilesV3 request
ListFilesV3(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListPackagesV3 request
ListPackagesV3(ctx context.Context, params *ListPackagesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListRegistriesV3 request
ListRegistriesV3(ctx context.Context, params *ListRegistriesV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetArtifactScans request
GetArtifactScans(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// InitiateBulkScanEvaluationWithBody request with any body
InitiateBulkScanEvaluationWithBody(ctx context.Context, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
InitiateBulkScanEvaluation(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetBulkScanEvaluationStatus request
GetBulkScanEvaluationStatus(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// EvaluateArtifactScanWithBody request with any body
EvaluateArtifactScanWithBody(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
EvaluateArtifactScan(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetArtifactScanDetails request
GetArtifactScanDetails(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSystemInfo request
GetSystemInfo(ctx context.Context, params *GetSystemInfoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListVersionsV3 request
ListVersionsV3(ctx context.Context, params *ListVersionsV3Params, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) AddBuildInfoWithBodyWithResponse ¶ added in v1.3.18
func (c *ClientWithResponses) AddBuildInfoWithBodyWithResponse(ctx context.Context, params *AddBuildInfoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddBuildInfoResp, error)
AddBuildInfoWithBodyWithResponse request with arbitrary body returning *AddBuildInfoResp
func (*ClientWithResponses) AddBuildInfoWithResponse ¶ added in v1.3.18
func (c *ClientWithResponses) AddBuildInfoWithResponse(ctx context.Context, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*AddBuildInfoResp, error)
func (*ClientWithResponses) BulkDeleteArtifactsWithBodyWithResponse ¶ added in v1.3.18
func (c *ClientWithResponses) BulkDeleteArtifactsWithBodyWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkDeleteArtifactsResp, error)
BulkDeleteArtifactsWithBodyWithResponse request with arbitrary body returning *BulkDeleteArtifactsResp
func (*ClientWithResponses) BulkDeleteArtifactsWithResponse ¶ added in v1.3.18
func (c *ClientWithResponses) BulkDeleteArtifactsWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, body BulkDeleteArtifactsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkDeleteArtifactsResp, error)
func (*ClientWithResponses) EvaluateArtifactScanWithBodyWithResponse ¶
func (c *ClientWithResponses) EvaluateArtifactScanWithBodyWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)
EvaluateArtifactScanWithBodyWithResponse request with arbitrary body returning *EvaluateArtifactScanResp
func (*ClientWithResponses) EvaluateArtifactScanWithResponse ¶
func (c *ClientWithResponses) EvaluateArtifactScanWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)
func (*ClientWithResponses) GetArtifactScanDetailsWithResponse ¶
func (c *ClientWithResponses) GetArtifactScanDetailsWithResponse(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*GetArtifactScanDetailsResp, error)
GetArtifactScanDetailsWithResponse request returning *GetArtifactScanDetailsResp
func (*ClientWithResponses) GetArtifactScansWithResponse ¶
func (c *ClientWithResponses) GetArtifactScansWithResponse(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*GetArtifactScansResp, error)
GetArtifactScansWithResponse request returning *GetArtifactScansResp
func (*ClientWithResponses) GetBulkScanEvaluationStatusWithResponse ¶
func (c *ClientWithResponses) GetBulkScanEvaluationStatusWithResponse(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*GetBulkScanEvaluationStatusResp, error)
GetBulkScanEvaluationStatusWithResponse request returning *GetBulkScanEvaluationStatusResp
func (*ClientWithResponses) GetSystemInfoWithResponse ¶ added in v1.3.15
func (c *ClientWithResponses) GetSystemInfoWithResponse(ctx context.Context, params *GetSystemInfoParams, reqEditors ...RequestEditorFn) (*GetSystemInfoResp, error)
GetSystemInfoWithResponse request returning *GetSystemInfoResp
func (*ClientWithResponses) InitiateBulkScanEvaluationWithBodyWithResponse ¶
func (c *ClientWithResponses) InitiateBulkScanEvaluationWithBodyWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)
InitiateBulkScanEvaluationWithBodyWithResponse request with arbitrary body returning *InitiateBulkScanEvaluationResp
func (*ClientWithResponses) InitiateBulkScanEvaluationWithResponse ¶
func (c *ClientWithResponses) InitiateBulkScanEvaluationWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)
func (*ClientWithResponses) ListFilesV3WithResponse ¶ added in v1.3.31
func (c *ClientWithResponses) ListFilesV3WithResponse(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*ListFilesV3Resp, error)
ListFilesV3WithResponse request returning *ListFilesV3Resp
func (*ClientWithResponses) ListPackagesV3WithResponse ¶ added in v1.3.31
func (c *ClientWithResponses) ListPackagesV3WithResponse(ctx context.Context, params *ListPackagesV3Params, reqEditors ...RequestEditorFn) (*ListPackagesV3Resp, error)
ListPackagesV3WithResponse request returning *ListPackagesV3Resp
func (*ClientWithResponses) ListRegistriesV3WithResponse ¶ added in v1.3.31
func (c *ClientWithResponses) ListRegistriesV3WithResponse(ctx context.Context, params *ListRegistriesV3Params, reqEditors ...RequestEditorFn) (*ListRegistriesV3Resp, error)
ListRegistriesV3WithResponse request returning *ListRegistriesV3Resp
func (*ClientWithResponses) ListVersionsV3WithResponse ¶ added in v1.3.31
func (c *ClientWithResponses) ListVersionsV3WithResponse(ctx context.Context, params *ListVersionsV3Params, reqEditors ...RequestEditorFn) (*ListVersionsV3Resp, error)
ListVersionsV3WithResponse request returning *ListVersionsV3Resp
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// AddBuildInfoWithBodyWithResponse request with any body
AddBuildInfoWithBodyWithResponse(ctx context.Context, params *AddBuildInfoParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddBuildInfoResp, error)
AddBuildInfoWithResponse(ctx context.Context, params *AddBuildInfoParams, body AddBuildInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*AddBuildInfoResp, error)
// BulkDeleteArtifactsWithBodyWithResponse request with any body
BulkDeleteArtifactsWithBodyWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkDeleteArtifactsResp, error)
BulkDeleteArtifactsWithResponse(ctx context.Context, params *BulkDeleteArtifactsParams, body BulkDeleteArtifactsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkDeleteArtifactsResp, error)
// ListFilesV3WithResponse request
ListFilesV3WithResponse(ctx context.Context, params *ListFilesV3Params, reqEditors ...RequestEditorFn) (*ListFilesV3Resp, error)
// ListPackagesV3WithResponse request
ListPackagesV3WithResponse(ctx context.Context, params *ListPackagesV3Params, reqEditors ...RequestEditorFn) (*ListPackagesV3Resp, error)
// ListRegistriesV3WithResponse request
ListRegistriesV3WithResponse(ctx context.Context, params *ListRegistriesV3Params, reqEditors ...RequestEditorFn) (*ListRegistriesV3Resp, error)
// GetArtifactScansWithResponse request
GetArtifactScansWithResponse(ctx context.Context, params *GetArtifactScansParams, reqEditors ...RequestEditorFn) (*GetArtifactScansResp, error)
// InitiateBulkScanEvaluationWithBodyWithResponse request with any body
InitiateBulkScanEvaluationWithBodyWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)
InitiateBulkScanEvaluationWithResponse(ctx context.Context, params *InitiateBulkScanEvaluationParams, body InitiateBulkScanEvaluationJSONRequestBody, reqEditors ...RequestEditorFn) (*InitiateBulkScanEvaluationResp, error)
// GetBulkScanEvaluationStatusWithResponse request
GetBulkScanEvaluationStatusWithResponse(ctx context.Context, evaluationId EvaluationIdParam, params *GetBulkScanEvaluationStatusParams, reqEditors ...RequestEditorFn) (*GetBulkScanEvaluationStatusResp, error)
// EvaluateArtifactScanWithBodyWithResponse request with any body
EvaluateArtifactScanWithBodyWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)
EvaluateArtifactScanWithResponse(ctx context.Context, params *EvaluateArtifactScanParams, body EvaluateArtifactScanJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateArtifactScanResp, error)
// GetArtifactScanDetailsWithResponse request
GetArtifactScanDetailsWithResponse(ctx context.Context, scanId ScanIDParam, params *GetArtifactScanDetailsParams, reqEditors ...RequestEditorFn) (*GetArtifactScanDetailsResp, error)
// GetSystemInfoWithResponse request
GetSystemInfoWithResponse(ctx context.Context, params *GetSystemInfoParams, reqEditors ...RequestEditorFn) (*GetSystemInfoResp, error)
// ListVersionsV3WithResponse request
ListVersionsV3WithResponse(ctx context.Context, params *ListVersionsV3Params, reqEditors ...RequestEditorFn) (*ListVersionsV3Resp, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type ConanPackageRevisionOptionalParam ¶ added in v1.3.31
type ConanPackageRevisionOptionalParam = string
ConanPackageRevisionOptionalParam defines model for ConanPackageRevisionOptionalParam.
type ConanRecipeRevisionOptionalParam ¶ added in v1.3.31
type ConanRecipeRevisionOptionalParam = string
ConanRecipeRevisionOptionalParam defines model for ConanRecipeRevisionOptionalParam.
type DeleteFilterParam ¶ added in v1.3.31
type DeleteFilterParam string
DeleteFilterParam defines model for DeleteFilterParam.
const ( DeleteFilterParamExclude DeleteFilterParam = "exclude" DeleteFilterParamInclude DeleteFilterParam = "include" DeleteFilterParamOnly DeleteFilterParam = "only" )
Defines values for DeleteFilterParam.
type DeletedAtMs ¶ added in v1.3.31
type DeletedAtMs = int64
DeletedAtMs Unix timestamp in milliseconds when the resource was soft-deleted
type EvaluateArtifactScanJSONRequestBody ¶
type EvaluateArtifactScanJSONRequestBody = ArtifactScanEvaluateRequest
EvaluateArtifactScanJSONRequestBody defines body for EvaluateArtifactScan for application/json ContentType.
type EvaluateArtifactScanParams ¶
type EvaluateArtifactScanParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
}
EvaluateArtifactScanParams defines parameters for EvaluateArtifactScan.
type EvaluateArtifactScanResp ¶
type EvaluateArtifactScanResp struct {
Body []byte
HTTPResponse *http.Response
JSON202 *ArtifactScanEvaluateRequestAccepted
JSONDefault *V3Error
}
func ParseEvaluateArtifactScanResp ¶
func ParseEvaluateArtifactScanResp(rsp *http.Response) (*EvaluateArtifactScanResp, error)
ParseEvaluateArtifactScanResp parses an HTTP response from a EvaluateArtifactScanWithResponse call
func (EvaluateArtifactScanResp) Status ¶
func (r EvaluateArtifactScanResp) Status() string
Status returns HTTPResponse.Status
func (EvaluateArtifactScanResp) StatusCode ¶
func (r EvaluateArtifactScanResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EvaluationIdParam ¶
type EvaluationIdParam = string
EvaluationIdParam defines model for EvaluationIdParam.
type FileMetadata ¶ added in v1.3.31
type FileMetadata struct {
// CreatedAt Unix timestamp in milliseconds when the resource was last modified
CreatedAt *LastModifiedAtMs `json:"createdAt"`
// CreatedBy Structured user information for a principal
CreatedBy *UserInfo `json:"createdBy,omitempty"`
DownloadUrl *string `json:"downloadUrl,omitempty"`
Id string `json:"id"`
Md5 string `json:"md5"`
Name string `json:"name"`
Path string `json:"path"`
Sha1 string `json:"sha1"`
Sha256 string `json:"sha256"`
Sha512 string `json:"sha512"`
Size string `json:"size"`
}
FileMetadata File Metadata
type FixVersionDetails ¶
type FixVersionDetails struct {
// CurrentVersion The current version
CurrentVersion string `json:"currentVersion"`
// FixVersion The fix version
FixVersion *string `json:"fixVersion,omitempty"`
// FixVersionAvailable Fix version available or not
FixVersionAvailable bool `json:"fixVersionAvailable"`
}
FixVersionDetails Fix version Details
type GetArtifactScanDetailsParams ¶
type GetArtifactScanDetailsParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy
PolicySetRef *PolicySetRefParam `form:"policy_set_ref,omitempty" json:"policy_set_ref,omitempty"`
}
GetArtifactScanDetailsParams defines parameters for GetArtifactScanDetails.
type GetArtifactScanDetailsResp ¶
type GetArtifactScanDetailsResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ArtifactScanDetailsResponse
JSONDefault *V3Error
}
func ParseGetArtifactScanDetailsResp ¶
func ParseGetArtifactScanDetailsResp(rsp *http.Response) (*GetArtifactScanDetailsResp, error)
ParseGetArtifactScanDetailsResp parses an HTTP response from a GetArtifactScanDetailsWithResponse call
func (GetArtifactScanDetailsResp) Status ¶
func (r GetArtifactScanDetailsResp) Status() string
Status returns HTTPResponse.Status
func (GetArtifactScanDetailsResp) StatusCode ¶
func (r GetArtifactScanDetailsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetArtifactScansParams ¶
type GetArtifactScansParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
// PackageType Registry Package Type
PackageType *PackageTypeListParam `form:"package_type,omitempty" json:"package_type,omitempty"`
// RegistryId Unique id for the registry.
// Note: This parameter should have one id if package query param is provided
RegistryId *RegistryIdListParam `form:"registry_id,omitempty" json:"registry_id,omitempty"`
// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy
PolicySetRef *PolicySetRefParam `form:"policy_set_ref,omitempty" json:"policy_set_ref,omitempty"`
// ScanId Scan Identifier
ScanId *ScanIDQueryParam `form:"scan_id,omitempty" json:"scan_id,omitempty"`
// ScanStatus Scan status of the artifact after opa policy evaluation. Note: It can only be BLOCKED or WARN
ScanStatus *ScanStatusParam `form:"scan_status,omitempty" json:"scan_status,omitempty"`
// Page The page number for pagination (0-indexed).
//
// Used to navigate through large result sets. Combined with `size` parameter
// to control which subset of results to return.
//
// Example: `page=0` returns the first page, `page=1` returns the second page
Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`
// Size The number of items to return per page.
//
// Controls the page size for paginated results.
//
// Example: `size=50` returns up to 50 items per page
Size *PageSize `form:"size,omitempty" json:"size,omitempty"`
// SortOrder The sort order for the results.
//
// Determines whether results are sorted in ascending or descending order.
// Must be used in combination with `sort_field` parameter.
//
// Allowed values: `ASC` (ascending), `DESC` (descending)
SortOrder *GetArtifactScansParamsSortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`
// SortField The field by which to sort the results.
//
// Specifies which field should be used for sorting. Available fields depend
// on the endpoint and the type of data being returned.
//
// Common examples: `name`, `createdAt`, `updatedAt`
SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`
// SearchTerm Search term for filtering results.
//
// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
// Scope **Scope of registries to list**
// * **none** – current space only (default) * **ancestors** – current space **plus** all parent spaces * **descendants** – current space **plus** all child spaces
// If omitted, `none` is assumed.
Scope *GetArtifactScansParamsScope `form:"scope,omitempty" json:"scope,omitempty"`
}
GetArtifactScansParams defines parameters for GetArtifactScans.
type GetArtifactScansParamsScope ¶
type GetArtifactScansParamsScope string
GetArtifactScansParamsScope defines parameters for GetArtifactScans.
const ( Ancestors GetArtifactScansParamsScope = "ancestors" Descendants GetArtifactScansParamsScope = "descendants" None GetArtifactScansParamsScope = "none" )
Defines values for GetArtifactScansParamsScope.
type GetArtifactScansParamsSortOrder ¶
type GetArtifactScansParamsSortOrder string
GetArtifactScansParamsSortOrder defines parameters for GetArtifactScans.
const ( GetArtifactScansParamsSortOrderASC GetArtifactScansParamsSortOrder = "ASC" GetArtifactScansParamsSortOrderDESC GetArtifactScansParamsSortOrder = "DESC" )
Defines values for GetArtifactScansParamsSortOrder.
type GetArtifactScansResp ¶
type GetArtifactScansResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListArtifactScanResponse
JSONDefault *V3Error
}
func ParseGetArtifactScansResp ¶
func ParseGetArtifactScansResp(rsp *http.Response) (*GetArtifactScansResp, error)
ParseGetArtifactScansResp parses an HTTP response from a GetArtifactScansWithResponse call
func (GetArtifactScansResp) Status ¶
func (r GetArtifactScansResp) Status() string
Status returns HTTPResponse.Status
func (GetArtifactScansResp) StatusCode ¶
func (r GetArtifactScansResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetBulkScanEvaluationStatusParams ¶
type GetBulkScanEvaluationStatusParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
}
GetBulkScanEvaluationStatusParams defines parameters for GetBulkScanEvaluationStatus.
type GetBulkScanEvaluationStatusResp ¶
type GetBulkScanEvaluationStatusResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BulkScanEvaluationStatusResponse
JSONDefault *V3Error
}
func ParseGetBulkScanEvaluationStatusResp ¶
func ParseGetBulkScanEvaluationStatusResp(rsp *http.Response) (*GetBulkScanEvaluationStatusResp, error)
ParseGetBulkScanEvaluationStatusResp parses an HTTP response from a GetBulkScanEvaluationStatusWithResponse call
func (GetBulkScanEvaluationStatusResp) Status ¶
func (r GetBulkScanEvaluationStatusResp) Status() string
Status returns HTTPResponse.Status
func (GetBulkScanEvaluationStatusResp) StatusCode ¶
func (r GetBulkScanEvaluationStatusResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSystemInfoParams ¶ added in v1.3.15
type GetSystemInfoParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
}
GetSystemInfoParams defines parameters for GetSystemInfo.
type GetSystemInfoResp ¶ added in v1.3.15
type GetSystemInfoResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *map[string]interface{}
JSONDefault *V3Error
}
func ParseGetSystemInfoResp ¶ added in v1.3.15
func ParseGetSystemInfoResp(rsp *http.Response) (*GetSystemInfoResp, error)
ParseGetSystemInfoResp parses an HTTP response from a GetSystemInfoWithResponse call
func (GetSystemInfoResp) Status ¶ added in v1.3.15
func (r GetSystemInfoResp) Status() string
Status returns HTTPResponse.Status
func (GetSystemInfoResp) StatusCode ¶ added in v1.3.15
func (r GetSystemInfoResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type IncludeMetaParam ¶ added in v1.3.31
type IncludeMetaParam = bool
IncludeMetaParam defines model for IncludeMetaParam.
type InitiateBulkScanEvaluationJSONRequestBody ¶
type InitiateBulkScanEvaluationJSONRequestBody = BulkScanEvaluationRequest
InitiateBulkScanEvaluationJSONRequestBody defines body for InitiateBulkScanEvaluation for application/json ContentType.
type InitiateBulkScanEvaluationParams ¶
type InitiateBulkScanEvaluationParams struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
}
InitiateBulkScanEvaluationParams defines parameters for InitiateBulkScanEvaluation.
type InitiateBulkScanEvaluationResp ¶
type InitiateBulkScanEvaluationResp struct {
Body []byte
HTTPResponse *http.Response
JSON202 *BulkScanEvaluationAccepted
JSONDefault *V3Error
}
func ParseInitiateBulkScanEvaluationResp ¶
func ParseInitiateBulkScanEvaluationResp(rsp *http.Response) (*InitiateBulkScanEvaluationResp, error)
ParseInitiateBulkScanEvaluationResp parses an HTTP response from a InitiateBulkScanEvaluationWithResponse call
func (InitiateBulkScanEvaluationResp) Status ¶
func (r InitiateBulkScanEvaluationResp) Status() string
Status returns HTTPResponse.Status
func (InitiateBulkScanEvaluationResp) StatusCode ¶
func (r InitiateBulkScanEvaluationResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type LastModifiedAtMs ¶ added in v1.3.31
type LastModifiedAtMs = int64
LastModifiedAtMs Unix timestamp in milliseconds when the resource was last modified
type LicensePolicyFailureDetailConfig ¶
type LicensePolicyFailureDetailConfig struct {
// AllowedLicenses Allowed license list.
AllowedLicenses []string `json:"allowedLicenses"`
// BlockedLicense Blocked license.
BlockedLicense string `json:"blockedLicense"`
}
LicensePolicyFailureDetailConfig License-specific failure detail payload.
type ListArtifactScanResponse ¶
type ListArtifactScanResponse struct {
// Data A list of artifact scans
Data []ArtifactScan `json:"data"`
// ItemCount The total number of items
ItemCount int64 `json:"itemCount"`
// Meta Metadata about the list artifact scans
Meta ScanMeta `json:"meta"`
// PageCount The total number of pages
PageCount int64 `json:"pageCount"`
// PageIndex The current page
PageIndex int64 `json:"pageIndex"`
// PageSize The number of items per page
PageSize int `json:"pageSize"`
}
ListArtifactScanResponse defines model for ListArtifactScanResponse.
type ListFilesResponse ¶ added in v1.3.31
type ListFilesResponse struct {
// HasMore True if more results exist after this page.
HasMore bool `json:"hasMore"`
Items []FileMetadata `json:"items"`
// Meta Metadata about the list response
Meta *Meta `json:"meta,omitempty"`
// Page The current page (0-indexed)
Page int64 `json:"page"`
// Size Number of items per page
Size int64 `json:"size"`
}
ListFilesResponse defines model for ListFilesResponse.
type ListFilesV3Params ¶ added in v1.3.31
type ListFilesV3Params struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
// RegistryId Unique id for the registry.
RegistryId *RegistryIdOptionalParam `form:"registry_id,omitempty" json:"registry_id,omitempty"`
// PackageId Unique identifier for the package.
PackageId *PackageIdOptionalParam `form:"package_id,omitempty" json:"package_id,omitempty"`
// VersionId Unique identifier for the version.
VersionId *VersionIdOptionalParam `form:"version_id,omitempty" json:"version_id,omitempty"`
// RecipeRevisionId Internal UUID of the Conan recipe revision (RREV) row. Resolves file paths via
// node_entity_mapping. Requires version_id.
// Mutually exclusive with package_revision_id.
RecipeRevisionId *ConanRecipeRevisionOptionalParam `form:"recipe_revision_id,omitempty" json:"recipe_revision_id,omitempty"`
// PackageRevisionId Internal UUID of the Conan package revision (PREV) row. Resolves file paths via
// node_entity_mapping. Requires version_id.
// Mutually exclusive with recipe_revision_id.
PackageRevisionId *ConanPackageRevisionOptionalParam `form:"package_revision_id,omitempty" json:"package_revision_id,omitempty"`
// Page The page number for pagination (0-indexed).
//
// Used to navigate through large result sets. Combined with `size` parameter
// to control which subset of results to return.
//
// Example: `page=0` returns the first page, `page=1` returns the second page
Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`
// Size The number of items to return per page.
//
// Controls the page size for paginated results.
//
// Example: `size=50` returns up to 50 items per page
Size *PageSize `form:"size,omitempty" json:"size,omitempty"`
// Sort The sort for the results.
// Accepted pattern: `sort_field:sort_order` where sort_field is the field name
// and sort_order is either `asc` or `desc`.
//
// Examples: `name:asc`, `modifiedAt:desc`
Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`
// SearchTerm Search term for filtering results.
//
// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
}
ListFilesV3Params defines parameters for ListFilesV3.
type ListFilesV3Resp ¶ added in v1.3.31
type ListFilesV3Resp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListFilesResponse
JSONDefault *V3Error
}
func ParseListFilesV3Resp ¶ added in v1.3.31
func ParseListFilesV3Resp(rsp *http.Response) (*ListFilesV3Resp, error)
ParseListFilesV3Resp parses an HTTP response from a ListFilesV3WithResponse call
func (ListFilesV3Resp) Status ¶ added in v1.3.31
func (r ListFilesV3Resp) Status() string
Status returns HTTPResponse.Status
func (ListFilesV3Resp) StatusCode ¶ added in v1.3.31
func (r ListFilesV3Resp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListPackageResponse ¶ added in v1.3.31
type ListPackageResponse struct {
// HasMore True if more results exist after this page.
HasMore bool `json:"hasMore"`
Items []Package `json:"items"`
// Meta Metadata about the list response
Meta *Meta `json:"meta,omitempty"`
// Page The current page (0-indexed)
Page int64 `json:"page"`
// Size Number of items per page
Size int64 `json:"size"`
}
ListPackageResponse defines model for ListPackageResponse.
type ListPackagesV3Params ¶ added in v1.3.31
type ListPackagesV3Params struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
// RegistryIds Unique id for the registry.
// Note: This parameter should have one id if package query param is provided
RegistryIds *RegistryIdsListParam `form:"registry_ids,omitempty" json:"registry_ids,omitempty"`
// Metadata Filter by metadata using key:value format
Metadata *MetadataFilterListParam `form:"metadata,omitempty" json:"metadata,omitempty"`
// PackageKind refers to package kind which is being used in huggingface packages for model, dataset
PackageKind *PackageKindQueryParam `form:"package_kind,omitempty" json:"package_kind,omitempty"`
// PackageTypes Registry Package Type
PackageTypes *PackageTypesListParam `form:"package_types,omitempty" json:"package_types,omitempty"`
Deleted *ListPackagesV3ParamsDeleted `form:"deleted,omitempty" json:"deleted,omitempty"`
// Page The page number for pagination (0-indexed).
//
// Used to navigate through large result sets. Combined with `size` parameter
// to control which subset of results to return.
//
// Example: `page=0` returns the first page, `page=1` returns the second page
Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`
// Size The number of items to return per page.
//
// Controls the page size for paginated results.
//
// Example: `size=50` returns up to 50 items per page
Size *PageSize `form:"size,omitempty" json:"size,omitempty"`
// Sort The sort for the results.
// Accepted pattern: `sort_field:sort_order` where sort_field is the field name
// and sort_order is either `asc` or `desc`.
//
// Examples: `name:asc`, `modifiedAt:desc`
Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`
// SearchTerm Search term for filtering results.
//
// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
// IncludeMeta When `true`, include the `meta` object (e.g. active/deleted counts)
// in the response.
IncludeMeta *IncludeMetaParam `form:"include_meta,omitempty" json:"include_meta,omitempty"`
}
ListPackagesV3Params defines parameters for ListPackagesV3.
type ListPackagesV3ParamsDeleted ¶ added in v1.3.31
type ListPackagesV3ParamsDeleted string
ListPackagesV3ParamsDeleted defines parameters for ListPackagesV3.
const ( ListPackagesV3ParamsDeletedExclude ListPackagesV3ParamsDeleted = "exclude" ListPackagesV3ParamsDeletedInclude ListPackagesV3ParamsDeleted = "include" ListPackagesV3ParamsDeletedOnly ListPackagesV3ParamsDeleted = "only" )
Defines values for ListPackagesV3ParamsDeleted.
type ListPackagesV3Resp ¶ added in v1.3.31
type ListPackagesV3Resp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListPackageResponse
JSONDefault *V3Error
}
func ParseListPackagesV3Resp ¶ added in v1.3.31
func ParseListPackagesV3Resp(rsp *http.Response) (*ListPackagesV3Resp, error)
ParseListPackagesV3Resp parses an HTTP response from a ListPackagesV3WithResponse call
func (ListPackagesV3Resp) Status ¶ added in v1.3.31
func (r ListPackagesV3Resp) Status() string
Status returns HTTPResponse.Status
func (ListPackagesV3Resp) StatusCode ¶ added in v1.3.31
func (r ListPackagesV3Resp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListRegistriesV3Params ¶ added in v1.3.31
type ListRegistriesV3Params struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
// PackageTypes Registry Package Type
PackageTypes *PackageTypesListParam `form:"package_types,omitempty" json:"package_types,omitempty"`
// Type Registry Type
Type *ListRegistriesV3ParamsType `form:"type,omitempty" json:"type,omitempty"`
// Metadata Filter by metadata using key:value format
Metadata *MetadataFilterListParam `form:"metadata,omitempty" json:"metadata,omitempty"`
// Scope **Scope of registries to list**
// * **none** – current space only (default) * **ancestors** – current space **plus** all parent spaces * **descendants** – current space **plus** all child spaces
// If omitted, `none` is assumed.
Scope *ListRegistriesV3ParamsScope `form:"scope,omitempty" json:"scope,omitempty"`
Deleted *ListRegistriesV3ParamsDeleted `form:"deleted,omitempty" json:"deleted,omitempty"`
// Page The page number for pagination (0-indexed).
//
// Used to navigate through large result sets. Combined with `size` parameter
// to control which subset of results to return.
//
// Example: `page=0` returns the first page, `page=1` returns the second page
Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`
// Size The number of items to return per page.
//
// Controls the page size for paginated results.
//
// Example: `size=50` returns up to 50 items per page
Size *PageSize `form:"size,omitempty" json:"size,omitempty"`
// Sort The sort for the results.
// Accepted pattern: `sort_field:sort_order` where sort_field is the field name
// and sort_order is either `asc` or `desc`.
//
// Examples: `name:asc`, `modifiedAt:desc`
Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`
// SearchTerm Search term for filtering results.
//
// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
// IncludeMeta When `true`, include the `meta` object (e.g. active/deleted counts)
// in the response.
IncludeMeta *IncludeMetaParam `form:"include_meta,omitempty" json:"include_meta,omitempty"`
}
ListRegistriesV3Params defines parameters for ListRegistriesV3.
type ListRegistriesV3ParamsDeleted ¶ added in v1.3.31
type ListRegistriesV3ParamsDeleted string
ListRegistriesV3ParamsDeleted defines parameters for ListRegistriesV3.
const ( ListRegistriesV3ParamsDeletedExclude ListRegistriesV3ParamsDeleted = "exclude" ListRegistriesV3ParamsDeletedInclude ListRegistriesV3ParamsDeleted = "include" ListRegistriesV3ParamsDeletedOnly ListRegistriesV3ParamsDeleted = "only" )
Defines values for ListRegistriesV3ParamsDeleted.
type ListRegistriesV3ParamsScope ¶ added in v1.3.31
type ListRegistriesV3ParamsScope string
ListRegistriesV3ParamsScope defines parameters for ListRegistriesV3.
const ( ListRegistriesV3ParamsScopeAncestors ListRegistriesV3ParamsScope = "ancestors" ListRegistriesV3ParamsScopeDescendants ListRegistriesV3ParamsScope = "descendants" ListRegistriesV3ParamsScopeNone ListRegistriesV3ParamsScope = "none" )
Defines values for ListRegistriesV3ParamsScope.
type ListRegistriesV3ParamsType ¶ added in v1.3.31
type ListRegistriesV3ParamsType string
ListRegistriesV3ParamsType defines parameters for ListRegistriesV3.
const ( UPSTREAM ListRegistriesV3ParamsType = "UPSTREAM" VIRTUAL ListRegistriesV3ParamsType = "VIRTUAL" )
Defines values for ListRegistriesV3ParamsType.
type ListRegistriesV3Resp ¶ added in v1.3.31
type ListRegistriesV3Resp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListRegistryResponse
JSONDefault *V3Error
}
func ParseListRegistriesV3Resp ¶ added in v1.3.31
func ParseListRegistriesV3Resp(rsp *http.Response) (*ListRegistriesV3Resp, error)
ParseListRegistriesV3Resp parses an HTTP response from a ListRegistriesV3WithResponse call
func (ListRegistriesV3Resp) Status ¶ added in v1.3.31
func (r ListRegistriesV3Resp) Status() string
Status returns HTTPResponse.Status
func (ListRegistriesV3Resp) StatusCode ¶ added in v1.3.31
func (r ListRegistriesV3Resp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListRegistryResponse ¶ added in v1.3.31
type ListRegistryResponse struct {
// HasMore True if more results exist after this page.
HasMore bool `json:"hasMore"`
Items []Registry `json:"items"`
// Meta Metadata about the list response
Meta *Meta `json:"meta,omitempty"`
// Page The current page (0-indexed)
Page int64 `json:"page"`
// Size Number of items per page
Size int64 `json:"size"`
}
ListRegistryResponse defines model for ListRegistryResponse.
type ListVersionResponse ¶ added in v1.3.31
type ListVersionResponse struct {
// HasMore True if more results exist after this page.
HasMore bool `json:"hasMore"`
Items []Version `json:"items"`
// Meta Metadata about the list response
Meta *Meta `json:"meta,omitempty"`
// Page The current page (0-indexed)
Page int64 `json:"page"`
// Size Number of items per page
Size int64 `json:"size"`
}
ListVersionResponse defines model for ListVersionResponse.
type ListVersionsV3Params ¶ added in v1.3.31
type ListVersionsV3Params struct {
// AccountIdentifier Unique identifier for the Harness account.
AccountIdentifier AccountIdentifier `form:"account_identifier" json:"account_identifier"`
// OrgIdentifier Unique identifier for the organization within the account.
//
// Example: `default` or `engineering_org`
OrgIdentifier *OrgIdentifier `form:"org_identifier,omitempty" json:"org_identifier,omitempty"`
// ProjectIdentifier Unique identifier for the project within the organization.
//
// Example: `my_project` or `frontend_services`
ProjectIdentifier *ProjectIdentifier `form:"project_identifier,omitempty" json:"project_identifier,omitempty"`
// RegistryIds Unique id for the registry.
// Note: This parameter should have one id if package query param is provided
RegistryIds *RegistryIdsListParam `form:"registry_ids,omitempty" json:"registry_ids,omitempty"`
// PackageIds Unique id for the package.
PackageIds *PackageIdsListParam `form:"package_ids,omitempty" json:"package_ids,omitempty"`
// PackageTypes Registry Package Type
PackageTypes *PackageTypesListParam `form:"package_types,omitempty" json:"package_types,omitempty"`
Deleted *ListVersionsV3ParamsDeleted `form:"deleted,omitempty" json:"deleted,omitempty"`
// Metadata Filter by metadata using key:value format
Metadata *MetadataFilterListParam `form:"metadata,omitempty" json:"metadata,omitempty"`
// Page The page number for pagination (0-indexed).
//
// Used to navigate through large result sets. Combined with `size` parameter
// to control which subset of results to return.
//
// Example: `page=0` returns the first page, `page=1` returns the second page
Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`
// Size The number of items to return per page.
//
// Controls the page size for paginated results.
//
// Example: `size=50` returns up to 50 items per page
Size *PageSize `form:"size,omitempty" json:"size,omitempty"`
// Sort The sort for the results.
// Accepted pattern: `sort_field:sort_order` where sort_field is the field name
// and sort_order is either `asc` or `desc`.
//
// Examples: `name:asc`, `modifiedAt:desc`
Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`
// SearchTerm Search term for filtering results.
//
// Example: `search_term=prod` might match keys like "production", "prod-env", etc.
SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
// IncludeMeta When `true`, include the `meta` object (e.g. active/deleted counts)
// in the response.
IncludeMeta *IncludeMetaParam `form:"include_meta,omitempty" json:"include_meta,omitempty"`
// UploadedBy Filter by uploaded by user ID.
//
// Example: `uploaded_by=123`
UploadedBy *UploadedByParam `form:"uploaded_by,omitempty" json:"uploaded_by,omitempty"`
}
ListVersionsV3Params defines parameters for ListVersionsV3.
type ListVersionsV3ParamsDeleted ¶ added in v1.3.31
type ListVersionsV3ParamsDeleted string
ListVersionsV3ParamsDeleted defines parameters for ListVersionsV3.
const ( ListVersionsV3ParamsDeletedExclude ListVersionsV3ParamsDeleted = "exclude" ListVersionsV3ParamsDeletedInclude ListVersionsV3ParamsDeleted = "include" ListVersionsV3ParamsDeletedOnly ListVersionsV3ParamsDeleted = "only" )
Defines values for ListVersionsV3ParamsDeleted.
type ListVersionsV3Resp ¶ added in v1.3.31
type ListVersionsV3Resp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ListVersionResponse
JSONDefault *V3Error
}
func ParseListVersionsV3Resp ¶ added in v1.3.31
func ParseListVersionsV3Resp(rsp *http.Response) (*ListVersionsV3Resp, error)
ParseListVersionsV3Resp parses an HTTP response from a ListVersionsV3WithResponse call
func (ListVersionsV3Resp) Status ¶ added in v1.3.31
func (r ListVersionsV3Resp) Status() string
Status returns HTTPResponse.Status
func (ListVersionsV3Resp) StatusCode ¶ added in v1.3.31
func (r ListVersionsV3Resp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Meta ¶ added in v1.3.31
type Meta struct {
// ActiveCount Count of active (non-deleted) entities
ActiveCount int64 `json:"activeCount"`
// DeletedCount Count of soft-deleted entities
DeletedCount int64 `json:"deletedCount"`
}
Meta Metadata about the list response
type MetadataFilterListParam ¶ added in v1.3.31
type MetadataFilterListParam = []string
MetadataFilterListParam defines model for MetadataFilterListParam.
type Package ¶ added in v1.3.31
type Package struct {
// DeletedAt Unix timestamp in milliseconds when the resource was soft-deleted
DeletedAt *DeletedAtMs `json:"deletedAt"`
// DeletedBy Structured user information for a principal
DeletedBy *UserInfo `json:"deletedBy,omitempty"`
DownloadCount *int64 `json:"downloadCount,omitempty"`
Id openapi_types.UUID `json:"id"`
IsPublic bool `json:"isPublic"`
IsQuarantined *bool `json:"isQuarantined,omitempty"`
LatestVersion string `json:"latestVersion"`
LatestVersionArtifactKey *map[string]interface{} `json:"latestVersionArtifactKey,omitempty"`
// ModifiedAt Unix timestamp in milliseconds when the resource was last modified
ModifiedAt *LastModifiedAtMs `json:"modifiedAt"`
// ModifiedBy Structured user information for a principal
ModifiedBy *UserInfo `json:"modifiedBy,omitempty"`
Name string `json:"name"`
// PackageKind refers to package kind which is being used in huggingface packages for model, dataset
PackageKind *PackageKind `json:"packageKind,omitempty"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
QuarantineReason *string `json:"quarantineReason,omitempty"`
RegistryId openapi_types.UUID `json:"registryId"`
RegistryName string `json:"registryName"`
}
Package Package Metadata
type PackageAgeViolationPolicyFailureDetailConfig ¶
type PackageAgeViolationPolicyFailureDetailConfig struct {
// PackageAgeThreshold Package age threshold.
PackageAgeThreshold string `json:"packageAgeThreshold"`
// PublishedOn Package publish date.
PublishedOn string `json:"publishedOn"`
}
PackageAgeViolationPolicyFailureDetailConfig Package age violation failure detail payload.
type PackageIdOptionalParam ¶ added in v1.3.31
type PackageIdOptionalParam = string
PackageIdOptionalParam defines model for PackageIdOptionalParam.
type PackageIdsListParam ¶ added in v1.3.31
type PackageIdsListParam = []openapi_types.UUID
PackageIdsListParam defines model for PackageIdsListParam.
type PackageKind ¶ added in v1.3.31
type PackageKind = string
PackageKind refers to package kind which is being used in huggingface packages for model, dataset
type PackageKindQueryParam ¶ added in v1.3.31
type PackageKindQueryParam = string
PackageKindQueryParam defines model for PackageKindQueryParam.
type PackageType ¶
type PackageType = string
PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
type PackageTypeListParam ¶
type PackageTypeListParam = []string
PackageTypeListParam defines model for PackageTypeListParam.
type PackageTypesListParam ¶ added in v1.3.31
type PackageTypesListParam = []string
PackageTypesListParam defines model for PackageTypesListParam.
type PageInfo ¶ added in v1.3.31
type PageInfo struct {
// HasMore True if more results exist after this page.
HasMore bool `json:"hasMore"`
// Page The current page (0-indexed)
Page int64 `json:"page"`
// Size Number of items per page
Size int64 `json:"size"`
}
PageInfo Pagination metadata. - `page` selects which page of results to return (0 = first page). - `size` controls how many items are returned per page. - `hasMore` is true if more results exist after this page.
type PipelineContext ¶ added in v1.3.18
type PipelineContext struct {
// ExecutionId Execution identifier
ExecutionId string `json:"executionId"`
// OrgId Organization identifier
OrgId string `json:"orgId"`
// PipelineId Pipeline identifier
PipelineId string `json:"pipelineId"`
// ProjectId Project identifier
ProjectId string `json:"projectId"`
// StageId Stage identifier
StageId string `json:"stageId"`
// StepId Step identifier
StepId *string `json:"stepId,omitempty"`
}
PipelineContext Pipeline execution context
type PolicyFailureDetail ¶
type PolicyFailureDetail struct {
// Category Policy failure detail category.
Category PolicyFailureDetailCategory `json:"category"`
// PolicyName Policy name.
PolicyName string `json:"policyName"`
// PolicyRef Policy Ref.
PolicyRef string `json:"policyRef"`
// contains filtered or unexported fields
}
PolicyFailureDetail Policy failure detail entry.
func (PolicyFailureDetail) AsLicensePolicyFailureDetailConfig ¶
func (t PolicyFailureDetail) AsLicensePolicyFailureDetailConfig() (LicensePolicyFailureDetailConfig, error)
AsLicensePolicyFailureDetailConfig returns the union data inside the PolicyFailureDetail as a LicensePolicyFailureDetailConfig
func (PolicyFailureDetail) AsPackageAgeViolationPolicyFailureDetailConfig ¶
func (t PolicyFailureDetail) AsPackageAgeViolationPolicyFailureDetailConfig() (PackageAgeViolationPolicyFailureDetailConfig, error)
AsPackageAgeViolationPolicyFailureDetailConfig returns the union data inside the PolicyFailureDetail as a PackageAgeViolationPolicyFailureDetailConfig
func (PolicyFailureDetail) AsSecurityPolicyFailureDetailConfig ¶
func (t PolicyFailureDetail) AsSecurityPolicyFailureDetailConfig() (SecurityPolicyFailureDetailConfig, error)
AsSecurityPolicyFailureDetailConfig returns the union data inside the PolicyFailureDetail as a SecurityPolicyFailureDetailConfig
func (PolicyFailureDetail) Discriminator ¶
func (t PolicyFailureDetail) Discriminator() (string, error)
func (*PolicyFailureDetail) FromLicensePolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) FromLicensePolicyFailureDetailConfig(v LicensePolicyFailureDetailConfig) error
FromLicensePolicyFailureDetailConfig overwrites any union data inside the PolicyFailureDetail as the provided LicensePolicyFailureDetailConfig
func (*PolicyFailureDetail) FromPackageAgeViolationPolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) FromPackageAgeViolationPolicyFailureDetailConfig(v PackageAgeViolationPolicyFailureDetailConfig) error
FromPackageAgeViolationPolicyFailureDetailConfig overwrites any union data inside the PolicyFailureDetail as the provided PackageAgeViolationPolicyFailureDetailConfig
func (*PolicyFailureDetail) FromSecurityPolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) FromSecurityPolicyFailureDetailConfig(v SecurityPolicyFailureDetailConfig) error
FromSecurityPolicyFailureDetailConfig overwrites any union data inside the PolicyFailureDetail as the provided SecurityPolicyFailureDetailConfig
func (PolicyFailureDetail) MarshalJSON ¶
func (t PolicyFailureDetail) MarshalJSON() ([]byte, error)
func (*PolicyFailureDetail) MergeLicensePolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) MergeLicensePolicyFailureDetailConfig(v LicensePolicyFailureDetailConfig) error
MergeLicensePolicyFailureDetailConfig performs a merge with any union data inside the PolicyFailureDetail, using the provided LicensePolicyFailureDetailConfig
func (*PolicyFailureDetail) MergePackageAgeViolationPolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) MergePackageAgeViolationPolicyFailureDetailConfig(v PackageAgeViolationPolicyFailureDetailConfig) error
MergePackageAgeViolationPolicyFailureDetailConfig performs a merge with any union data inside the PolicyFailureDetail, using the provided PackageAgeViolationPolicyFailureDetailConfig
func (*PolicyFailureDetail) MergeSecurityPolicyFailureDetailConfig ¶
func (t *PolicyFailureDetail) MergeSecurityPolicyFailureDetailConfig(v SecurityPolicyFailureDetailConfig) error
MergeSecurityPolicyFailureDetailConfig performs a merge with any union data inside the PolicyFailureDetail, using the provided SecurityPolicyFailureDetailConfig
func (*PolicyFailureDetail) UnmarshalJSON ¶
func (t *PolicyFailureDetail) UnmarshalJSON(b []byte) error
func (PolicyFailureDetail) ValueByDiscriminator ¶
func (t PolicyFailureDetail) ValueByDiscriminator() (interface{}, error)
type PolicyFailureDetailCategory ¶
type PolicyFailureDetailCategory string
PolicyFailureDetailCategory Policy failure detail category.
const ( License PolicyFailureDetailCategory = "License" PackageAge PolicyFailureDetailCategory = "PackageAge" Security PolicyFailureDetailCategory = "Security" Unknown PolicyFailureDetailCategory = "Unknown" )
Defines values for PolicyFailureDetailCategory.
type PolicySetFailureDetail ¶ added in v1.3.7
type PolicySetFailureDetail struct {
PolicyFailureDetails []PolicyFailureDetail `json:"policyFailureDetails"`
// PolicySetName Policy set name.
PolicySetName string `json:"policySetName"`
// PolicySetRef Policy set reference.
PolicySetRef string `json:"policySetRef"`
}
PolicySetFailureDetail Policy set failure detail entry.
type PolicySetRefParam ¶
type PolicySetRefParam = string
PolicySetRefParam defines model for PolicySetRefParam.
type PolicySets ¶
type PolicySets = []struct {
// PolicySetName Policy Set name
PolicySetName string `json:"policySetName"`
// PolicySetRef Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy`
PolicySetRef string `json:"policySetRef"`
}
PolicySets List of opa policy sets.
type ProjectIdentifier ¶
type ProjectIdentifier = string
ProjectIdentifier defines model for ProjectIdentifier.
type Registry ¶ added in v1.3.31
type Registry struct {
ArtifactsCount *int64 `json:"artifactsCount,omitempty"`
// DeletedAt Unix timestamp in milliseconds when the resource was soft-deleted
DeletedAt *DeletedAtMs `json:"deletedAt"`
// DeletedBy Structured user information for a principal
DeletedBy *UserInfo `json:"deletedBy,omitempty"`
Description *string `json:"description,omitempty"`
DownloadCount *int64 `json:"downloadCount,omitempty"`
Id openapi_types.UUID `json:"id"`
IsPublic bool `json:"isPublic"`
// ModifiedAt Unix timestamp in milliseconds when the resource was last modified
ModifiedAt *LastModifiedAtMs `json:"modifiedAt"`
// ModifiedBy Structured user information for a principal
ModifiedBy *UserInfo `json:"modifiedBy,omitempty"`
Name string `json:"name"`
PackageCount *int64 `json:"packageCount,omitempty"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
Path *string `json:"path,omitempty"`
Size *string `json:"size,omitempty"`
// Type refers to type of registry i.e virtual or upstream
Type RegistryType `json:"type"`
Url string `json:"url"`
}
Registry Registry Metadata
type RegistryIdListParam ¶
type RegistryIdListParam = []openapi_types.UUID
RegistryIdListParam defines model for RegistryIdListParam.
type RegistryIdOptionalParam ¶ added in v1.3.31
type RegistryIdOptionalParam = string
RegistryIdOptionalParam defines model for RegistryIdOptionalParam.
type RegistryIdsListParam ¶ added in v1.3.31
type RegistryIdsListParam = []openapi_types.UUID
RegistryIdsListParam defines model for RegistryIdsListParam.
type RegistryScope ¶
type RegistryScope string
RegistryScope defines model for RegistryScope.
const ( RegistryScopeAncestors RegistryScope = "ancestors" RegistryScopeDescendants RegistryScope = "descendants" RegistryScopeNone RegistryScope = "none" )
Defines values for RegistryScope.
type RegistryType ¶ added in v1.3.31
type RegistryType string
RegistryType refers to type of registry i.e virtual or upstream
const ( RegistryTypeUPSTREAM RegistryType = "UPSTREAM" RegistryTypeVIRTUAL RegistryType = "VIRTUAL" )
Defines values for RegistryType.
type RegistryTypeParam ¶ added in v1.3.31
type RegistryTypeParam string
RegistryTypeParam defines model for RegistryTypeParam.
const ( RegistryTypeParamUPSTREAM RegistryTypeParam = "UPSTREAM" RegistryTypeParamVIRTUAL RegistryTypeParam = "VIRTUAL" )
Defines values for RegistryTypeParam.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RootPackage ¶ added in v1.3.18
type RootPackage struct {
// Name Name of the root package
Name string `json:"name"`
// Version Version of the root package
Version string `json:"version"`
}
RootPackage Root package of the build
type ScanIDQueryParam ¶
type ScanIDQueryParam = string
ScanIDQueryParam defines model for ScanIDQueryParam.
type ScanMeta ¶
type ScanMeta struct {
// BlockedCount Count of active blocked artifacts
BlockedCount *int64 `json:"blockedCount,omitempty"`
// TotalCount Count of total artifact violations
TotalCount *int64 `json:"totalCount,omitempty"`
// WarnCount Count of active Warn artifacts
WarnCount *int64 `json:"warnCount,omitempty"`
}
ScanMeta Metadata about the list artifact scans
type ScanStatusParam ¶
type ScanStatusParam = string
ScanStatusParam defines model for ScanStatusParam.
type SecurityPolicyFailureDetailConfig ¶
type SecurityPolicyFailureDetailConfig struct {
// Vulnerabilities List of security violations.
Vulnerabilities []SecurityPolicyFailureVulnerability `json:"vulnerabilities"`
}
SecurityPolicyFailureDetailConfig Security-specific failure detail payload.
type SecurityPolicyFailureVulnerability ¶
type SecurityPolicyFailureVulnerability struct {
// CveId CVE identifier.
CveId string `json:"cveId"`
// CvssScore CVSS score.
CvssScore float64 `json:"cvssScore"`
// CvssThreshold CVSS threshold.
CvssThreshold float64 `json:"cvssThreshold"`
}
SecurityPolicyFailureVulnerability Security violation entry.
type UploadedByParam ¶ added in v1.3.31
type UploadedByParam = []int64
UploadedByParam defines model for UploadedByParam.
type UserInfo ¶ added in v1.3.31
type UserInfo struct {
// DisplayName Human-readable display name
DisplayName *string `json:"display_name,omitempty"`
// Email Email address
Email *string `json:"email,omitempty"`
// Type Principal type (user, service, service_account)
Type *string `json:"type,omitempty"`
// Uid Principal unique identifier (username)
Uid *string `json:"uid,omitempty"`
}
UserInfo Structured user information for a principal
type V3Error ¶
type V3Error struct {
Error ApiErrors `json:"error"`
}
V3Error An error response from the Stripe API
type Version ¶ added in v1.3.31
type Version struct {
ArtifactKey *map[string]interface{} `json:"artifactKey,omitempty"`
// CreatedAt Unix timestamp in milliseconds when the resource was last modified
CreatedAt *LastModifiedAtMs `json:"createdAt"`
// CreatedBy Structured user information for a principal
CreatedBy *UserInfo `json:"createdBy,omitempty"`
// DeletedAt Unix timestamp in milliseconds when the resource was soft-deleted
DeletedAt *DeletedAtMs `json:"deletedAt"`
// DeletedBy Structured user information for a principal
DeletedBy *UserInfo `json:"deletedBy,omitempty"`
DeploymentMetadata *struct {
NonProdEnvCount int `json:"nonProdEnvCount"`
ProdEnvCount int `json:"prodEnvCount"`
} `json:"deploymentMetadata,omitempty"`
DownloadCount *int64 `json:"downloadCount,omitempty"`
FileCount *int `json:"fileCount,omitempty"`
FirewallMode *VersionFirewallMode `json:"firewallMode,omitempty"`
Id openapi_types.UUID `json:"id"`
IsQuarantined *bool `json:"isQuarantined,omitempty"`
LastScannedAt *string `json:"lastScannedAt,omitempty"`
// ModifiedAt Unix timestamp in milliseconds when the resource was last modified
ModifiedAt *LastModifiedAtMs `json:"modifiedAt"`
// ModifiedBy Structured user information for a principal
ModifiedBy *UserInfo `json:"modifiedBy,omitempty"`
Name string `json:"name"`
PackageId openapi_types.UUID `json:"packageId"`
// PackageKind refers to package kind which is being used in huggingface packages for model, dataset
PackageKind *PackageKind `json:"packageKind,omitempty"`
PackageName string `json:"packageName"`
// PackageType Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT. This field is extensible; clients must handle unknown values.
PackageType PackageType `json:"packageType"`
PullCommand *string `json:"pullCommand,omitempty"`
// PushedBy Structured user information for a principal
PushedBy *UserInfo `json:"pushedBy,omitempty"`
QuarantineReason *string `json:"quarantineReason,omitempty"`
RegistryId openapi_types.UUID `json:"registryId"`
RegistryName string `json:"registryName"`
// RegistryType refers to type of registry i.e virtual or upstream
RegistryType RegistryType `json:"registryType"`
ScanID *openapi_types.UUID `json:"scanID,omitempty"`
ScanStatus *VersionScanStatus `json:"scanStatus,omitempty"`
Size *string `json:"size,omitempty"`
}
Version Version metadata
type VersionFirewallMode ¶ added in v1.3.31
type VersionFirewallMode string
VersionFirewallMode defines model for Version.FirewallMode.
const ( ALLOW VersionFirewallMode = "ALLOW" ENABLED VersionFirewallMode = "ENABLED" QUARANTINE VersionFirewallMode = "QUARANTINE" )
Defines values for VersionFirewallMode.
type VersionIdOptionalParam ¶ added in v1.3.31
type VersionIdOptionalParam = string
VersionIdOptionalParam defines model for VersionIdOptionalParam.
type VersionScanStatus ¶ added in v1.3.31
type VersionScanStatus string
VersionScanStatus defines model for Version.ScanStatus.
const ( VersionScanStatusALLOWED VersionScanStatus = "ALLOWED" VersionScanStatusBLOCKED VersionScanStatus = "BLOCKED" VersionScanStatusUNKNOWN VersionScanStatus = "UNKNOWN" VersionScanStatusWARN VersionScanStatus = "WARN" )
Defines values for VersionScanStatus.