ar

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 16, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package ar 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetAllArtifactVersionsRequest 

func NewGetAllArtifactVersionsRequest(server string, registryRef RegistryRefPathParam, artifact ArtifactPathParam, params *GetAllArtifactVersionsParams) (*http.Request, error)

NewGetAllArtifactVersionsRequest generates requests for GetAllArtifactVersions

func NewGetAllArtifactsByRegistryRequest 

func NewGetAllArtifactsByRegistryRequest(server string, registryRef RegistryRefPathParam, params *GetAllArtifactsByRegistryParams) (*http.Request, error)

NewGetAllArtifactsByRegistryRequest generates requests for GetAllArtifactsByRegistry

func NewGetAllRegistriesRequest 

func NewGetAllRegistriesRequest(server string, spaceRef SpaceRefPathParam, params *GetAllRegistriesParams) (*http.Request, error)

NewGetAllRegistriesRequest generates requests for GetAllRegistries

func NewGetArtifactFilesRequest 

func NewGetArtifactFilesRequest(server string, registryRef RegistryRefPathParam, artifact ArtifactPathParam, version VersionPathParam, params *GetArtifactFilesParams) (*http.Request, error)

NewGetArtifactFilesRequest generates requests for GetArtifactFiles

func NewGetRegistryRequest 

func NewGetRegistryRequest(server string, registryRef RegistryRefPathParam) (*http.Request, error)

NewGetRegistryRequest generates requests for GetRegistry

Types

type AccessKeySecretKey 

type AccessKeySecretKey struct {
	AccessKey                 *string `json:"accessKey,omitempty"`
	AccessKeySecretIdentifier *string `json:"accessKeySecretIdentifier,omitempty"`
	AccessKeySecretSpaceId    *int64  `json:"accessKeySecretSpaceId,omitempty"`
	AccessKeySecretSpacePath  *string `json:"accessKeySecretSpacePath,omitempty"`
	SecretKeyIdentifier       string  `json:"secretKeyIdentifier"`
	SecretKeySpaceId          *int64  `json:"secretKeySpaceId,omitempty"`
	SecretKeySpacePath        *string `json:"secretKeySpacePath,omitempty"`
}

AccessKeySecretKey defines model for AccessKeySecretKey.

type Anonymous 

type Anonymous = interface{}

Anonymous defines model for Anonymous.

type ArtifactEntityMetadata 

type ArtifactEntityMetadata map[string]interface{}

ArtifactEntityMetadata Artifact Entity Metadata

type ArtifactPathParam 

type ArtifactPathParam = string

ArtifactPathParam defines model for artifactPathParam.

type ArtifactType 

type ArtifactType string

ArtifactType refers to artifact type 

const (
	ArtifactTypeDataset ArtifactType = "dataset"
	ArtifactTypeModel   ArtifactType = "model"
)

Defines values for ArtifactType.

type ArtifactTypeParam 

type ArtifactTypeParam string

ArtifactTypeParam defines model for artifactTypeParam. 

const (
	ArtifactTypeParamDataset ArtifactTypeParam = "dataset"
	ArtifactTypeParamModel   ArtifactTypeParam = "model"
)

Defines values for ArtifactTypeParam.

type ArtifactVersionMetadata 

type ArtifactVersionMetadata struct {
	// ArtifactType refers to artifact type
	ArtifactType *ArtifactType `json:"artifactType,omitempty"`

	// DeletedAt Timestamp in milliseconds when the artifact was soft deleted. Null if not deleted.
	DeletedAt          *string                              `json:"deletedAt,omitempty"`
	DeploymentMetadata *DeploymentMetadata                  `json:"deploymentMetadata,omitempty"`
	DigestCount        *int64                               `json:"digestCount,omitempty"`
	DownloadsCount     *int64                               `json:"downloadsCount,omitempty"`
	FileCount          *int64                               `json:"fileCount,omitempty"`
	FirewallMode       *ArtifactVersionMetadataFirewallMode `json:"firewallMode,omitempty"`
	IsQuarantined      *bool                                `json:"isQuarantined,omitempty"`
	LastModified       *string                              `json:"lastModified,omitempty"`
	LastScannedAt      *string                              `json:"lastScannedAt,omitempty"`

	// Metadata Artifact Entity Metadata
	Metadata *ArtifactEntityMetadata `json:"metadata,omitempty"`
	Name     string                  `json:"name"`

	// PackageType refers to package
	PackageType        PackageType `json:"packageType"`
	PullCommand        *string     `json:"pullCommand,omitempty"`
	QuarantineReason   *string     `json:"quarantineReason,omitempty"`
	RegistryIdentifier string      `json:"registryIdentifier"`
	RegistryPath       string      `json:"registryPath"`

	// RegistryType refers to type of registry i.e virtual or upstream
	RegistryType *RegistryType                      `json:"registryType,omitempty"`
	RegistryUUID string                             `json:"registryUUID"`
	ScanId       *string                            `json:"scanId,omitempty"`
	ScanStatus   *ArtifactVersionMetadataScanStatus `json:"scanStatus,omitempty"`
	Size         *string                            `json:"size,omitempty"`
	Uuid         string                             `json:"uuid"`
}

