apiv2

package
v3.3.0 Latest Latest
Warning

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

 Go to latest Published: May 6, 2021 License: MIT Imports: 17 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client interface {
	user.Client
	project.Client
	registry.Client
	replication.Client
	system.Client
	retention.Client
	quota.Client
}

type RESTClient 

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

RESTClient implements the Client interface as a REST client

func NewRESTClient 

func NewRESTClient(legacyClient *client.Harbor, v2Client *v2client.Harbor, authInfo runtime.ClientAuthInfoWriter) *RESTClient

NewRESTClient constructs a new REST client containing each sub client.

func NewRESTClientForHost 

func NewRESTClientForHost(u, username, password string) (*RESTClient, error)

NewRESTClientForHost constructs a new REST client containing a swagger API client using the defined host string and basePath, the additional Harbor v2 API suffix as well as basic auth info.

func (*RESTClient) AddProjectMember 

func (c *RESTClient) AddProjectMember(ctx context.Context, p *modelv2.Project, u *legacymodel.User, roleID int) error

AddProjectMember wraps the AddProjectMember method of the project sub-package.

func (*RESTClient) AddProjectMetadata 

func (c *RESTClient) AddProjectMetadata(ctx context.Context, p *modelv2.Project, key project.MetadataKey, value string) error

AddProjectMetadata wraps the AddProjectMetadata method of the project sub-package.

func (*RESTClient) AddProjectRobot added in v3.0.5 

func (c *RESTClient) AddProjectRobot(ctx context.Context, p *modelv2.Project, robot *legacymodel.RobotAccountCreate) (string, error)

AddProjectRobot wraps the AddProjectRobot method of the project sub-package.

func (*RESTClient) AddProjectWebhookPolicy added in v3.3.0 

func (c *RESTClient) AddProjectWebhookPolicy(ctx context.Context, p *modelv2.Project, policy *legacymodel.WebhookPolicy) error

AddProjectWebhookPolicy wraps the AddProjectWebhookPolicy method of the project sub-package.

func (*RESTClient) DeleteProject 

func (c *RESTClient) DeleteProject(ctx context.Context, p *modelv2.Project) error

DeleteProject wraps the DeleteProject method of the project sub-package.

func (*RESTClient) DeleteProjectMember 

func (c *RESTClient) DeleteProjectMember(ctx context.Context, p *modelv2.Project, u *legacymodel.User) error

DeleteProjectMember wraps the DeleteProjectMember method of the project sub-package.

func (*RESTClient) DeleteProjectMetadataValue 

func (c *RESTClient) DeleteProjectMetadataValue(ctx context.Context, p *modelv2.Project, key project.MetadataKey) error

DeleteProjectMetadataValue wraps the DeleteProjectMetadataValue method of the project sub-package.

func (*RESTClient) DeleteProjectRobot added in v3.0.5 

func (c *RESTClient) DeleteProjectRobot(ctx context.Context, p *modelv2.Project, robotID int) error

DeleteProjectRobot wraps the DeleteProjectRobot method of the project sub-package.

func (*RESTClient) DeleteProjectWebhookPolicy added in v3.3.0 

func (c *RESTClient) DeleteProjectWebhookPolicy(ctx context.Context, p *modelv2.Project, policyID int) error

DeleteProjectWebhookPolicy wraps the DeleteProjectWebhookPolicy method of the project sub-package.

func (*RESTClient) DeleteRegistry 

func (c *RESTClient) DeleteRegistry(ctx context.Context, r *legacymodel.Registry) error

DeleteRegistry wraps the DeleteRegistry method of the registry sub-package.

func (*RESTClient) DeleteReplicationPolicy 

func (c *RESTClient) DeleteReplicationPolicy(ctx context.Context, r *legacymodel.ReplicationPolicy) error

DeleteReplicationPolicy wraps the DeleteReplicationPolicy method of the replication sub-package.

func (*RESTClient) DeleteUser 

func (c *RESTClient) DeleteUser(ctx context.Context, u *legacymodel.User) error

