Module: Harbor2Client

Defined in:
lib/harbor2_client/version.rb,
lib/harbor2_client.rb,
lib/harbor2_client/api_error.rb,
lib/harbor2_client/api/gc_api.rb,
lib/harbor2_client/api_client.rb,
lib/harbor2_client/models/tag.rb,
lib/harbor2_client/models/body.rb,
lib/harbor2_client/models/icon.rb,
lib/harbor2_client/models/task.rb,
lib/harbor2_client/api/icon_api.rb,
lib/harbor2_client/api/ldap_api.rb,
lib/harbor2_client/api/oidc_api.rb,
lib/harbor2_client/api/ping_api.rb,
lib/harbor2_client/api/scan_api.rb,
lib/harbor2_client/api/user_api.rb,
lib/harbor2_client/models/error.rb,
lib/harbor2_client/models/label.rb,
lib/harbor2_client/models/quota.rb,
lib/harbor2_client/models/robot.rb,
lib/harbor2_client/models/stats.rb,
lib/harbor2_client/api/label_api.rb,
lib/harbor2_client/api/quota_api.rb,
lib/harbor2_client/api/robot_api.rb,
lib/harbor2_client/configuration.rb,
lib/harbor2_client/models/access.rb,
lib/harbor2_client/models/body_1.rb,
lib/harbor2_client/models/errors.rb,
lib/harbor2_client/models/search.rb,
lib/harbor2_client/api/health_api.rb,
lib/harbor2_client/api/member_api.rb,
lib/harbor2_client/api/search_api.rb,
lib/harbor2_client/models/metrics.rb,
lib/harbor2_client/models/project.rb,
lib/harbor2_client/models/scanner.rb,
lib/harbor2_client/models/storage.rb,
lib/harbor2_client/api/preheat_api.rb,
lib/harbor2_client/api/project_api.rb,
lib/harbor2_client/api/robotv1_api.rb,
lib/harbor2_client/api/scanner_api.rb,
lib/harbor2_client/api/webhook_api.rb,
lib/harbor2_client/models/artifact.rb,
lib/harbor2_client/models/endpoint.rb,
lib/harbor2_client/models/instance.rb,
lib/harbor2_client/models/metadata.rb,
lib/harbor2_client/models/platform.rb,
lib/harbor2_client/models/registry.rb,
lib/harbor2_client/models/schedule.rb,
lib/harbor2_client/api/artifact_api.rb,
lib/harbor2_client/api/auditlog_api.rb,
lib/harbor2_client/api/registry_api.rb,
lib/harbor2_client/api/scan_all_api.rb,
lib/harbor2_client/models/audit_log.rb,
lib/harbor2_client/models/execution.rb,
lib/harbor2_client/models/ldap_conf.rb,
lib/harbor2_client/models/ldap_user.rb,
lib/harbor2_client/models/reference.rb,
lib/harbor2_client/models/robot_sec.rb,
lib/harbor2_client/models/statistic.rb,
lib/harbor2_client/models/user_resp.rb,
lib/harbor2_client/api/configure_api.rb,
lib/harbor2_client/api/immutable_api.rb,
lib/harbor2_client/api/retention_api.rb,
lib/harbor2_client/api/statistic_api.rb,
lib/harbor2_client/api/usergroup_api.rb,
lib/harbor2_client/models/event_type.rb,
lib/harbor2_client/models/gc_history.rb,
lib/harbor2_client/models/is_default.rb,
lib/harbor2_client/models/permission.rb,
lib/harbor2_client/models/repository.rb,
lib/harbor2_client/models/user_group.rb,
lib/harbor2_client/api/repository_api.rb,
lib/harbor2_client/api/systeminfo_api.rb,
lib/harbor2_client/api/webhookjob_api.rb,
lib/harbor2_client/models/annotations.rb,
lib/harbor2_client/models/extra_attrs.rb,
lib/harbor2_client/models/notify_type.rb,
lib/harbor2_client/models/project_req.rb,
lib/harbor2_client/models/system_info.rb,
lib/harbor2_client/models/user_entity.rb,
lib/harbor2_client/models/user_search.rb,
lib/harbor2_client/models/webhook_job.rb,
lib/harbor2_client/api/replication_api.rb,
lib/harbor2_client/models/filter_style.rb,
lib/harbor2_client/models/general_info.rb,
lib/harbor2_client/models/password_req.rb,
lib/harbor2_client/models/robot_create.rb,
lib/harbor2_client/models/role_request.rb,
lib/harbor2_client/models/schedule_obj.rb,
lib/harbor2_client/models/user_profile.rb,
lib/harbor2_client/models/addition_link.rb,
lib/harbor2_client/models/chart_version.rb,
lib/harbor2_client/models/cve_allowlist.rb,
lib/harbor2_client/models/registry_info.rb,
lib/harbor2_client/models/registry_ping.rb,
lib/harbor2_client/models/resource_list.rb,
lib/harbor2_client/models/robot_created.rb,
lib/harbor2_client/models/scan_overview.rb,
lib/harbor2_client/models/search_result.rb,
lib/harbor2_client/models/addition_links.rb,
lib/harbor2_client/models/chart_metadata.rb,
lib/harbor2_client/models/configurations.rb,
lib/harbor2_client/models/immutable_rule.rb,
lib/harbor2_client/models/oidc_user_info.rb,
lib/harbor2_client/models/preheat_policy.rb,
lib/harbor2_client/models/project_member.rb,
lib/harbor2_client/models/retention_rule.rb,
lib/harbor2_client/models/webhook_policy.rb,
lib/harbor2_client/models/project_scanner.rb,
lib/harbor2_client/models/project_summary.rb,
lib/harbor2_client/models/registry_update.rb,
lib/harbor2_client/models/robot_create_v1.rb,
lib/harbor2_client/models/bool_config_item.rb,
lib/harbor2_client/models/ldap_ping_result.rb,
lib/harbor2_client/models/project_metadata.rb,
lib/harbor2_client/models/quota_ref_object.rb,
lib/harbor2_client/models/quota_update_req.rb,
lib/harbor2_client/models/replication_task.rb,
lib/harbor2_client/models/retention_policy.rb,
lib/harbor2_client/models/robot_permission.rb,
lib/harbor2_client/api/project_metadata_api.rb,
lib/harbor2_client/models/authproxy_setting.rb,
lib/harbor2_client/models/ldap_import_users.rb,
lib/harbor2_client/models/project_deletable.rb,
lib/harbor2_client/models/registry_endpoint.rb,
lib/harbor2_client/models/search_repository.rb,
lib/harbor2_client/models/user_creation_req.rb,
lib/harbor2_client/models/cve_allowlist_item.rb,
lib/harbor2_client/models/immutable_selector.rb,
lib/harbor2_client/models/replication_filter.rb,
lib/harbor2_client/models/replication_policy.rb,
lib/harbor2_client/models/retention_metadata.rb,
lib/harbor2_client/models/retention_selector.rb,
lib/harbor2_client/models/scanner_capability.rb,
lib/harbor2_client/models/string_config_item.rb,
lib/harbor2_client/models/integer_config_item.rb,
lib/harbor2_client/models/oidc_cli_secret_req.rb,
lib/harbor2_client/models/registry_credential.rb,
lib/harbor2_client/models/replication_trigger.rb,
lib/harbor2_client/models/retention_execution.rb,
lib/harbor2_client/models/user_sys_admin_flag.rb,
lib/harbor2_client/models/scanner_registration.rb,
lib/harbor2_client/models/webhook_last_trigger.rb,
lib/harbor2_client/api/system_cve_allowlist_api.rb,
lib/harbor2_client/models/native_report_summary.rb,
lib/harbor2_client/models/overall_health_status.rb,
lib/harbor2_client/models/project_member_entity.rb,
lib/harbor2_client/models/project_summary_quota.rb,
lib/harbor2_client/models/replication_execution.rb,
lib/harbor2_client/models/user_search_resp_item.rb,
lib/harbor2_client/models/vulnerability_summary.rb,
lib/harbor2_client/models/webhook_target_object.rb,
lib/harbor2_client/models/provider_under_project.rb,
lib/harbor2_client/models/registry_provider_info.rb,
lib/harbor2_client/models/retention_policy_scope.rb,
lib/harbor2_client/models/retention_rule_trigger.rb,
lib/harbor2_client/models/component_health_status.rb,
lib/harbor2_client/models/configurations_response.rb,
lib/harbor2_client/models/ldap_failed_import_user.rb,
lib/harbor2_client/models/retention_rule_metadata.rb,
lib/harbor2_client/models/retention_execution_task.rb,
lib/harbor2_client/models/scanner_adapter_metadata.rb,
lib/harbor2_client/models/scanner_registration_req.rb,
lib/harbor2_client/models/retention_selector_metadata.rb,
lib/harbor2_client/models/start_replication_execution.rb,
lib/harbor2_client/models/replication_trigger_settings.rb,
lib/harbor2_client/models/retention_rule_param_metadata.rb,
lib/harbor2_client/models/scanner_registration_settings.rb,
lib/harbor2_client/models/supported_webhook_event_types.rb,
lib/harbor2_client/models/internal_configurations_response.rb,
lib/harbor2_client/models/registry_provider_endpoint_pattern.rb,
lib/harbor2_client/models/registry_provider_credential_pattern.rb,
lib/harbor2_client/models/configurations_response_scan_all_policy.rb,
lib/harbor2_client/models/configurations_response_scan_all_policy_parameter.rb

