client

Documentation

Index

• Constants
• Variables
• type Harbor
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Harbor
  • func NewHTTPClient(formats strfmt.Registry) *Harbor
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Harbor
  • func (c *Harbor) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api/v2.0"
)

Variables

var Default = NewHTTPClient(nil)

Default harbor HTTP client.

var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type Harbor

type Harbor struct {
	Artifact artifact.ClientService

	Auditlog auditlog.ClientService

	Configure configure.ClientService

	GC gc.ClientService

	Health health.ClientService

	Icon icon.ClientService

	Immutable immutable.ClientService

	Jobservice jobservice.ClientService

	Label label.ClientService

	Ldap ldap.ClientService

	Member member.ClientService

	OIDC oidc.ClientService

	Ping ping.ClientService

	Preheat preheat.ClientService

	Project project.ClientService

	ProjectMetadata project_metadata.ClientService

	Purge purge.ClientService

	Quota quota.ClientService

	Registry registry.ClientService

	Replication replication.ClientService

	Repository repository.ClientService

	Retention retention.ClientService

	Robot robot.ClientService

	Robotv1 robotv1.ClientService

	Scan scan.ClientService

	ScanAll scan_all.ClientService

	ScanDataExport scan_data_export.ClientService

	Scanner scanner.ClientService

	Schedule schedule.ClientService

	Search search.ClientService

	Securityhub securityhub.ClientService

	Statistic statistic.ClientService

	SystemCVEAllowlist system_cve_allowlist.ClientService

	Systeminfo systeminfo.ClientService

	User user.ClientService

	Usergroup usergroup.ClientService

	Webhook webhook.ClientService

	Webhookjob webhookjob.ClientService

	Transport runtime.ClientTransport
}

Harbor is a client for harbor

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Harbor

New creates a new harbor client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Harbor

NewHTTPClient creates a new harbor HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Harbor

NewHTTPClientWithConfig creates a new harbor HTTP client, using a customizable transport config.

func (*Harbor) SetTransport

func (c *Harbor) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.