DeleteUser wraps the DeleteUser method of the user sub-package.

func (*RESTClient) DisableRetentionPolicy added in v3.1.0 

func (c *RESTClient) DisableRetentionPolicy(ctx context.Context, ret *legacymodel.RetentionPolicy) error

DisableRetentionPolicy wraps the DisableRetentionPolicy method of the retention sub-package.

func (*RESTClient) GetProjectByID 

func (c *RESTClient) GetProjectByID(ctx context.Context, projectID int64) (*modelv2.Project, error)

GetProjectByID wraps the GetProjectByID method of the project sub-package.

func (*RESTClient) GetProjectByName 

func (c *RESTClient) GetProjectByName(ctx context.Context, name string) (*modelv2.Project, error)

GetProjectByName wraps the GetProjectByName method of the project sub-package.

func (*RESTClient) GetProjectMetadataValue 

func (c *RESTClient) GetProjectMetadataValue(ctx context.Context, projectID int64, key project.MetadataKey) (string, error)

GetProjectMetadataValue wraps the GetProjectMetadataValue method of the project sub-package.

func (*RESTClient) GetQuotaByProjectID added in v3.2.0 

func (c *RESTClient) GetQuotaByProjectID(ctx context.Context, projectID int64) (*legacymodel.Quota, error)

GetQuotaByProjectID wraps the GetQuotaByProjectID method of the quota sub-package.

func (*RESTClient) GetRegistry 

func (c *RESTClient) GetRegistry(ctx context.Context, name string) (*legacymodel.Registry, error)

GetRegistry wraps the GetRegistry method of the registry sub-package.

func (*RESTClient) GetReplicationExecutionByID added in v3.0.3 

func (c *RESTClient) GetReplicationExecutionByID(ctx context.Context, id int64) (*legacymodel.ReplicationExecution, error)

GetReplicationExecutionsByID wraps the GetReplicationExecutionsByID method of the replication sub-package.

func (*RESTClient) GetReplicationExecutions 

func (c *RESTClient) GetReplicationExecutions(ctx context.Context,
	r *legacymodel.ReplicationExecution) ([]*legacymodel.ReplicationExecution, error)

GetReplicationExecutions wraps the GetReplicationExecutions method of the replication sub-package.

func (*RESTClient) GetReplicationPolicy 

func (c *RESTClient) GetReplicationPolicy(ctx context.Context, name string) (*legacymodel.ReplicationPolicy, error)

GetReplicationPolicy wraps the GetReplicationPolicy method of the replication sub-package.

func (*RESTClient) GetReplicationPolicyByID 

func (c *RESTClient) GetReplicationPolicyByID(ctx context.Context, id int64) (*legacymodel.ReplicationPolicy, error)

GetReplicationPolicyByID wraps the GetReplicationPolicyByID method of the replication sub-package.

func (*RESTClient) GetRetentionPolicyByID added in v3.1.2 

func (c *RESTClient) GetRetentionPolicyByID(ctx context.Context, id int64) (*legacymodel.RetentionPolicy, error)

GetRetentionPolicyByID wraps the GetRetentionPolicyByID method of the retention sub-package.

func (*RESTClient) GetRetentionPolicyByProject 

func (c *RESTClient) GetRetentionPolicyByProject(ctx context.Context, project *modelv2.Project) (*legacymodel.RetentionPolicy, error)

GetRetentionPolicyByProjectID wraps the GetRetentionPolicyByProject method of the retention sub-package.

func (*RESTClient) GetSystemGarbageCollection 

func (c *RESTClient) GetSystemGarbageCollection(ctx context.Context) (*legacymodel.AdminJobSchedule, error)

GetSystemGarbageCollection wraps the GetSystemGarbageCollection method of the system sub-package.

func (*RESTClient) GetUser 

func (c *RESTClient) GetUser(ctx context.Context, username string) (*legacymodel.User, error)

GetUser wraps the GetUser method of the user sub-package.

func (*RESTClient) GetUserByID added in v3.2.2 