ArtifactVersionMetadata Artifact Version Metadata

type ArtifactVersionMetadataFirewallMode 

type ArtifactVersionMetadataFirewallMode string

ArtifactVersionMetadataFirewallMode defines model for ArtifactVersionMetadata.FirewallMode. 

const (
	ArtifactVersionMetadataFirewallModeALLOW ArtifactVersionMetadataFirewallMode = "ALLOW"
	ArtifactVersionMetadataFirewallModeBLOCK ArtifactVersionMetadataFirewallMode = "BLOCK"
	ArtifactVersionMetadataFirewallModeWARN  ArtifactVersionMetadataFirewallMode = "WARN"
)

Defines values for ArtifactVersionMetadataFirewallMode.

type ArtifactVersionMetadataScanStatus 

type ArtifactVersionMetadataScanStatus string

ArtifactVersionMetadataScanStatus defines model for ArtifactVersionMetadata.ScanStatus. 

const (
	ArtifactVersionMetadataScanStatusALLOWED ArtifactVersionMetadataScanStatus = "ALLOWED"
	ArtifactVersionMetadataScanStatusBLOCKED ArtifactVersionMetadataScanStatus = "BLOCKED"
	ArtifactVersionMetadataScanStatusWARN    ArtifactVersionMetadataScanStatus = "WARN"
)

Defines values for ArtifactVersionMetadataScanStatus.

type AuthType 

type AuthType string

AuthType Authentication type 

const (
	AuthTypeAccessKeySecretKey AuthType = "AccessKeySecretKey"
	AuthTypeAnonymous          AuthType = "Anonymous"
	AuthTypeUserPassword       AuthType = "UserPassword"
)

Defines values for AuthType.

type BadRequest 

type BadRequest = Error

BadRequest Standard error response with code, message and optional details

type CleanupPolicy 

type CleanupPolicy struct {
	ExpireDays    *int      `json:"expireDays,omitempty"`
	Name          *string   `json:"name,omitempty"`
	PackagePrefix *[]string `json:"packagePrefix,omitempty"`
	VersionPrefix *[]string `json:"versionPrefix,omitempty"`
}

CleanupPolicy Cleanup Policy for Harness Artifact Registries

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) GetAllArtifactVersions 

