Documentation ¶
Index ¶
- Variables
- type AQLSearchResults
- type ArchiveEntriesSearchResults
- type ArtifactLatestBasedOnLayoutSearchResults
- type ArtifactLatestBasedOnPropertiesSearchResults
- type ArtifactSearchResults
- type ArtifactVersionSearchResults
- type ArtifactsCreatedInDateRangeSearchResults
- type ArtifactsNotDownloadedSinceSearchResults
- type ArtifactsWithDateInRangeSearchResults
- type AuthError
- type BackgroundTasks
- type BadChecksumSearchResults
- type BuildArtifactsSearchOption
- type BuildArtifactsSearchResults
- type BuildsForDependencySearchResults
- type CalculateOption
- type Certificates
- type ChecksumSearchResults
- type Client
- func (c *Client) AQLSearch(query string) (*AQLSearchResults, error)
- func (c *Client) ActivateArtifactoryKeyEncryption() error
- func (c *Client) AddCertificate(alias string, i io.Reader) error
- func (c *Client) ArchiveEntriesSearch(p map[string]string) (*ArchiveEntriesSearchResults, error)
- func (c *Client) ArtifactLatestBasedOnPropertiesSearch(path string, p map[string]string) (*ArtifactLatestBasedOnPropertiesSearchResults, error)
- func (c *Client) ArtifactLatestVersionBasedOnLayoutSearch(p map[string]string) (string, error)
- func (c *Client) ArtifactSearch(p map[string]string) (*ArtifactSearchResults, error)
- func (c *Client) ArtifactVersionSearch(p map[string]string) (*ArtifactVersionSearchResults, error)
- func (c *Client) ArtifactsCreatedInDateRangeSearch(p map[string]string) (*ArtifactsCreatedInDateRangeSearchResults, error)
- func (c *Client) ArtifactsNotDownloadedSinceSearch(p map[string]string) (*ArtifactsNotDownloadedSinceSearchResults, error)
- func (c *Client) ArtifactsWithDateInRangeSearch(p map[string]string) (*ArtifactsWithDateInRangeSearchResults, error)
- func (c *Client) BadChecksumSearch(p map[string]string) (*BadChecksumSearchResults, error)
- func (c *Client) BuildArtifactsSearch(buildname, buildnumber string, opts ...BuildArtifactsSearchOption) (*BuildArtifactsSearchResults, error)
- func (c *Client) BuildsForDependencySearch(p map[string]string) (*BuildsForDependencySearchResults, error)
- func (c *Client) CalculateBowerIndex(repoKey string) error
- func (c *Client) CalculateDebianRepositoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
- func (c *Client) CalculateHelmChartIndex(repoKey string) error
- func (c *Client) CalculateMavenIndex(additionalOpts ...CalculateOption) error
- func (c *Client) CalculateMavenMetadata(path string, additionalOpts ...CalculateOption) error
- func (c *Client) CalculateNPMRepositoryMetadata(repoKey string) error
- func (c *Client) CalculateNuGetRepositoryMetadata(repoKey string) error
- func (c *Client) CalculateOpkgRepostitoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
- func (c *Client) CalculateYumRepositoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
- func (c *Client) ChangePassword(user, old, new string) error
- func (c *Client) ChecksumSearch(p map[string]string) (*ChecksumSearchResults, error)
- func (c *Client) ConfigureUserLockPolicy(loginAttempts int, enabled bool) error
- func (c *Client) CreateAPIKey() (string, error)
- func (c *Client) CreateLocalRepository(repoName string, opts ...CreateOrUpdateRepositoryOption) error
- func (c *Client) CreateOrReplaceGroup(g string, details requests.CreateOrReplaceGroupRequest) error
- func (c *Client) CreateOrReplacePermissionTarget(g string, details requests.CreateOrReplacePermissionTargetRequest) error
- func (c *Client) CreateOrReplaceUser(u string, details requests.CreateOrReplaceUserRequest) error
- func (c *Client) CreateRemoteRepository(repoName, repoURL string, opts ...CreateOrUpdateRepositoryOption) error
- func (c *Client) CreateToken(opts ...TokenOption) (*Token, error)
- func (c *Client) CreateVirtualRepository(repoName, packageType string, opts ...CreateOrUpdateRepositoryOption) error
- func (c *Client) DeactivateArtifactoryKeyEncryption() error
- func (c *Client) DeleteCertificate(alias string) error
- func (c *Client) DeleteGroup(g string) error
- func (c *Client) DeleteItemFromTrashCan(path string) error
- func (c *Client) DeletePermissionTarget(g string) error
- func (c *Client) DeleteRepository(repo string) error
- func (c *Client) DeleteUser(u string) error
- func (c *Client) EmptyTrashCan() error
- func (c *Client) ExpirePasswordForAllUsers() error
- func (c *Client) ExpirePasswordForMultipleUsers(users []string) error
- func (c *Client) ExpirePasswordForUser(user string) error
- func (c *Client) GAVCSearch(p map[string]string) (*GAVCSearchResults, error)
- func (rc *Client) Get(path string, opts ...httpclient.RequestOption) ([]byte, error)
- func (c *Client) GetAPIKey() (string, error)
- func (c *Client) GetBackgroundTasks() (*BackgroundTasks, error)
- func (c *Client) GetCertificates() (Certificates, error)
- func (c *Client) GetEffectiveItemPermissions(p string) (*EffectiveItemPermissions, error)
- func (c *Client) GetGPGPublicKey() (string, error)
- func (c *Client) GetGroupDetails(g string) (*GroupDetails, error)
- func (c *Client) GetGroups() (Groups, error)
- func (c *Client) GetLocalRepositoryConfiguration(repo string) (*LocalRepository, error)
- func (c *Client) GetLockedOutUsers() ([]string, error)
- func (c *Client) GetPasswordExpirationPolicy() (*PasswordExpirationPolicy, error)
- func (c *Client) GetPermissionTargetDetails(g string) (*PermissionTargetDetails, error)
- func (c *Client) GetPermissionTargets() (PermissionTargets, error)
- func (c *Client) GetRemoteRepositoryConfiguration(repo string) (*RemoteRepository, error)
- func (c *Client) GetRepositories() (Repositories, error)
- func (c *Client) GetRepositoryConfiguration(repo string) (RepositoryConfiguration, error)
- func (c *Client) GetSecurityConfiguration() (string, error)
- func (c *Client) GetServiceID() (string, error)
- func (c *Client) GetUserDetails(u string) (*UserDetails, error)
- func (c *Client) GetUserEncryptedPassword() (string, error)
- func (c *Client) GetUsers() (Users, error)
- func (c *Client) GetVirtualRepositoryConfiguration(repo string) (*VirtualRepository, error)
- func (c *Client) LicenseSearch(p map[string]string) (*LicenseSearchResults, error)
- func (c *Client) ListDockerRepositories(r string) (*ListDockerRepositoriesResults, error)
- func (c *Client) ListDockerTags(r, i string) (*ListDockerTagsSearchResults, error)
- func (c *Client) OptimizeSystemStorage() error
- func (c *Client) PatternSearch(p string) (*PatternSearchResults, error)
- func (c *Client) PropertySearch(p map[string]string) (*PropertySearchResults, error)
- func (c *Client) RefreshToken(accessToken, refreshToken string, opts ...TokenOption) (*Token, error)
- func (c *Client) RegenerateAPIKey() (string, error)
- func (c *Client) RestoreItemFromTrashCan(from, to string) error
- func (c *Client) RetrieveUserLockPolicy() (*UserLockPolicy, error)
- func (c *Client) RevokeAPIKey() error
- func (c *Client) RevokeAllAPIKeys() error
- func (c *Client) RevokeToken(token string) error
- func (c *Client) RevokeUserAPIKey(u string) error
- func (c *Client) SetGPGPassPhrase(passphrase string) error
- func (c *Client) SetGPGPrivateKey(data io.Reader) error
- func (c *Client) SetGPGPublicKey(data io.Reader) error
- func (c *Client) SetPasswordExpirationPolicy(passwordMaxAge int, enabled, notifyByEmail bool) error
- func (c *Client) UnExpirePasswordForUser(user string) error
- func (c *Client) UnlockAllLockedUsers() error
- func (c *Client) UnlockLockedOutUser(u string) error
- func (c *Client) UnlockLockedUsers(users []string) error
- func (c *Client) UpdateGroup(g string, details requests.UpdateGroupRequest) error
- func (c *Client) UpdateRepositoryConfiguration(repoName string, opts ...CreateOrUpdateRepositoryOption) error
- func (c *Client) UpdateUser(u string, details requests.UpdateUserRequest) error
- type ClientConfig
- type CreateOrUpdateRepositoryOption
- func RepositoryBoolOption(k string, v bool) CreateOrUpdateRepositoryOption
- func RepositoryIntOption(k string, v int) CreateOrUpdateRepositoryOption
- func RepositoryStringOption(k, v string) CreateOrUpdateRepositoryOption
- func RepositoryStringSliceOption(k string, v []string) CreateOrUpdateRepositoryOption
- type EffectiveItemPermissions
- type GAVCSearchResults
- type GroupDetails
- type Groups
- type LicenseSearchResults
- type ListDockerRepositoriesResults
- type ListDockerTagsSearchResults
- type LocalRepository
- type MarshalError
- type OptionError
- type PasswordExpirationPolicy
- type PatternSearchResults
- type PermissionTargetDetails
- type PermissionTargets
- type PropertySearchResults
- type RemoteRepository
- type Repositories
- type RepositoryConfiguration
- type RepositoryEntry
- type Token
- type TokenOption
- type UnmarshalError
- type UnsupportedVersionError
- type UserDetails
- type UserLockPolicy
- type Users
- type Version
- type VirtualRepository
Constants ¶
This section is empty.
Variables ¶
var MaxArtifactoryVersion = versionMustParse("5.5")
MaxArtifactoryVersion is the max version of artifactory this library has been tested with
Functions ¶
This section is empty.
Types ¶
type AQLSearchResults ¶
type AQLSearchResults struct {
responses.AQLSearchResponse
}
AQLSearchResults represents AQL search results
type ArchiveEntriesSearchResults ¶
type ArchiveEntriesSearchResults struct {
responses.ArchiveEntriesSearchResponse
}
ArchiveEntriesSearchResults represents Archive entry search results
type ArtifactLatestBasedOnLayoutSearchResults ¶
type ArtifactLatestBasedOnLayoutSearchResults struct {
responses.ArtifactLatestVersionBasedOnLayoutSearchResponse
}
ArtifactLatestBasedOnLayoutSearchResults represents the result of a search for an artifact based on layout
type ArtifactLatestBasedOnPropertiesSearchResults ¶
type ArtifactLatestBasedOnPropertiesSearchResults struct {
responses.ArtifactLatestVersionBasedOnPropertiesSearchResponse
}
ArtifactLatestBasedOnPropertiesSearchResults represents the result of a search for an artifact based on properties
type ArtifactSearchResults ¶
type ArtifactSearchResults struct {
responses.ArtifactSearchResponse
}
ArtifactSearchResults represents a quick artifact search result
type ArtifactVersionSearchResults ¶
type ArtifactVersionSearchResults struct {
responses.ArtifactVersionSearchResponse
}
ArtifactVersionSearchResults represents results from a search based on version
type ArtifactsCreatedInDateRangeSearchResults ¶
type ArtifactsCreatedInDateRangeSearchResults struct {
responses.ArtifactsCreatedInDateRangeSearchResponse
}
ArtifactsCreatedInDateRangeSearchResults represents results of a date-range artifact search based on creation date
type ArtifactsNotDownloadedSinceSearchResults ¶
type ArtifactsNotDownloadedSinceSearchResults struct {
responses.ArtifactsNotDownloadedSinceSearchResponse
}
ArtifactsNotDownloadedSinceSearchResults represents results of a checksum search
type ArtifactsWithDateInRangeSearchResults ¶
type ArtifactsWithDateInRangeSearchResults struct {
responses.ArtifactsWithDataInRangeSearchResponse
}
ArtifactsWithDateInRangeSearchResults represents results of a date-range artifact search
type AuthError ¶
type AuthError struct {
// contains filtered or unexported fields
}
AuthError is a custom error type for decoding errors
type BackgroundTasks ¶
type BackgroundTasks struct {
responses.GetBackgroundTasksResponse
}
BackgroundTasks represents Background Tasks
type BadChecksumSearchResults ¶
type BadChecksumSearchResults struct {
responses.BadChecksumSearchResponse
}
BadChecksumSearchResults represents results of a checksum search
type BuildArtifactsSearchOption ¶
type BuildArtifactsSearchOption func(*requests.BuildArtifactsSearchRequest) error
BuildArtifactsSearchOption is a functional option for build artifacts searches
func BuildArtifactsSearchMappings ¶
func BuildArtifactsSearchMappings(p []map[string]string) BuildArtifactsSearchOption
BuildArtifactsSearchMappings is the option for mappings in build artifact searches
func BuildArtifactsSearchRepos ¶
func BuildArtifactsSearchRepos(repos ...string) BuildArtifactsSearchOption
BuildArtifactsSearchRepos is the option for repos in build artifact searches
func BuildArtifactsSearchStatus ¶
func BuildArtifactsSearchStatus(status string) BuildArtifactsSearchOption
BuildArtifactsSearchStatus is the option for build status in build artifact searches
type BuildArtifactsSearchResults ¶
type BuildArtifactsSearchResults struct {
responses.BuildArtifactsSearchResponse
}
BuildArtifactsSearchResults represents the result of a search for build artifacts
type BuildsForDependencySearchResults ¶
type BuildsForDependencySearchResults struct {
responses.BuildsForDependencyResponse
}
BuildsForDependencySearchResults represents results from a search for builds based on provided dependency
type CalculateOption ¶
type CalculateOption func(*[]httpclient.RequestOption) error
CalculateOption is a functional option type for passing options to various Calculate requests
func CalculateGPGPassphrase ¶
func CalculateGPGPassphrase(p string) CalculateOption
CalculateGPGPassphrase sets the X-GPG-PASSPHRASE header
func CalculateQueryParams ¶
func CalculateQueryParams(m map[string]string) CalculateOption
CalculateQueryParams sets any custom query params required for a Calculate request
type Certificates ¶
type Certificates responses.GetCertificatesResponse
Certificates is a collection of certificates
type ChecksumSearchResults ¶
type ChecksumSearchResults struct {
responses.ChecksumSearchResponse
}
ChecksumSearchResults represents results of a checksum search
type Client ¶
type Client struct { Config *ClientConfig HTTPClient *http.Client }
Client is an artifactory client
func NewClient ¶
func NewClient(config *ClientConfig) (*Client, error)
NewClient creates a new client from the provided `ClientConfig`
func NewClientFromEnv ¶
NewClientFromEnv returns a new client configured from environment variables
func (*Client) AQLSearch ¶
func (c *Client) AQLSearch(query string) (*AQLSearchResults, error)
AQLSearch performs an AQL search
func (*Client) ActivateArtifactoryKeyEncryption ¶
ActivateArtifactoryKeyEncryption creates a new artifactory encryption key and activates key encryption
func (*Client) AddCertificate ¶
AddCertificate adds an SSL Certificate
func (*Client) ArchiveEntriesSearch ¶
func (c *Client) ArchiveEntriesSearch(p map[string]string) (*ArchiveEntriesSearchResults, error)
ArchiveEntriesSearch performs a class search p is a map[string]string matching the format of the options specified in the api docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArchiveEntriesSearch(ClassSearch)
func (*Client) ArtifactLatestBasedOnPropertiesSearch ¶
func (c *Client) ArtifactLatestBasedOnPropertiesSearch(path string, p map[string]string) (*ArtifactLatestBasedOnPropertiesSearchResults, error)
ArtifactLatestBasedOnPropertiesSearch search for artifacts that were already tagged with license information https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactLatestVersionSearchBasedOnProperties path is the path pattern specified in the api docs p is a map[string]string matching the format of options specificied in the API docs
func (*Client) ArtifactLatestVersionBasedOnLayoutSearch ¶
ArtifactLatestVersionBasedOnLayoutSearch search for artifacts that were already tagged with license information https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactLatestVersionSearchBasedonLayout p is a map[string]string matching the format of options specificied in the API docs
func (*Client) ArtifactSearch ¶
func (c *Client) ArtifactSearch(p map[string]string) (*ArtifactSearchResults, error)
ArtifactSearch performs an AQL search p is a map[string]string matching the format of the options specified in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactSearch(QuickSearch)
func (*Client) ArtifactVersionSearch ¶
func (c *Client) ArtifactVersionSearch(p map[string]string) (*ArtifactVersionSearchResults, error)
ArtifactVersionSearch search for artifacts that were already tagged with license information https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactVersionSearch p is a map[string]string matching the format of options specificied in the API docs
func (*Client) ArtifactsCreatedInDateRangeSearch ¶
func (c *Client) ArtifactsCreatedInDateRangeSearch(p map[string]string) (*ArtifactsCreatedInDateRangeSearchResults, error)
ArtifactsCreatedInDateRangeSearch performs a search for artifacts created in a given date range p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactsCreatedInDateRange p will be passed as is
func (*Client) ArtifactsNotDownloadedSinceSearch ¶
func (c *Client) ArtifactsNotDownloadedSinceSearch(p map[string]string) (*ArtifactsNotDownloadedSinceSearchResults, error)
ArtifactsNotDownloadedSinceSearch performs a search for artifacts not downloaded since given parameters p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactsNotDownloadedSince p will be passed as is
func (*Client) ArtifactsWithDateInRangeSearch ¶
func (c *Client) ArtifactsWithDateInRangeSearch(p map[string]string) (*ArtifactsWithDateInRangeSearchResults, error)
ArtifactsWithDateInRangeSearch performs a search for artifacts in a given date range p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ArtifactsWithDateInDateRange p will be passed as is
func (*Client) BadChecksumSearch ¶
func (c *Client) BadChecksumSearch(p map[string]string) (*BadChecksumSearchResults, error)
BadChecksumSearch performs a property search p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ChecksumSearch p will be passed as is
func (*Client) BuildArtifactsSearch ¶
func (c *Client) BuildArtifactsSearch(buildname, buildnumber string, opts ...BuildArtifactsSearchOption) (*BuildArtifactsSearchResults, error)
BuildArtifactsSearch search for artifacts base on a specific build https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-BuildArtifactsSearch path is the path pattern specified in the api docs p is a map[string]string matching the format of options specificied in the API docs
func (*Client) BuildsForDependencySearch ¶
func (c *Client) BuildsForDependencySearch(p map[string]string) (*BuildsForDependencySearchResults, error)
BuildsForDependencySearch finds all the builds an artifact is a dependency of https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-BuildsforDependency p is a map[string]string matching the format of options specificied in the API docs
func (*Client) CalculateBowerIndex ¶
CalculateBowerIndex calculates the index for a bower repository
func (*Client) CalculateDebianRepositoryMetadata ¶
func (c *Client) CalculateDebianRepositoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
CalculateDebianRepositoryMetadata calculates the metadata for a debian repository
func (*Client) CalculateHelmChartIndex ¶
CalculateHelmChartIndex calculates the index for a helm chart repository
func (*Client) CalculateMavenIndex ¶
func (c *Client) CalculateMavenIndex(additionalOpts ...CalculateOption) error
CalculateMavenIndex calculates the index for a maven repository
func (*Client) CalculateMavenMetadata ¶
func (c *Client) CalculateMavenMetadata(path string, additionalOpts ...CalculateOption) error
CalculateMavenMetadata calculates the maven metadata for a repository
func (*Client) CalculateNPMRepositoryMetadata ¶
CalculateNPMRepositoryMetadata calculates an npm repo's metadata
func (*Client) CalculateNuGetRepositoryMetadata ¶
CalculateNuGetRepositoryMetadata calculates a nuget repo's metadata
func (*Client) CalculateOpkgRepostitoryMetadata ¶
func (c *Client) CalculateOpkgRepostitoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
CalculateOpkgRepostitoryMetadata calculates the metadata for an opkg repository
func (*Client) CalculateYumRepositoryMetadata ¶
func (c *Client) CalculateYumRepositoryMetadata(repoKey string, additionalOpts ...CalculateOption) error
CalculateYumRepositoryMetadata calculates a yum repo's metadata
func (*Client) ChangePassword ¶
ChangePassword changes a user's password
func (*Client) ChecksumSearch ¶
func (c *Client) ChecksumSearch(p map[string]string) (*ChecksumSearchResults, error)
ChecksumSearch performs a property search p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ChecksumSearch p will be passed as is
func (*Client) ConfigureUserLockPolicy ¶
ConfigureUserLockPolicy sets the user lock policy
func (*Client) CreateAPIKey ¶
CreateAPIKey creates an apikey for the current user
func (*Client) CreateLocalRepository ¶
func (c *Client) CreateLocalRepository(repoName string, opts ...CreateOrUpdateRepositoryOption) error
CreateLocalRepository creates a repository
func (*Client) CreateOrReplaceGroup ¶
func (c *Client) CreateOrReplaceGroup(g string, details requests.CreateOrReplaceGroupRequest) error
CreateOrReplaceGroup creates or updates the provided group with the provided details
func (*Client) CreateOrReplacePermissionTarget ¶
func (c *Client) CreateOrReplacePermissionTarget(g string, details requests.CreateOrReplacePermissionTargetRequest) error
CreateOrReplacePermissionTarget creates or replaces the permission target with provided details
func (*Client) CreateOrReplaceUser ¶
func (c *Client) CreateOrReplaceUser(u string, details requests.CreateOrReplaceUserRequest) error
CreateOrReplaceUser creates or updates the provided user with the provided details
func (*Client) CreateRemoteRepository ¶
func (c *Client) CreateRemoteRepository(repoName, repoURL string, opts ...CreateOrUpdateRepositoryOption) error
CreateRemoteRepository creates a repository
func (*Client) CreateToken ¶
func (c *Client) CreateToken(opts ...TokenOption) (*Token, error)
CreateToken creates an access token
func (*Client) CreateVirtualRepository ¶
func (c *Client) CreateVirtualRepository(repoName, packageType string, opts ...CreateOrUpdateRepositoryOption) error
CreateVirtualRepository creates a repository
func (*Client) DeactivateArtifactoryKeyEncryption ¶
DeactivateArtifactoryKeyEncryption removes a new artifactory encryption key and deactivates key encryption
func (*Client) DeleteCertificate ¶
DeleteCertificate deletes an SSL certificate
func (*Client) DeleteGroup ¶
DeleteGroup deletes the provided group
func (*Client) DeleteItemFromTrashCan ¶
DeleteItemFromTrashCan empties the trash can
func (*Client) DeletePermissionTarget ¶
DeletePermissionTarget deletes the specified permission target
func (*Client) DeleteRepository ¶
DeleteRepository deletes a repo
func (*Client) DeleteUser ¶
DeleteUser creates or updates the provided user with the provided details
func (*Client) EmptyTrashCan ¶
EmptyTrashCan empties the trash can
func (*Client) ExpirePasswordForAllUsers ¶
ExpirePasswordForAllUsers expires the password for multiple users
func (*Client) ExpirePasswordForMultipleUsers ¶
ExpirePasswordForMultipleUsers expires the password for multiple users
func (*Client) ExpirePasswordForUser ¶
ExpirePasswordForUser expires the password for a user
func (*Client) GAVCSearch ¶
func (c *Client) GAVCSearch(p map[string]string) (*GAVCSearchResults, error)
GAVCSearch performs a GAVC search p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-GAVCSearch p will be passed as is
func (*Client) Get ¶
func (rc *Client) Get(path string, opts ...httpclient.RequestOption) ([]byte, error)
Get performs an http get
func (*Client) GetBackgroundTasks ¶
func (c *Client) GetBackgroundTasks() (*BackgroundTasks, error)
GetBackgroundTasks returns the list of background tasks
func (*Client) GetCertificates ¶
func (c *Client) GetCertificates() (Certificates, error)
GetCertificates gets a list of installed SSL Certificates
func (*Client) GetEffectiveItemPermissions ¶
func (c *Client) GetEffectiveItemPermissions(p string) (*EffectiveItemPermissions, error)
GetEffectiveItemPermissions gets an item or folder's effective permissions
func (*Client) GetGPGPublicKey ¶
GetGPGPublicKey gets the public key that artifactory provides to debian and opkg clients to verify packages
func (*Client) GetGroupDetails ¶
func (c *Client) GetGroupDetails(g string) (*GroupDetails, error)
GetGroupDetails gets a group's details
func (*Client) GetLocalRepositoryConfiguration ¶
func (c *Client) GetLocalRepositoryConfiguration(repo string) (*LocalRepository, error)
GetLocalRepositoryConfiguration gets a local repository configuration
func (*Client) GetLockedOutUsers ¶
GetLockedOutUsers gets a list of locked out users
func (*Client) GetPasswordExpirationPolicy ¶
func (c *Client) GetPasswordExpirationPolicy() (*PasswordExpirationPolicy, error)
GetPasswordExpirationPolicy returns the password expiration policy
func (*Client) GetPermissionTargetDetails ¶
func (c *Client) GetPermissionTargetDetails(g string) (*PermissionTargetDetails, error)
GetPermissionTargetDetails gets details about a permission target
func (*Client) GetPermissionTargets ¶
func (c *Client) GetPermissionTargets() (PermissionTargets, error)
GetPermissionTargets gets a list of permission targets
func (*Client) GetRemoteRepositoryConfiguration ¶
func (c *Client) GetRemoteRepositoryConfiguration(repo string) (*RemoteRepository, error)
GetRemoteRepositoryConfiguration gets a local repository configuration
func (*Client) GetRepositories ¶
func (c *Client) GetRepositories() (Repositories, error)
GetRepositories lists all repositories
func (*Client) GetRepositoryConfiguration ¶
func (c *Client) GetRepositoryConfiguration(repo string) (RepositoryConfiguration, error)
GetRepositoryConfiguration gets a repo's configuration Note that you will need to cast this to the appropriate type of repo type to operate on it
func (*Client) GetSecurityConfiguration ¶
GetSecurityConfiguration gets the system security configuration
func (*Client) GetServiceID ¶
GetServiceID gets the service id of an artifactory instance or cluster
func (*Client) GetUserDetails ¶
func (c *Client) GetUserDetails(u string) (*UserDetails, error)
GetUserDetails gets a user's details
func (*Client) GetUserEncryptedPassword ¶
GetUserEncryptedPassword returns the encrypted password for the current user
func (*Client) GetVirtualRepositoryConfiguration ¶
func (c *Client) GetVirtualRepositoryConfiguration(repo string) (*VirtualRepository, error)
GetVirtualRepositoryConfiguration gets a local repository configuration
func (*Client) LicenseSearch ¶
func (c *Client) LicenseSearch(p map[string]string) (*LicenseSearchResults, error)
LicenseSearch search for artifacts that were already tagged with license information https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-LicenseSearch p is a map[string]string matching the format of options specificied in the API docs
func (*Client) ListDockerRepositories ¶
func (c *Client) ListDockerRepositories(r string) (*ListDockerRepositoriesResults, error)
ListDockerRepositories lists a docker registry's catalog https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerRepositories r is the repository to list
func (*Client) ListDockerTags ¶
func (c *Client) ListDockerTags(r, i string) (*ListDockerTagsSearchResults, error)
ListDockerTags lists a docker registry's catalog https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-ListDockerTags r is the repository to search i is the image name
func (*Client) OptimizeSystemStorage ¶
OptimizeSystemStorage optimizes system storage
func (*Client) PatternSearch ¶
func (c *Client) PatternSearch(p string) (*PatternSearchResults, error)
PatternSearch performs a search for artifacts based on a pattern https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-PatternSearch p will be passed as is
func (*Client) PropertySearch ¶
func (c *Client) PropertySearch(p map[string]string) (*PropertySearchResults, error)
PropertySearch performs a property search p is a map[string]string matching the format of options specificied in the API docs https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API#ArtifactoryRESTAPI-PropertySearch p will be passed as is
func (*Client) RefreshToken ¶
func (c *Client) RefreshToken(accessToken, refreshToken string, opts ...TokenOption) (*Token, error)
RefreshToken refreshes an access token
func (*Client) RegenerateAPIKey ¶
RegenerateAPIKey regenerate an apikey for the current user
func (*Client) RestoreItemFromTrashCan ¶
RestoreItemFromTrashCan restores the specified item from the trashcan into the specified path
func (*Client) RetrieveUserLockPolicy ¶
func (c *Client) RetrieveUserLockPolicy() (*UserLockPolicy, error)
RetrieveUserLockPolicy returns the password expiration policy
func (*Client) RevokeAPIKey ¶
RevokeAPIKey revokes an apikey for the current user
func (*Client) RevokeAllAPIKeys ¶
RevokeAllAPIKeys revokes all api keys
func (*Client) RevokeToken ¶
RevokeToken revokes a token
func (*Client) RevokeUserAPIKey ¶
RevokeUserAPIKey revokes an apikey for the specified user
func (*Client) SetGPGPassPhrase ¶
SetGPGPassPhrase sets the public key that artifactory provides to debian and opkg clients to verify packages
func (*Client) SetGPGPrivateKey ¶
SetGPGPrivateKey sets the public key that artifactory provides to debian and opkg clients to verify packages
func (*Client) SetGPGPublicKey ¶
SetGPGPublicKey sets the public key that artifactory provides to debian and opkg clients to verify packages
func (*Client) SetPasswordExpirationPolicy ¶
SetPasswordExpirationPolicy sets the password expiration policy
func (*Client) UnExpirePasswordForUser ¶
UnExpirePasswordForUser expires the password for a user
func (*Client) UnlockAllLockedUsers ¶
UnlockAllLockedUsers unlocks all locked out users
func (*Client) UnlockLockedOutUser ¶
UnlockLockedOutUser unlocks a locked user
func (*Client) UnlockLockedUsers ¶
UnlockLockedUsers unlocks a list of users
func (*Client) UpdateGroup ¶
func (c *Client) UpdateGroup(g string, details requests.UpdateGroupRequest) error
UpdateGroup creates or updates the provided group with the provided details
func (*Client) UpdateRepositoryConfiguration ¶
func (c *Client) UpdateRepositoryConfiguration(repoName string, opts ...CreateOrUpdateRepositoryOption) error
UpdateRepositoryConfiguration updates a repo configuration
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(u string, details requests.UpdateUserRequest) error
UpdateUser creates or updates the provided user with the provided details
type ClientConfig ¶
type ClientConfig struct { BaseURL string Username string Password string Token string AuthMethod string VerifySSL bool Debug bool APIVersion Version HTTPClient *http.Client }
ClientConfig is an artifactory client configuration
type CreateOrUpdateRepositoryOption ¶
CreateOrUpdateRepositoryOption is a functional option type for setting optional fields when creating a repository
func RepositoryBoolOption ¶
func RepositoryBoolOption(k string, v bool) CreateOrUpdateRepositoryOption
RepositoryBoolOption sets a key's value to a bool
func RepositoryIntOption ¶
func RepositoryIntOption(k string, v int) CreateOrUpdateRepositoryOption
RepositoryIntOption sets a key's value to an int
func RepositoryStringOption ¶
func RepositoryStringOption(k, v string) CreateOrUpdateRepositoryOption
RepositoryStringOption sets a key's value to a string
func RepositoryStringSliceOption ¶
func RepositoryStringSliceOption(k string, v []string) CreateOrUpdateRepositoryOption
RepositoryStringSliceOption sets a key's value to a slice of strings
type EffectiveItemPermissions ¶
type EffectiveItemPermissions struct {
responses.EffectiveItemPermissionsResponse
}
EffectiveItemPermissions returns the effective item permissions for the specified item or folder
type GAVCSearchResults ¶
type GAVCSearchResults struct {
responses.GAVCSearchResponse
}
GAVCSearchResults represents GAVC search results
type GroupDetails ¶
type GroupDetails struct {
responses.GetGroupDetailsResponse
}
GroupDetails is a group's details
type LicenseSearchResults ¶
type LicenseSearchResults struct {
responses.LicenseSearchResponse
}
LicenseSearchResults represents results from a search base on license
type ListDockerRepositoriesResults ¶
type ListDockerRepositoriesResults struct {
responses.ListDockerRepositoriesResponse
}
ListDockerRepositoriesResults represents the result of listing docker repositories
type ListDockerTagsSearchResults ¶
type ListDockerTagsSearchResults struct {
responses.ListDockerTagsResponse
}
ListDockerTagsSearchResults represents the results of listing docker tags
type LocalRepository ¶
type LocalRepository responses.LocalRepositoryConfigurationResponse
LocalRepository is a local repository
type MarshalError ¶
type MarshalError struct {
// contains filtered or unexported fields
}
MarshalError is a custom error type for decoding errors
type OptionError ¶
type OptionError struct {
// contains filtered or unexported fields
}
OptionError is a custom error type for option errors
type PasswordExpirationPolicy ¶
type PasswordExpirationPolicy struct {
responses.GetPasswordExpirationPolicyResponse
}
PasswordExpirationPolicy represents a password expiration Policy
type PatternSearchResults ¶
type PatternSearchResults struct {
responses.PatternSearchResponse
}
PatternSearchResults represents results from a pattern search
type PermissionTargetDetails ¶
type PermissionTargetDetails struct {
responses.GetPermissionTargetDetailsResponse
}
PermissionTargetDetails is a permission target's details
type PermissionTargets ¶
type PermissionTargets []responses.PermissionTargetEntry
PermissionTargets is a list of permission targets
type PropertySearchResults ¶
type PropertySearchResults struct {
responses.PropertySearchResponse
}
PropertySearchResults represents property-based search results
type RemoteRepository ¶
type RemoteRepository responses.RemoteRepositoryConfigurationResponse
RemoteRepository is a remote repository
type Repositories ¶
type Repositories []RepositoryEntry
Repositories is a collection of repositories
type RepositoryConfiguration ¶
type RepositoryConfiguration interface {
// contains filtered or unexported methods
}
RepositoryConfiguration is an individual repository
type RepositoryEntry ¶
type RepositoryEntry struct {
responses.RepositoryItemEntry
}
RepositoryEntry is an entry in a Repositories list
type TokenOption ¶
TokenOption is a functional option for creating tokens
func TokenAudience ¶
func TokenAudience(a string) TokenOption
TokenAudience is a space separate list of other artifactory instances that should accept this token
func TokenExpires ¶
func TokenExpires(expires int) TokenOption
TokenExpires is the option for setting when a token expires
func TokenGrantType ¶
func TokenGrantType(t string) TokenOption
TokenGrantType sets the grant_type of the token
func TokenRefreshable ¶
func TokenRefreshable(r bool) TokenOption
TokenRefreshable is the option for setting a token refreshable
func TokenScope ¶
func TokenScope(scope string) TokenOption
TokenScope is the option for setting a token's scope
func TokenUsername ¶
func TokenUsername(username string) TokenOption
TokenUsername is the username for a token. This is required for creating new tokens
type UnmarshalError ¶
type UnmarshalError struct {
// contains filtered or unexported fields
}
UnmarshalError is a custom error type for decoding errors
func (*UnmarshalError) Error ¶
func (e *UnmarshalError) Error() string
Error returns the error message
type UnsupportedVersionError ¶
type UnsupportedVersionError struct {
// contains filtered or unexported fields
}
UnsupportedVersionError is an error type for api calls using an unsupported version
func (UnsupportedVersionError) Error ¶
func (e UnsupportedVersionError) Error() string
Error returns the error message
type UserDetails ¶
type UserDetails struct {
responses.GetUserDetailsResponse
}
UserDetails is a user's details
type UserLockPolicy ¶
type UserLockPolicy struct {
responses.RetrieveUserLockPolicyResponse
}
UserLockPolicy represents a user lock policy
type VirtualRepository ¶
type VirtualRepository responses.VirtualRepositoryConfigurationResponse
VirtualRepository is a virtual repository