func (c *RESTClient) GetUserByID(ctx context.Context, id int64) (*legacymodel.User, error)

GetUserByID wraps the GetUserByID method of the user sub-package.

func (*RESTClient) Health added in v3.2.1 

func (c *RESTClient) Health(ctx context.Context) (*legacymodel.OverallHealthStatus, error)

Health wraps the Health method of the system sub-package.

func (*RESTClient) ListProjectMembers 

func (c *RESTClient) ListProjectMembers(ctx context.Context, p *modelv2.Project) ([]*legacymodel.ProjectMemberEntity, error)

ListProjectMembers wraps the ListProjectMembers method of the project sub-package.

func (*RESTClient) ListProjectMetadata 

func (c *RESTClient) ListProjectMetadata(ctx context.Context, p *modelv2.Project) (*modelv2.ProjectMetadata, error)

ListProjectMetadata wraps the ListProjectMetadata method of the project sub-package.

func (*RESTClient) ListProjectRobots added in v3.0.5 

func (c *RESTClient) ListProjectRobots(ctx context.Context, p *modelv2.Project) ([]*legacymodel.RobotAccount, error)

ListProjectRobots wraps the ListProjectRobots method of the project sub-package.

func (*RESTClient) ListProjectWebhookPolicies added in v3.3.0 

func (c *RESTClient) ListProjectWebhookPolicies(ctx context.Context, p *modelv2.Project) ([]*legacymodel.WebhookPolicy, error)

ListProjectWebhookPolicies wraps the ListProjectWebhookPolicies method of the project sub-package.

func (*RESTClient) ListProjects 

func (c *RESTClient) ListProjects(ctx context.Context, nameFilter string) ([]*modelv2.Project, error)

ListProjects wraps the ListProjects method of the project sub-package.

func (*RESTClient) NewProject 

func (c *RESTClient) NewProject(ctx context.Context, name string, storageLimit *int64) (*modelv2.Project, error)

NewProject wraps the NewProject method of the project sub-package.

func (*RESTClient) NewRegistry 

func (c *RESTClient) NewRegistry(ctx context.Context, name, registryType, url string,
	credential *legacymodel.RegistryCredential, insecure bool) (*legacymodel.Registry, error)

NewRegistry wraps the NewRegistry method of the registry sub-package.

func (*RESTClient) NewReplicationPolicy 

func (c *RESTClient) NewReplicationPolicy(ctx context.Context, destRegistry, srcRegistry *legacymodel.Registry,
	replicateDeletion, override, enablePolicy bool, filters []*legacymodel.ReplicationFilter,
	trigger *legacymodel.ReplicationTrigger, destNamespace, description, name string) (*legacymodel.ReplicationPolicy, error)

NewReplicationPolicy wraps the NewReplicationPolicy method of the replication sub-package.

func (*RESTClient) NewRetentionPolicy 

func (c *RESTClient) NewRetentionPolicy(ctx context.Context, ret *legacymodel.RetentionPolicy) error

NewRetentionPolicy wraps the NewRetentionPolicy method of the retention sub-package.

func (*RESTClient) NewSystemGarbageCollection 

func (c *RESTClient) NewSystemGarbageCollection(ctx context.Context,
	cron, scheduleType string) (*legacymodel.AdminJobSchedule, error)

NewSystemGarbageCollection wraps the NewSystemGarbageCollection method of the system sub-package.

func (*RESTClient) NewUser 

func (c *RESTClient) NewUser(ctx context.Context, username, email, realname, password, comments string) (*legacymodel.User, error)

NewUser wraps the NewUser method of the user sub-package.

func (*RESTClient) ResetSystemGarbageCollection 

func (c *RESTClient) ResetSystemGarbageCollection(ctx context.Context) error

ResetSystemGarbageCollection wraps the ResetSystemGarbageCollection method of the system sub-package.

func (*RESTClient) TriggerReplicationExecution 

func (c *RESTClient) TriggerReplicationExecution(ctx context.Context, r *legacymodel.ReplicationExecution) error