func (c *Client) GetAllArtifactVersions(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, params *GetAllArtifactVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllArtifactsByRegistry 

func (c *Client) GetAllArtifactsByRegistry(ctx context.Context, registryRef RegistryRefPathParam, params *GetAllArtifactsByRegistryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllRegistries 

func (c *Client) GetAllRegistries(ctx context.Context, spaceRef SpaceRefPathParam, params *GetAllRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetArtifactFiles 

func (c *Client) GetArtifactFiles(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, version VersionPathParam, params *GetArtifactFilesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRegistry 

func (c *Client) GetRegistry(ctx context.Context, registryRef RegistryRefPathParam, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetRegistry request
	GetRegistry(ctx context.Context, registryRef RegistryRefPathParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetArtifactFiles request
	GetArtifactFiles(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, version VersionPathParam, params *GetArtifactFilesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllArtifactVersions request
	GetAllArtifactVersions(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, params *GetAllArtifactVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllArtifactsByRegistry request
	GetAllArtifactsByRegistry(ctx context.Context, registryRef RegistryRefPathParam, params *GetAllArtifactsByRegistryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllRegistries request
	GetAllRegistries(ctx context.Context, spaceRef SpaceRefPathParam, params *GetAllRegistriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

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) GetAllArtifactVersionsWithResponse 

func (c *ClientWithResponses) GetAllArtifactVersionsWithResponse(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, params *GetAllArtifactVersionsParams, reqEditors ...RequestEditorFn) (*GetAllArtifactVersionsResponse, error)

GetAllArtifactVersionsWithResponse request returning *GetAllArtifactVersionsResponse

func (*ClientWithResponses) GetAllArtifactsByRegistryWithResponse 

func (c *ClientWithResponses) GetAllArtifactsByRegistryWithResponse(ctx context.Context, registryRef RegistryRefPathParam, params *GetAllArtifactsByRegistryParams, reqEditors ...RequestEditorFn) (*GetAllArtifactsByRegistryResponse, error)

GetAllArtifactsByRegistryWithResponse request returning *GetAllArtifactsByRegistryResponse

func (*ClientWithResponses) GetAllRegistriesWithResponse 

func (c *ClientWithResponses) GetAllRegistriesWithResponse(ctx context.Context, spaceRef SpaceRefPathParam, params *GetAllRegistriesParams, reqEditors ...RequestEditorFn) (*GetAllRegistriesResponse, error)

GetAllRegistriesWithResponse request returning *GetAllRegistriesResponse

func (*ClientWithResponses) GetArtifactFilesWithResponse 

func (c *ClientWithResponses) GetArtifactFilesWithResponse(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, version VersionPathParam, params *GetArtifactFilesParams, reqEditors ...RequestEditorFn) (*GetArtifactFilesResponse, error)

GetArtifactFilesWithResponse request returning *GetArtifactFilesResponse

func (*ClientWithResponses) GetRegistryWithResponse 

func (c *ClientWithResponses) GetRegistryWithResponse(ctx context.Context, registryRef RegistryRefPathParam, reqEditors ...RequestEditorFn) (*GetRegistryResponse, error)

GetRegistryWithResponse request returning *GetRegistryResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetRegistryWithResponse request
	GetRegistryWithResponse(ctx context.Context, registryRef RegistryRefPathParam, reqEditors ...RequestEditorFn) (*GetRegistryResponse, error)

	// GetArtifactFilesWithResponse request
	GetArtifactFilesWithResponse(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, version VersionPathParam, params *GetArtifactFilesParams, reqEditors ...RequestEditorFn) (*GetArtifactFilesResponse, error)

	// GetAllArtifactVersionsWithResponse request
	GetAllArtifactVersionsWithResponse(ctx context.Context, registryRef RegistryRefPathParam, artifact ArtifactPathParam, params *GetAllArtifactVersionsParams, reqEditors ...RequestEditorFn) (*GetAllArtifactVersionsResponse, error)

	// GetAllArtifactsByRegistryWithResponse request
	GetAllArtifactsByRegistryWithResponse(ctx context.Context, registryRef RegistryRefPathParam, params *GetAllArtifactsByRegistryParams, reqEditors ...RequestEditorFn) (*GetAllArtifactsByRegistryResponse, error)

	// GetAllRegistriesWithResponse request
	GetAllRegistriesWithResponse(ctx context.Context, spaceRef SpaceRefPathParam, params *GetAllRegistriesParams, reqEditors ...RequestEditorFn) (*GetAllRegistriesResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DeploymentMetadata 

type DeploymentMetadata struct {
	NonProdEnvCount int `json:"nonProdEnvCount"`
	ProdEnvCount    int `json:"prodEnvCount"`
}

DeploymentMetadata defines model for DeploymentMetadata.

type Error 

type Error struct {
	// Code The HTTP error code
	Code string `json:"code"`

	// Details Additional context and details about the error.
	// May include field-specific validation errors or debugging information.
	Details *map[string]interface{} `json:"details,omitempty"`

	// Message Human-readable error message explaining what went wrong
	Message string `json:"message"`
}

Error Standard error response with code, message and optional details

type FileDetail 

type FileDetail struct {
	Checksums       []string `json:"checksums"`
	CreatedAt       string   `json:"createdAt"`
	DownloadCommand string   `json:"downloadCommand"`
	Name            string   `json:"name"`
	Path            string   `json:"path"`
	Size            string   `json:"size"`
}

FileDetail File Detail

type FileDetailResponse 

type FileDetailResponse struct {
	// Data A list of Harness Artifact Files
	Data ListFileDetail `json:"data"`

	// Status Request processing status indicator
	Status Status `json:"status"`
}

FileDetailResponse defines model for FileDetailResponse.

type GetAllArtifactVersionsParams 

type GetAllArtifactVersionsParams struct {
	// ArtifactType artifact type.
	ArtifactType *GetAllArtifactVersionsParamsArtifactType `form:"artifact_type,omitempty" json:"artifact_type,omitempty"`

	// Page Current page number
	Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`

	// Size Number of items per page
	Size *PageSize `form:"size,omitempty" json:"size,omitempty"`

	// SortOrder sortOrder
	SortOrder *SortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`

	// SortField sortField
	SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`

	// SearchTerm search Term.
	SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
}

GetAllArtifactVersionsParams defines parameters for GetAllArtifactVersions.

type GetAllArtifactVersionsParamsArtifactType 

type GetAllArtifactVersionsParamsArtifactType string

GetAllArtifactVersionsParamsArtifactType defines parameters for GetAllArtifactVersions. 

const (
	GetAllArtifactVersionsParamsArtifactTypeDataset GetAllArtifactVersionsParamsArtifactType = "dataset"
	GetAllArtifactVersionsParamsArtifactTypeModel   GetAllArtifactVersionsParamsArtifactType = "model"
)

Defines values for GetAllArtifactVersionsParamsArtifactType.

type GetAllArtifactVersionsResponse 

type GetAllArtifactVersionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListArtifactVersionResponse
	JSON400      *BadRequest
	JSON401      *Unauthenticated
	JSON403      *Unauthorized
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetAllArtifactVersionsResponse 

func ParseGetAllArtifactVersionsResponse(rsp *http.Response) (*GetAllArtifactVersionsResponse, error)

ParseGetAllArtifactVersionsResponse parses an HTTP response from a GetAllArtifactVersionsWithResponse call

func (GetAllArtifactVersionsResponse) Status 

func (r GetAllArtifactVersionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllArtifactVersionsResponse) StatusCode 

func (r GetAllArtifactVersionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllArtifactsByRegistryParams 

type GetAllArtifactsByRegistryParams struct {
	// Label Label.
	Label *LabelsParam `form:"label,omitempty" json:"label,omitempty"`

	// Page Current page number
	Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`

	// Size Number of items per page
	Size *PageSize `form:"size,omitempty" json:"size,omitempty"`

	// SortOrder sortOrder
	SortOrder *SortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`

	// SortField sortField
	SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`

	// SearchTerm search Term.
	SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`

	// ArtifactType artifact type.
	ArtifactType *GetAllArtifactsByRegistryParamsArtifactType `form:"artifact_type,omitempty" json:"artifact_type,omitempty"`
}

GetAllArtifactsByRegistryParams defines parameters for GetAllArtifactsByRegistry.

type GetAllArtifactsByRegistryParamsArtifactType 

type GetAllArtifactsByRegistryParamsArtifactType string

GetAllArtifactsByRegistryParamsArtifactType defines parameters for GetAllArtifactsByRegistry. 

const (
	Dataset GetAllArtifactsByRegistryParamsArtifactType = "dataset"
	Model   GetAllArtifactsByRegistryParamsArtifactType = "model"
)

Defines values for GetAllArtifactsByRegistryParamsArtifactType.

type GetAllArtifactsByRegistryResponse 

type GetAllArtifactsByRegistryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListRegistryArtifactResponse
	JSON400      *BadRequest
	JSON401      *Unauthenticated
	JSON403      *Unauthorized
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetAllArtifactsByRegistryResponse 

func ParseGetAllArtifactsByRegistryResponse(rsp *http.Response) (*GetAllArtifactsByRegistryResponse, error)

ParseGetAllArtifactsByRegistryResponse parses an HTTP response from a GetAllArtifactsByRegistryWithResponse call

func (GetAllArtifactsByRegistryResponse) Status 

func (r GetAllArtifactsByRegistryResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllArtifactsByRegistryResponse) StatusCode 

func (r GetAllArtifactsByRegistryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllRegistriesParams 

type GetAllRegistriesParams struct {
	// PackageType Registry Package Type
	PackageType *PackageTypeParam `form:"package_type,omitempty" json:"package_type,omitempty"`

	// Type Registry Type
	Type *GetAllRegistriesParamsType `form:"type,omitempty" json:"type,omitempty"`

	// Page Current page number
	Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`

	// Size Number of items per page
	Size *PageSize `form:"size,omitempty" json:"size,omitempty"`

	// SortOrder sortOrder
	SortOrder *SortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`

	// SortField sortField
	SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`

	// SearchTerm search Term.
	SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`

	// Recursive Whether to list registries recursively.
	//
	// **Deprecated.** Use the new `scope` parameter.
	//
	// * `recursive=true`  → `scope=ancestors`
	// * `recursive=false` → `scope=none`
	Recursive *RecursiveParam `form:"recursive,omitempty" json:"recursive,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 *GetAllRegistriesParamsScope `form:"scope,omitempty" json:"scope,omitempty"`
}

GetAllRegistriesParams defines parameters for GetAllRegistries.

type GetAllRegistriesParamsScope 

type GetAllRegistriesParamsScope string

GetAllRegistriesParamsScope defines parameters for GetAllRegistries. 

const (
	GetAllRegistriesParamsScopeAncestors   GetAllRegistriesParamsScope = "ancestors"
	GetAllRegistriesParamsScopeDescendants GetAllRegistriesParamsScope = "descendants"
	GetAllRegistriesParamsScopeNone        GetAllRegistriesParamsScope = "none"
)

Defines values for GetAllRegistriesParamsScope.

type GetAllRegistriesParamsType 

type GetAllRegistriesParamsType string

GetAllRegistriesParamsType defines parameters for GetAllRegistries. 

const (
	UPSTREAM GetAllRegistriesParamsType = "UPSTREAM"
	VIRTUAL  GetAllRegistriesParamsType = "VIRTUAL"
)

Defines values for GetAllRegistriesParamsType.

type GetAllRegistriesResponse 

type GetAllRegistriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListRegistryResponse
	JSON400      *BadRequest
	JSON401      *Unauthenticated
	JSON403      *Unauthorized
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetAllRegistriesResponse 

func ParseGetAllRegistriesResponse(rsp *http.Response) (*GetAllRegistriesResponse, error)

ParseGetAllRegistriesResponse parses an HTTP response from a GetAllRegistriesWithResponse call

func (GetAllRegistriesResponse) Status 

func (r GetAllRegistriesResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllRegistriesResponse) StatusCode 

func (r GetAllRegistriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetArtifactFilesParams 

type GetArtifactFilesParams struct {
	// ArtifactType artifact type.
	ArtifactType *GetArtifactFilesParamsArtifactType `form:"artifact_type,omitempty" json:"artifact_type,omitempty"`

	// Page Current page number
	Page *PageNumber `form:"page,omitempty" json:"page,omitempty"`

	// Size Number of items per page
	Size *PageSize `form:"size,omitempty" json:"size,omitempty"`

	// SortOrder sortOrder
	SortOrder *SortOrder `form:"sort_order,omitempty" json:"sort_order,omitempty"`

	// SortField sortField
	SortField *SortField `form:"sort_field,omitempty" json:"sort_field,omitempty"`

	// SearchTerm search Term.
	SearchTerm *SearchTerm `form:"search_term,omitempty" json:"search_term,omitempty"`
}

GetArtifactFilesParams defines parameters for GetArtifactFiles.

type GetArtifactFilesParamsArtifactType 

type GetArtifactFilesParamsArtifactType string

GetArtifactFilesParamsArtifactType defines parameters for GetArtifactFiles. 

const (
	GetArtifactFilesParamsArtifactTypeDataset GetArtifactFilesParamsArtifactType = "dataset"
	GetArtifactFilesParamsArtifactTypeModel   GetArtifactFilesParamsArtifactType = "model"
)

Defines values for GetArtifactFilesParamsArtifactType.

type GetArtifactFilesResponse 

type GetArtifactFilesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *FileDetailResponse
	JSON400      *BadRequest
	JSON401      *Unauthenticated
	JSON403      *Unauthorized
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetArtifactFilesResponse 

func ParseGetArtifactFilesResponse(rsp *http.Response) (*GetArtifactFilesResponse, error)

ParseGetArtifactFilesResponse parses an HTTP response from a GetArtifactFilesWithResponse call

func (GetArtifactFilesResponse) Status 

func (r GetArtifactFilesResponse) Status() string

Status returns HTTPResponse.Status

func (GetArtifactFilesResponse) StatusCode 

func (r GetArtifactFilesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRegistryResponse 

type GetRegistryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RegistryResponse
	JSON400      *BadRequest
	JSON401      *Unauthenticated
	JSON403      *Unauthorized
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetRegistryResponse 

func ParseGetRegistryResponse(rsp *http.Response) (*GetRegistryResponse, error)

ParseGetRegistryResponse parses an HTTP response from a GetRegistryWithResponse call

func (GetRegistryResponse) Status 

func (r GetRegistryResponse) Status() string

Status returns HTTPResponse.Status

func (GetRegistryResponse) StatusCode 

func (r GetRegistryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InternalServerError 

type InternalServerError = Error

InternalServerError Standard error response with code, message and optional details

type LabelsParam 

type LabelsParam = []string

LabelsParam defines model for LabelsParam.

type ListArtifactVersion 

type ListArtifactVersion struct {
	// ArtifactVersions A list of Artifact versions
	ArtifactVersions *[]ArtifactVersionMetadata `json:"artifactVersions,omitempty"`

	// ItemCount The total number of items
	ItemCount *int64 `json:"itemCount,omitempty"`

	// PageCount The total number of pages
	PageCount *int64 `json:"pageCount,omitempty"`

	// PageIndex The current page
	PageIndex *int64 `json:"pageIndex,omitempty"`

	// PageSize The number of items per page
	PageSize *int `json:"pageSize,omitempty"`
}

ListArtifactVersion A list of Artifact versions

type ListArtifactVersionResponse 

type ListArtifactVersionResponse struct {
	// Data A list of Artifact versions
	Data ListArtifactVersion `json:"data"`

	// Status Request processing status indicator
	Status Status `json:"status"`
}

ListArtifactVersionResponse defines model for ListArtifactVersionResponse.

type ListFileDetail 

type ListFileDetail struct {
	// Files A list of Harness Artifact Files
	Files []FileDetail `json:"files"`

	// ItemCount The total number of items
	ItemCount *int64 `json:"itemCount,omitempty"`

	// PageCount The total number of pages
	PageCount *int64 `json:"pageCount,omitempty"`

	// PageIndex The current page
	PageIndex *int64 `json:"pageIndex,omitempty"`

	// PageSize The number of items per page
	PageSize *int `json:"pageSize,omitempty"`
}

ListFileDetail A list of Harness Artifact Files

type ListRegistry 

type ListRegistry struct {
	// ItemCount The total number of items
	ItemCount *int64 `json:"itemCount,omitempty"`

	// Meta Metadata about the list response
	Meta Meta `json:"meta"`

	// PageCount The total number of pages
	PageCount *int64 `json:"pageCount,omitempty"`

	// PageIndex The current page
	PageIndex *int64 `json:"pageIndex,omitempty"`

	// PageSize The number of items per page
	PageSize *int `json:"pageSize,omitempty"`

	// Registries A list of Harness Artifact Registries
	Registries []RegistryMetadata `json:"registries"`
}

ListRegistry A list of Harness Artifact Registries

type ListRegistryArtifact 

type ListRegistryArtifact struct {
	// Artifacts A list of Artifact
	Artifacts []RegistryArtifactMetadata `json:"artifacts"`

	// ItemCount The total number of items
	ItemCount *int64 `json:"itemCount,omitempty"`

	// PageCount The total number of pages
	PageCount *int64 `json:"pageCount,omitempty"`

	// PageIndex The current page
	PageIndex *int64 `json:"pageIndex,omitempty"`

	// PageSize The number of items per page
	PageSize *int `json:"pageSize,omitempty"`
}

ListRegistryArtifact A list of Artifacts

type ListRegistryArtifactResponse 

type ListRegistryArtifactResponse struct {
	// Data A list of Artifacts
	Data ListRegistryArtifact `json:"data"`

	// Status Request processing status indicator
	Status Status `json:"status"`
}

ListRegistryArtifactResponse defines model for ListRegistryArtifactResponse.

type ListRegistryResponse 

type ListRegistryResponse struct {
	// Data A list of Harness Artifact Registries
	Data ListRegistry `json:"data"`

	// Status Request processing status indicator
	Status Status `json:"status"`
}

ListRegistryResponse defines model for ListRegistryResponse.

type Meta 

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 NotFound 

type NotFound = Error

NotFound Standard error response with code, message and optional details

type PackageType 

type PackageType string

PackageType refers to package 

const (
	CARGO       PackageType = "CARGO"
	COMPOSER    PackageType = "COMPOSER"
	CONDA       PackageType = "CONDA"
	DART        PackageType = "DART"
	DOCKER      PackageType = "DOCKER"
	GENERIC     PackageType = "GENERIC"
	GO          PackageType = "GO"
	HELM        PackageType = "HELM"
	HUGGINGFACE PackageType = "HUGGINGFACE"
	MAVEN       PackageType = "MAVEN"
	NPM         PackageType = "NPM"
	NUGET       PackageType = "NUGET"
	PYTHON      PackageType = "PYTHON"
	RAW         PackageType = "RAW"
	RPM         PackageType = "RPM"
	SWIFT       PackageType = "SWIFT"
)

Defines values for PackageType.

type PackageTypeParam 

type PackageTypeParam = []string

PackageTypeParam defines model for packageTypeParam.

type PageNumber 

type PageNumber = int64

PageNumber defines model for pageNumber.

type PageSize 

type PageSize = int64

PageSize defines model for pageSize.

type RecursiveParam 

type RecursiveParam = bool

RecursiveParam defines model for recursiveParam.

type Registry 

type Registry struct {
	AllowedPattern *[]string        `json:"allowedPattern,omitempty"`
	BlockedPattern *[]string        `json:"blockedPattern,omitempty"`
	CleanupPolicy  *[]CleanupPolicy `json:"cleanupPolicy,omitempty"`

	// Config SubConfig specific for Virtual or Upstream Registry
	Config    *RegistryConfig `json:"config,omitempty"`
	CreatedAt *string         `json:"createdAt,omitempty"`

	// DeletedAt Timestamp in milliseconds when the artifact was soft deleted. Null if not deleted.
	DeletedAt   *string   `json:"deletedAt,omitempty"`
	Description *string   `json:"description,omitempty"`
	Identifier  string    `json:"identifier"`
	IsPublic    bool      `json:"isPublic"`
	Labels      *[]string `json:"labels,omitempty"`
	ModifiedAt  *string   `json:"modifiedAt,omitempty"`

	// PackageType refers to package
	PackageType PackageType `json:"packageType"`
	PolicyRefs  *[]string   `json:"policyRefs,omitempty"`
	Scanners    *[]Scanner  `json:"scanners,omitempty"`
	Url         string      `json:"url"`
	Uuid        string      `json:"uuid"`
}

Registry Harness Artifact Registry

type RegistryArtifactMetadata 

type RegistryArtifactMetadata struct {
	// ArtifactType refers to artifact type
	ArtifactType *ArtifactType `json:"artifactType,omitempty"`

	// DeletedAt Timestamp in milliseconds when the registry was soft-deleted
	DeletedAt      *string `json:"deletedAt,omitempty"`
	DownloadsCount *int64  `json:"downloadsCount,omitempty"`

	// IsDeleted True if the registry is soft-deleted
	IsDeleted     bool      `json:"isDeleted"`
	IsPublic      bool      `json:"isPublic"`
	IsQuarantined *bool     `json:"isQuarantined,omitempty"`
	Labels        *[]string `json:"labels,omitempty"`
	LastModified  *string   `json:"lastModified,omitempty"`
	LatestVersion string    `json:"latestVersion"`
	Name          string    `json:"name"`

	// PackageType refers to package
	PackageType        PackageType `json:"packageType"`
	RegistryIdentifier string      `json:"registryIdentifier"`
	RegistryPath       string      `json:"registryPath"`
	RegistryUUID       string      `json:"registryUUID"`
	Uuid               string      `json:"uuid"`
}

RegistryArtifactMetadata Artifact Metadata

type RegistryConfig 

type RegistryConfig struct {
	// Type refers to type of registry i.e virtual or upstream
	Type RegistryType `json:"type"`
	// contains filtered or unexported fields
}

RegistryConfig SubConfig specific for Virtual or Upstream Registry

func (RegistryConfig) AsUpstreamConfig 

func (t RegistryConfig) AsUpstreamConfig() (UpstreamConfig, error)

AsUpstreamConfig returns the union data inside the RegistryConfig as a UpstreamConfig

func (RegistryConfig) AsVirtualConfig 

func (t RegistryConfig) AsVirtualConfig() (VirtualConfig, error)

AsVirtualConfig returns the union data inside the RegistryConfig as a VirtualConfig

func (RegistryConfig) Discriminator 

func (t RegistryConfig) Discriminator() (string, error)

func (*RegistryConfig) FromUpstreamConfig 

func (t *RegistryConfig) FromUpstreamConfig(v UpstreamConfig) error

FromUpstreamConfig overwrites any union data inside the RegistryConfig as the provided UpstreamConfig

func (*RegistryConfig) FromVirtualConfig 

func (t *RegistryConfig) FromVirtualConfig(v VirtualConfig) error

FromVirtualConfig overwrites any union data inside the RegistryConfig as the provided VirtualConfig

func (RegistryConfig) MarshalJSON 

func (t RegistryConfig) MarshalJSON() ([]byte, error)

func (*RegistryConfig) MergeUpstreamConfig 

func (t *RegistryConfig) MergeUpstreamConfig(v UpstreamConfig) error

MergeUpstreamConfig performs a merge with any union data inside the RegistryConfig, using the provided UpstreamConfig

func (*RegistryConfig) MergeVirtualConfig 

func (t *RegistryConfig) MergeVirtualConfig(v VirtualConfig) error

MergeVirtualConfig performs a merge with any union data inside the RegistryConfig, using the provided VirtualConfig

func (*RegistryConfig) UnmarshalJSON 

func (t *RegistryConfig) UnmarshalJSON(b []byte) error

func (RegistryConfig) ValueByDiscriminator 

func (t RegistryConfig) ValueByDiscriminator() (interface{}, error)

type RegistryMetadata 

type RegistryMetadata struct {
	ArtifactsCount *int64 `json:"artifactsCount,omitempty"`

	// DeletedAt Timestamp in milliseconds when the registry was soft-deleted
	DeletedAt      *string `json:"deletedAt,omitempty"`
	Description    *string `json:"description,omitempty"`
	DownloadsCount *int64  `json:"downloadsCount,omitempty"`
	Identifier     string  `json:"identifier"`

	// IsDeleted True if the registry is soft-deleted
	IsDeleted    bool    `json:"isDeleted"`
	IsPublic     bool    `json:"isPublic"`
	LastModified *string `json:"lastModified,omitempty"`

	// PackageType refers to package
	PackageType  PackageType `json:"packageType"`
	Path         *string     `json:"path,omitempty"`
	RegistrySize *string     `json:"registrySize,omitempty"`

	// Type refers to type of registry i.e virtual or upstream
	Type RegistryType `json:"type"`
	Url  string       `json:"url"`
	Uuid string       `json:"uuid"`
}

RegistryMetadata Harness Artifact Registry Metadata

type RegistryRefPathParam 

type RegistryRefPathParam = string

RegistryRefPathParam defines model for registryRefPathParam.

type RegistryResponse 

type RegistryResponse struct {
	// Data Harness Artifact Registry
	Data Registry `json:"data"`

	// Status Request processing status indicator
	Status Status `json:"status"`
}

RegistryResponse defines model for RegistryResponse.

type RegistryType 

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 

type RegistryTypeParam string

RegistryTypeParam defines model for RegistryTypeParam. 

const (
	RegistryTypeParamUPSTREAM RegistryTypeParam = "UPSTREAM"
	RegistryTypeParamVIRTUAL  RegistryTypeParam = "VIRTUAL"
)

Defines values for RegistryTypeParam.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Scanner 

type Scanner struct {
	Name *ScannerName `json:"name,omitempty"`
}

Scanner Scanner for Harness Artifact Registries

type ScannerName 

type ScannerName string

ScannerName defines model for Scanner.Name. 

const (
	AQUATRIVY ScannerName = "AQUA_TRIVY"
	GRYPE     ScannerName = "GRYPE"
)

Defines values for ScannerName.

type ScopeParam 

type ScopeParam string

ScopeParam defines model for scopeParam. 

const (
	ScopeParamAncestors   ScopeParam = "ancestors"
	ScopeParamDescendants ScopeParam = "descendants"
	ScopeParamNone        ScopeParam = "none"
)

Defines values for ScopeParam.

type SearchTerm 

type SearchTerm = string

SearchTerm defines model for searchTerm.

type SortField 

type SortField = string

SortField defines model for sortField.

type SortOrder 

type SortOrder = string

SortOrder defines model for sortOrder.

type SpaceRefPathParam 

type SpaceRefPathParam = string

SpaceRefPathParam defines model for spaceRefPathParam.

type Status 

type Status string

Status Request processing status indicator 

const (
	ERROR   Status = "ERROR"
	FAILURE Status = "FAILURE"
	SUCCESS Status = "SUCCESS"
)

Defines values for Status.

type Unauthenticated 

type Unauthenticated = Error

Unauthenticated Standard error response with code, message and optional details

type Unauthorized 

type Unauthorized = Error

Unauthorized Standard error response with code, message and optional details

type UpstreamConfig 

type UpstreamConfig struct {
	Auth *UpstreamConfig_Auth `json:"auth,omitempty"`

	// AuthType Authentication type
	AuthType AuthType `json:"authType"`

	// FirewallMode Firewall mode applied to an upstream proxy.
	FirewallMode *UpstreamProxyConfigFirewallMode `json:"firewallMode,omitempty"`

	// RemoteUrlSuffix Optional path suffix appended to the remote URL for this registry. For Python upstreams, this allows overriding the default `/simple` path used for PyPI-compatible indexes. Leading and trailing slashes are not required and will be normalized.
	RemoteUrlSuffix *string               `json:"remoteUrlSuffix,omitempty"`
	Source          *UpstreamConfigSource `json:"source,omitempty"`
	Url             *string               `json:"url,omitempty"`
}

UpstreamConfig Configuration for Harness Artifact UpstreamProxies

type UpstreamConfigSource 

type UpstreamConfigSource string

UpstreamConfigSource defines model for UpstreamConfig.Source. 

const (
	Anaconda     UpstreamConfigSource = "Anaconda"
	AwsEcr       UpstreamConfigSource = "AwsEcr"
	Crates       UpstreamConfigSource = "Crates"
	Custom       UpstreamConfigSource = "Custom"
	Dockerhub    UpstreamConfigSource = "Dockerhub"
	GoProxy      UpstreamConfigSource = "GoProxy"
	HuggingFace  UpstreamConfigSource = "HuggingFace"
	MavenCentral UpstreamConfigSource = "MavenCentral"
	NpmJs        UpstreamConfigSource = "NpmJs"
	NugetOrg     UpstreamConfigSource = "NugetOrg"
	Packagist    UpstreamConfigSource = "Packagist"
	Pubdev       UpstreamConfigSource = "Pubdev"
	PyPi         UpstreamConfigSource = "PyPi"
)

Defines values for UpstreamConfigSource.

type UpstreamConfig_Auth 

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

UpstreamConfig_Auth defines model for UpstreamConfig.Auth.

func (UpstreamConfig_Auth) AsAccessKeySecretKey 

func (t UpstreamConfig_Auth) AsAccessKeySecretKey() (AccessKeySecretKey, error)

AsAccessKeySecretKey returns the union data inside the UpstreamConfig_Auth as a AccessKeySecretKey

func (UpstreamConfig_Auth) AsAnonymous 

func (t UpstreamConfig_Auth) AsAnonymous() (Anonymous, error)

AsAnonymous returns the union data inside the UpstreamConfig_Auth as a Anonymous

func (UpstreamConfig_Auth) AsUserPassword 

func (t UpstreamConfig_Auth) AsUserPassword() (UserPassword, error)

AsUserPassword returns the union data inside the UpstreamConfig_Auth as a UserPassword

func (*UpstreamConfig_Auth) FromAccessKeySecretKey 

func (t *UpstreamConfig_Auth) FromAccessKeySecretKey(v AccessKeySecretKey) error

FromAccessKeySecretKey overwrites any union data inside the UpstreamConfig_Auth as the provided AccessKeySecretKey

func (*UpstreamConfig_Auth) FromAnonymous 

func (t *UpstreamConfig_Auth) FromAnonymous(v Anonymous) error

FromAnonymous overwrites any union data inside the UpstreamConfig_Auth as the provided Anonymous

func (*UpstreamConfig_Auth) FromUserPassword 

func (t *UpstreamConfig_Auth) FromUserPassword(v UserPassword) error

FromUserPassword overwrites any union data inside the UpstreamConfig_Auth as the provided UserPassword

func (UpstreamConfig_Auth) MarshalJSON 

func (t UpstreamConfig_Auth) MarshalJSON() ([]byte, error)

func (*UpstreamConfig_Auth) MergeAccessKeySecretKey 

func (t *UpstreamConfig_Auth) MergeAccessKeySecretKey(v AccessKeySecretKey) error

MergeAccessKeySecretKey performs a merge with any union data inside the UpstreamConfig_Auth, using the provided AccessKeySecretKey

func (*UpstreamConfig_Auth) MergeAnonymous 

func (t *UpstreamConfig_Auth) MergeAnonymous(v Anonymous) error

MergeAnonymous performs a merge with any union data inside the UpstreamConfig_Auth, using the provided Anonymous

func (*UpstreamConfig_Auth) MergeUserPassword 

func (t *UpstreamConfig_Auth) MergeUserPassword(v UserPassword) error

MergeUserPassword performs a merge with any union data inside the UpstreamConfig_Auth, using the provided UserPassword

func (*UpstreamConfig_Auth) UnmarshalJSON 

func (t *UpstreamConfig_Auth) UnmarshalJSON(b []byte) error

type UpstreamProxyConfigFirewallMode 

type UpstreamProxyConfigFirewallMode string

UpstreamProxyConfigFirewallMode Firewall mode applied to an upstream proxy. 

const (
	ALLOW UpstreamProxyConfigFirewallMode = "ALLOW"
	BLOCK UpstreamProxyConfigFirewallMode = "BLOCK"
	WARN  UpstreamProxyConfigFirewallMode = "WARN"
)

Defines values for UpstreamProxyConfigFirewallMode.

type UserPassword 

type UserPassword struct {
	SecretIdentifier *string `json:"secretIdentifier,omitempty"`
	SecretSpaceId    *int    `json:"secretSpaceId,omitempty"`
	SecretSpacePath  *string `json:"secretSpacePath,omitempty"`
	UserName         string  `json:"userName"`
}

UserPassword defines model for UserPassword.

type VersionPathParam 

type VersionPathParam = string

VersionPathParam defines model for versionPathParam.

type VirtualConfig 

type VirtualConfig struct {
	UpstreamProxies *[]string `json:"upstreamProxies,omitempty"`
}

VirtualConfig Configuration for Harness Virtual Artifact Registries

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.