Overview

#Harbor API

#These APIs provide services for manipulating Harbor project.

OpenAPI spec version: 2.0

Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.22

Defined Under Namespace

Classes: Access, AdditionLink, AdditionLinks, Annotations, ApiClient, ApiError, Artifact, ArtifactApi, AuditLog, AuditlogApi, AuthproxySetting, Body, Body1, BoolConfigItem, CVEAllowlist, CVEAllowlistItem, ChartMetadata, ChartVersion, ComponentHealthStatus, Configuration, Configurations, ConfigurationsResponse, ConfigurationsResponseScanAllPolicy, ConfigurationsResponseScanAllPolicyParameter, ConfigureApi, Endpoint, Error, Errors, EventType, Execution, ExtraAttrs, FilterStyle, GCHistory, GcApi, GeneralInfo, HealthApi, Icon, IconApi, ImmutableApi, ImmutableRule, ImmutableSelector, Instance, IntegerConfigItem, InternalConfigurationsResponse, IsDefault, Label, LabelApi, LdapApi, LdapConf, LdapFailedImportUser, LdapImportUsers, LdapPingResult, LdapUser, MemberApi, Metadata, Metrics, NativeReportSummary, NotifyType, OIDCCliSecretReq, OIDCUserInfo, OidcApi, OverallHealthStatus, PasswordReq, Permission, PingApi, Platform, PreheatApi, PreheatPolicy, Project, ProjectApi, ProjectDeletable, ProjectMember, ProjectMemberEntity, ProjectMetadata, ProjectMetadataApi, ProjectReq, ProjectScanner, ProjectSummary, ProjectSummaryQuota, ProviderUnderProject, Quota, QuotaApi, QuotaRefObject, QuotaUpdateReq, Reference, Registry, RegistryApi, RegistryCredential, RegistryEndpoint, RegistryInfo, RegistryPing, RegistryProviderCredentialPattern, RegistryProviderEndpointPattern, RegistryProviderInfo, RegistryUpdate, ReplicationApi, ReplicationExecution, ReplicationFilter, ReplicationPolicy, ReplicationTask, ReplicationTrigger, ReplicationTriggerSettings, Repository, RepositoryApi, ResourceList, RetentionApi, RetentionExecution, RetentionExecutionTask, RetentionMetadata, RetentionPolicy, RetentionPolicyScope, RetentionRule, RetentionRuleMetadata, RetentionRuleParamMetadata, RetentionRuleTrigger, RetentionSelector, RetentionSelectorMetadata, Robot, RobotApi, RobotCreate, RobotCreateV1, RobotCreated, RobotPermission, RobotSec, Robotv1Api, RoleRequest, ScanAllApi, ScanApi, ScanOverview, Scanner, ScannerAdapterMetadata, ScannerApi, ScannerCapability, ScannerRegistration, ScannerRegistrationReq, ScannerRegistrationSettings, Schedule, ScheduleObj, Search, SearchApi, SearchRepository, SearchResult, StartReplicationExecution, Statistic, StatisticApi, Stats, Storage, StringConfigItem, SupportedWebhookEventTypes, SystemCVEAllowlistApi, SystemInfo, SysteminfoApi, Tag, Task, UserApi, UserCreationReq, UserEntity, UserGroup, UserProfile, UserResp, UserSearch, UserSearchRespItem, UserSysAdminFlag, UsergroupApi, VulnerabilitySummary, WebhookApi, WebhookJob, WebhookLastTrigger, WebhookPolicy, WebhookTargetObject, WebhookjobApi

Constant Summary collapse

VERSION = 
'2.3.3.1'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Harbor2Client.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



199
200
201
202
203
204
205
 
# File 'lib/harbor2_client.rb', line 199

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end