TriggerReplicationExecution wraps the TriggerReplicationExecution method of the replication sub-package.

func (*RESTClient) UpdateProject 

func (c *RESTClient) UpdateProject(ctx context.Context, p *modelv2.Project, storageLimit *int64) error

UpdateProject wraps the ListProjects method of the project sub-package.

func (*RESTClient) UpdateProjectMemberRole 

func (c *RESTClient) UpdateProjectMemberRole(ctx context.Context, p *modelv2.Project, u *legacymodel.User, roleID int) error

UpdateProjectMemberRole wraps the UpdateProjectMemberRole method of the project sub-package.

func (*RESTClient) UpdateProjectMetadata 

func (c *RESTClient) UpdateProjectMetadata(ctx context.Context, p *modelv2.Project, key project.MetadataKey, value string) error

UpdateProjectMetadata wraps the UpdateProjectMetadata method of the project sub-package.

func (*RESTClient) UpdateProjectRobot added in v3.0.5 

func (c *RESTClient) UpdateProjectRobot(ctx context.Context, p *modelv2.Project, robotID int, robot *legacymodel.RobotAccountUpdate) error

UpdateProjectRobot wraps the UpdateProjectRobot method of the project sub-package.

func (*RESTClient) UpdateProjectWebhookPolicy added in v3.3.0 

func (c *RESTClient) UpdateProjectWebhookPolicy(ctx context.Context, p *modelv2.Project, policyID int, policy *legacymodel.WebhookPolicy) error

UpdateProjectWebhookPolicy wraps the UpdateProjectWebhookPolicy method of the project sub-package.

func (*RESTClient) UpdateRegistry 

func (c *RESTClient) UpdateRegistry(ctx context.Context, r *legacymodel.Registry) error

UpdateRegistry wraps the UpdateRegistry method of the registry sub-package.

func (*RESTClient) UpdateReplicationPolicy 

func (c *RESTClient) UpdateReplicationPolicy(ctx context.Context, r *legacymodel.ReplicationPolicy) error

UpdateReplicationPolicy wraps the UpdateReplicationPolicy method of the replication sub-package.

func (*RESTClient) UpdateRetentionPolicy added in v3.1.0 

func (c *RESTClient) UpdateRetentionPolicy(ctx context.Context, ret *legacymodel.RetentionPolicy) error

UpdateRetentionPolicy wraps the UpdateRetentionPolicy method of the retention sub-package.

func (*RESTClient) UpdateStorageQuotaByProjectID added in v3.2.0 

func (c *RESTClient) UpdateStorageQuotaByProjectID(ctx context.Context, projectID int64, storageLimit int64) error

UpdateStorageQuotaByProjectID wraps the UpdateStorageQuotaByProjectID method of the quota sub-package.

func (*RESTClient) UpdateSystemGarbageCollection 

func (c *RESTClient) UpdateSystemGarbageCollection(ctx context.Context,
	newGcSchedule *legacymodel.AdminJobScheduleObj) error

UpdateSystemGarbageCollection wraps the UpdateSystemGarbageCollection method of the system sub-package.

func (*RESTClient) UpdateUser 

func (c *RESTClient) UpdateUser(ctx context.Context, u *legacymodel.User) error

UpdateUser wraps the UpdateUser method of the user sub-package.

func (*RESTClient) UpdateUserPassword 

func (c *RESTClient) UpdateUserPassword(ctx context.Context, id int64, password *legacymodel.Password) error

UpdateUserPassword wraps the UpdateUserPassword method of the user sub-package.

func (*RESTClient) UserExists added in v3.2.1 

func (c *RESTClient) UserExists(ctx context.Context, u *legacymodel.User) (bool, error)

UserExists wraps the UserExists method of the user sub-package.

Source Files

View all Source files

Directories

Path Synopsis
internal
api/client
api/client/artifact
api/client/auditlog
api/client/icon
api/client/preheat
api/client/project
api/client/repository
api/client/scan
legacyapi/client
legacyapi/client/products
legacyapi/client/scanners
legacy

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.