Documentation ¶
Index ¶
- Constants
- func IsDeprecated(a VersionedRequest) bool
- type AQLSearchRequest
- type ActivateArtifactoryKeyEncryptionRequest
- type AddCertificateRequest
- type BuildArtifactsSearchRequest
- type CalculateBowerIndexRequest
- type CalculateDebianMetadataRequest
- type CalculateHelmChartIndexRequest
- type CalculateMavenIndexRequest
- type CalculateMavenMetadataRequest
- type CalculateNPMMetadataRequest
- type CalculateNuGetMetadataRequest
- type CalculateOpkgMetadataRequest
- type CalculateYumMetadataRequest
- type ChangePasswordRequest
- type ConfigureUserLockPolicyRequest
- type CreateAPIKeyRequest
- type CreateLocalRepositoryRequest
- type CreateOrReplaceGroupRequest
- type CreateOrReplacePermissionTargetRequest
- type CreateOrReplaceUserRequest
- type CreateRemoteRepositoryRequest
- type CreateTokenRequest
- type CreateVirtualRepositoryRequest
- type DeactivateArtifactoryKeyEncryptionRequest
- type DeleteCertificateRequest
- type DeleteGroupRequest
- type DeleteItemFromTrashCanRequest
- type DeletePermissionTargetRequest
- type DeleteUserRequest
- type EmptyTrashCanRequest
- type ExpirePasswordForAllUsersRequest
- type ExpirePasswordForMultipleUsersRequest
- type ExpirePasswordForUserRequest
- type GenericVersionedRequest
- type OptimizeSystemStorageRequest
- type RefreshTokenRequest
- type RegenerateAPIKeyRequest
- type RestoreItemFromTrashCanRequest
- type RevokeAPIKeyRequest
- type RevokeAllAPIKeysRequest
- type RevokeTokenRequest
- type RevokeUserAPIKeyRequest
- type SetGPGPassphraseRequest
- type SetGPGPrivateKeyRequest
- type SetGPGPublicKeyRequest
- type SetPasswordExpirationPolicyRequest
- type UnexpirePasswordForUserRequest
- type UnlockAllLockedOutUsersRequest
- type UnlockLockedOutUserRequest
- type UnlockLockedOutUsersRequest
- type UpdateGroupRequest
- type UpdateRepositoryConfigurationRequest
- type UpdateUserRequest
- type Version
- type VersionedRequest
Constants ¶
const AbsoluteMinimumVersion = "5.1"
AbsoluteMinimumVersion is the absolute minimum version this library will support
const CurrentVersion = "5.5"
CurrentVersion is the current version of the API that this library is tested against
Variables ¶
This section is empty.
Functions ¶
func IsDeprecated ¶
func IsDeprecated(a VersionedRequest) bool
IsDeprecated indicates if a response is deprecated or not
Types ¶
type AQLSearchRequest ¶
type AQLSearchRequest struct{}
AQLSearchRequest represents a AQLSearch request
type ActivateArtifactoryKeyEncryptionRequest ¶
type ActivateArtifactoryKeyEncryptionRequest struct{}
ActivateArtifactoryKeyEncryptionRequest represents a ActivateArtifactoryKeyEncryption request
type AddCertificateRequest ¶
type AddCertificateRequest struct{}
AddCertificateRequest represents a AddCertificate request
type BuildArtifactsSearchRequest ¶
type BuildArtifactsSearchRequest struct { BuildName string `json:"buildName"` BuildNumber string `json:"buildNumber"` BuildStatus string `json:"buildStatus,omitempty"` Repos []string `json:"repos,omitempty"` Mappings []map[string]string `json:"mappings,omitempty"` }
BuildArtifactsSearchRequest represents a BuildArtifactsSearch request
type CalculateBowerIndexRequest ¶
type CalculateBowerIndexRequest struct{}
CalculateBowerIndexRequest represents a CalculateBowerIndex request
type CalculateDebianMetadataRequest ¶
type CalculateDebianMetadataRequest struct{}
CalculateDebianMetadataRequest represents a CalculateDebianMetadata request
type CalculateHelmChartIndexRequest ¶
type CalculateHelmChartIndexRequest struct{}
CalculateHelmChartIndexRequest represents a CalculateHelmChartIndex request
type CalculateMavenIndexRequest ¶
type CalculateMavenIndexRequest struct{}
CalculateMavenIndexRequest represents a CalculateMavenIndex request
type CalculateMavenMetadataRequest ¶
type CalculateMavenMetadataRequest struct{}
CalculateMavenMetadataRequest represents a CalculateMavenMetadata request
type CalculateNPMMetadataRequest ¶
type CalculateNPMMetadataRequest struct{}
CalculateNPMMetadataRequest represents a CalculateNPMMetadata request
type CalculateNuGetMetadataRequest ¶
type CalculateNuGetMetadataRequest struct{}
CalculateNuGetMetadataRequest represents a CalculateNuGetMetadata request
type CalculateOpkgMetadataRequest ¶
type CalculateOpkgMetadataRequest struct{}
CalculateOpkgMetadataRequest represents a CalculateOpkgMetadata request
type CalculateYumMetadataRequest ¶
type CalculateYumMetadataRequest struct{}
CalculateYumMetadataRequest represents a CalculateYumMetadata request
type ChangePasswordRequest ¶
type ChangePasswordRequest struct { UserName string `json:"userName"` OldPassword string `json:"oldPassword"` NewPassword1 string `json:"newPassword1"` NewPassword2 string `json:"newpassword2"` }
ChangePasswordRequest represents a ChangePassword request
type ConfigureUserLockPolicyRequest ¶
type ConfigureUserLockPolicyRequest struct { Enabled bool `json:"enabled"` LoginAttempts int `json:"loginAttempts"` }
ConfigureUserLockPolicyRequest represents a ConfigureUserLockPolicy request
type CreateAPIKeyRequest ¶
type CreateAPIKeyRequest struct{}
CreateAPIKeyRequest represents a CreateAPIKey request
type CreateLocalRepositoryRequest ¶
type CreateLocalRepositoryRequest struct { Key string `json:"key,omitempty"` PackageType string `json:"packageType,omitempty"` RClass string `json:"rclass"` Description string `json:"description,omitempty"` Notes string `json:"notes,omitempty"` IncludesPattern string `json:"includesPattern,omitempty"` ExcludesPattern string `json:"excludesPattern,omitempty"` RepoLayoutRef string `json:"repoLayoutRef,omitempty"` DebianTrivialLayout bool `json:"debianTrivialLayout,omitempty"` ChecksumPolicyType string `json:"checksumPolicyType,omitempty"` HandleReleases bool `json:"handleReleases,omitempty"` HandleSnapshots bool `json:"handleSnapshots,omitempty"` MaxUniqueSnapshots int `json:"maxUniqueSnapshots,omitempty"` MaxUniqueTags int `json:"maxUniqueTags,omitempty"` SnapshotVersionBehaviour string `json:"snapshotVersionBehavior,omitempty"` SuppressPomConsistencyChecks bool `json:"suppressPomConsistencyChecks,omitempty"` BlackedOut bool `json:"blackedOut,omitempty"` PropertySets []string `json:"propertySets,omitempty"` ArchiveBrowsingEnabled bool `json:"archiveBrowsingEnabled,omitempty"` CalculateYumMetaData bool `json:"calculateYumMetadata,omitempty"` YumRootDepth int `json:"yumRootDepth,omitempty"` DockerAPIVersion string `json:"dockerApiVersion,omitempty"` EnableFileListsIndexing bool `json:"enableFileListsIndexing,omitempty"` OptionalIndexCompressionFormats []string `json:"optionalIndexCompressionFormats,omitempty"` ForceNuGetAuthentication bool `json:"forceNugetAuthentication,omitempty"` BlockXRayUnscannedArtifacts bool `json:"blockXrayUnscannedArtifacts,omitempty"` XRayIndex bool `json:"xrayIndex,omitempty"` XrayMinimumBlockedSeverity string `json:"xrayMinimumBlockedSeverity,omitempty"` }
CreateLocalRepositoryRequest represents a CreateRepository request
type CreateOrReplaceGroupRequest ¶
type CreateOrReplaceGroupRequest struct { Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` AutoJoin bool `json:"autoJoin,omitempty"` AdminPrivileges bool `json:"adminPrivileges,omitempty"` Realm string `json:"realm,omitempty"` RealmAttributes string `json:"realmAttributes,omitempty"` }
CreateOrReplaceGroupRequest represents a CreateOrReplaceGroup request
type CreateOrReplacePermissionTargetRequest ¶
type CreateOrReplacePermissionTargetRequest struct { Repositories []string `json:"repositories"` Name string `json:"name,omitempty"` ExcludesPattern string `json:"excludesPattern, omitempty"` IncludesPattern string `json:"includesPattern,omitempty"` Principals map[string]map[string][]string `json:"principals,omitempty"` }
CreateOrReplacePermissionTargetRequest represents a CreateOrReplacePermissionTarget request
type CreateOrReplaceUserRequest ¶
type CreateOrReplaceUserRequest struct { Name string `json:"name,omitempty"` Email string `json:"email"` Password string `json:"password"` Admin bool `json:"admin,omitempty"` ProfileUpdatable bool `json:"profileUpdatable,omitempty"` DisableUIAccess bool `json:"disableUIAccess,omitempty"` InternalPasswordDisabled bool `json:"internalPasswordDisabled,omitempty"` Groups []string `json:"groups,omitempty"` }
CreateOrReplaceUserRequest represents a user to be created or updated https://www.jfrog.com/confluence/display/RTF/Security+Configuration+JSON
type CreateRemoteRepositoryRequest ¶
type CreateRemoteRepositoryRequest struct { Key string `json:"key,omitempty"` RClass string `json:"rclass"` PackageType string `json:"packageType,omitempty"` URL string `json:"url"` Username string `json:"username,omitempty"` Password string `json:"password,omitempty"` Proxy string `json:"proxy,omitempty"` Description string `json:"description,omitempty"` Notes string `json:"notes,omitempty"` IncludesPattern string `json:"includesPattern,omitempty"` ExcludesPattern string `json:"excludesPattern,omitempty"` RepoLayoutRef string `json:"repoLayoutRef,omitempty"` HandleReleases bool `json:"handleReleases,omitempty"` HandleSnapshots bool `json:"handleSnapshots,omitempty"` MaxUniqueSnapshots int `json:"maxUniqueSnapshots,omitempty"` MaxUniqueTags int `json:"maxUniqueTags,omitempty"` SuppressPomConsistencyChecks bool `json:"suppressPomConsistencyChecks,omitempty"` HardFail bool `json:"hardFail,omitempty"` Offline bool `json:"offline,omitempty"` BlackedOut bool `json:"blackedOut,omitempty"` StoreArtifactsLocally bool `json:"storeArtifactsLocally,omitempty"` SocketTimeoutMillis int `json:"socketTimeoutMillis,omitempty"` LocalAddress string `json:"localAddress,omitempty"` RetrievalCachePeriodSecs int `json:"retrievalCachePeriodSecs,omitempty"` FailedRetrievalCachePeriodSecs int `json:"failedRetrievalCachePeriodSecs,omitempty"` MissedRetrievalCachePeriodSecs int `json:"missedRetrievalCachePeriodSecs,omitempty"` UnusedArtifactsCleanupPeriodHours int `json:"unusedArtifactsCleanupPeriodHours,omitempty"` UnusedArtifactsCleanupEnabled bool `json:"unusedArtifactsCleanupEnabled,omitempty"` AssumedOfflinePeriodSecs int `json:"assumedOfflinePeriodSecs,omitempty"` FetchJarsEagerly bool `json:"fetchJarsEagerly,omitempty"` FetchSourcesEagerly bool `json:"fetchSourcesEagerly,omitempty"` SynchronizeProperties bool `json:"synchronizeProperties,omitempty"` BlockMismatchingMimeTypes bool `json:"blockMismatchingMimeTypes,omitempty"` PropertySets []string `json:"propertySets,omitempty"` AllowAnyHostAuth bool `json:"allowAnyHostAuth,omitempty"` EnableCookieManagement bool `json:"enableCookieManagement,omitempty"` BowerRegistryURL string `json:"bowerRegistryUrl,omitempty"` VcsType string `json:"vcsType,omitempty"` VcsGitProvider string `json:"vcsGitProvider,omitempty"` VcsGitDownloadURL string `json:"vcsGitDownloadUrl,omitempty"` BypassHeadRequests bool `json:"bypassHeadRequests,omitempty"` ClientTLSCertificate string `json:"clientTlsCertificate,omitempty"` // These are only documented in responses but I have a feeling they're options for requests as well DebianTrivialLayout bool `json:"debianTrivialLayout,omitEmpty"` DockerAPIVersion string `json:"dockerApiVersion,omitempty"` ForceNuGetAuthentication bool `json:"forceNugetAuthentication,omitempty"` ArchiveBrowsingEnabled bool `json:"archiveBrowsingEnabled,omitempty"` BlockXRayUnscannedArtifacts bool `json:"blockXrayUnscannedArtifacts,omitempty"` XRayIndex bool `json:"xrayIndex,omitempty"` XrayMinimumBlockedSeverity string `json:"xrayMinimumBlockedSeverity,omitempty"` RemoteRepoChecksumPolicyType string `json:"remoteRepoChecksumPolicyType,omitempty"` ContentSynchronisation map[string]interface{} `json:"contentSynchronisation,omitempty"` EnableTokenAuthentication bool `json:"enableTokenAuthentication,omitempty"` ListRemoteFolderItmes bool `json:"listRemoteFolderItems,omitempty"` MismatchingMimeTypesOverrideList string `json:"mismatchingMimeTypesOverrideList,omitempty"` PropagateQueryParams bool `json:"propagateQueryParams,omitempty"` RejectInvalidJars bool `json:"rejectInvalidJars,omitempty"` }
CreateRemoteRepositoryRequest represents a CreateRemoteRepository request
type CreateTokenRequest ¶
type CreateTokenRequest struct{}
CreateTokenRequest represents a CreateToken request
type CreateVirtualRepositoryRequest ¶
type CreateVirtualRepositoryRequest struct { Key string `json:"key,omitempty"` PackageType string `json:"packageType"` RClass string `json:"rclass"` Description string `json:"description,omitempty"` Notes string `json:"notes,omitempty"` IncludesPattern string `json:"includesPattern,omitempty"` ExcludesPattern string `json:"excludesPattern,omitempty"` DebianTrivialLayout bool `json:"debianTrivialLayout,omitempty"` Repositories []string `json:"repositories,omitempty"` KeyPair string `json:"keyPair,omitempty"` VirtualRetrievalCachePeriodSecs int `json:"virtualRetrievalCachePeriodSecs,omitempty"` ExternalDependenciesEnabled bool `json:"externalDependenciesEnabled,omitempty"` ArtifactoryRequestsCanRetrieveRemoteArtifacts bool `json:"artifactoryRequestsCanRetrieveRemoteArtifacts,omitempty"` PomRepositoryReferencesCleanupPolicy string `json:"pomRepositoryReferencesCleanupPolicy,omitempty"` DefaultDeploymentRepo string `json:"defaultDeploymentRepo,omitempty"` }
CreateVirtualRepositoryRequest represents a CreateVirtualRepository request
type DeactivateArtifactoryKeyEncryptionRequest ¶
type DeactivateArtifactoryKeyEncryptionRequest struct{}
DeactivateArtifactoryKeyEncryptionRequest represents a DeactivateArtifactoryKeyEncryption request
type DeleteCertificateRequest ¶
type DeleteCertificateRequest struct{}
DeleteCertificateRequest represents a DeleteCertificate request
type DeleteGroupRequest ¶
type DeleteGroupRequest struct{}
DeleteGroupRequest represents a DeleteGroup request
type DeleteItemFromTrashCanRequest ¶
type DeleteItemFromTrashCanRequest struct{}
DeleteItemFromTrashCanRequest represents a DeleteItemFromTrashCan request
type DeletePermissionTargetRequest ¶
type DeletePermissionTargetRequest struct{}
DeletePermissionTargetRequest represents a DeletePermissionTarget request
type DeleteUserRequest ¶
type DeleteUserRequest struct{}
DeleteUserRequest represents a DeleteUser Request
type EmptyTrashCanRequest ¶
type EmptyTrashCanRequest struct{}
EmptyTrashCanRequest represents a EmptyTrashCan request
type ExpirePasswordForAllUsersRequest ¶
type ExpirePasswordForAllUsersRequest struct{}
ExpirePasswordForAllUsersRequest represents a ExpirePasswordForAllUsers Request
type ExpirePasswordForMultipleUsersRequest ¶
type ExpirePasswordForMultipleUsersRequest struct{}
ExpirePasswordForMultipleUsersRequest represents a ExpirePasswordForMultipleUsers Request
type ExpirePasswordForUserRequest ¶
type ExpirePasswordForUserRequest struct{}
ExpirePasswordForUserRequest represents a ExpirePasswordForUser Request
type GenericVersionedRequest ¶
type GenericVersionedRequest struct{}
GenericVersionedRequest is for version checking Some operations don't have a response (think DELETE) but we still want to do a version check on ALL functions anyway This response simply responds to that
type OptimizeSystemStorageRequest ¶
type OptimizeSystemStorageRequest struct{}
OptimizeSystemStorageRequest represents a OptimizeSystemStorage request
type RefreshTokenRequest ¶
type RefreshTokenRequest struct{}
RefreshTokenRequest represents a RefreshToken request
type RegenerateAPIKeyRequest ¶
type RegenerateAPIKeyRequest struct{}
RegenerateAPIKeyRequest represents a RegenerateAPIKey request
type RestoreItemFromTrashCanRequest ¶
type RestoreItemFromTrashCanRequest struct{}
RestoreItemFromTrashCanRequest represents a RestoreItemFromTrashCan request
type RevokeAPIKeyRequest ¶
type RevokeAPIKeyRequest struct{}
RevokeAPIKeyRequest represents a RemoveAPIKey request
type RevokeAllAPIKeysRequest ¶
type RevokeAllAPIKeysRequest struct{}
RevokeAllAPIKeysRequest represents a RevokeAllAPIKeys request
type RevokeTokenRequest ¶
type RevokeTokenRequest struct{}
RevokeTokenRequest represents a RevokeToken request
type RevokeUserAPIKeyRequest ¶
type RevokeUserAPIKeyRequest struct{}
RevokeUserAPIKeyRequest represents a RevokeUserAPIKey request
type SetGPGPassphraseRequest ¶
type SetGPGPassphraseRequest struct{}
SetGPGPassphraseRequest represents a SetGPGPassphrase request
type SetGPGPrivateKeyRequest ¶
type SetGPGPrivateKeyRequest struct{}
SetGPGPrivateKeyRequest represents a SetGPGPrivateKey request
type SetGPGPublicKeyRequest ¶
type SetGPGPublicKeyRequest struct{}
SetGPGPublicKeyRequest represents a SetGPGPublicKey request
type SetPasswordExpirationPolicyRequest ¶
type SetPasswordExpirationPolicyRequest struct { Enabled bool `json:"enabled"` PasswordMaxAge int `json:"passwordMaxAge"` NotifyByEmail bool `json:"notifyByEmail"` }
SetPasswordExpirationPolicyRequest represents a SetPasswordExpirationPolicy request
type UnexpirePasswordForUserRequest ¶
type UnexpirePasswordForUserRequest struct{}
UnexpirePasswordForUserRequest represents a UnexpirePasswordForUser Request
type UnlockAllLockedOutUsersRequest ¶
type UnlockAllLockedOutUsersRequest struct{}
UnlockAllLockedOutUsersRequest represents a UnlockAllLockedOutUsers request
type UnlockLockedOutUserRequest ¶
type UnlockLockedOutUserRequest struct{}
UnlockLockedOutUserRequest represents a UnlockLockedOutUser request
type UnlockLockedOutUsersRequest ¶
type UnlockLockedOutUsersRequest []string
UnlockLockedOutUsersRequest represents a UnlockLockedOutUsers request
type UpdateGroupRequest ¶
type UpdateGroupRequest struct { Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` AutoJoin bool `json:"autoJoin,omitempty"` AdminPrivileges bool `json:"adminPrivileges,omitempty"` Realm string `json:"realm,omitempty"` RealmAttributes string `json:"realmAttributes,omitempty"` }
UpdateGroupRequest represents a UpdateGroup request
type UpdateRepositoryConfigurationRequest ¶
type UpdateRepositoryConfigurationRequest struct{}
UpdateRepositoryConfigurationRequest represents a UpdateRepositoryConfiguration request
type UpdateUserRequest ¶
type UpdateUserRequest struct { Name string `json:"name,omitempty"` Email string `json:"email,omitempty"` Password string `json:"password,omitempty"` Admin bool `json:"admin,omitempty"` ProfileUpdatable bool `json:"profileUpdatable,omitempty"` DisableUIAccess bool `json:"disableUIAccess,omitempty"` InternalPasswordDisabled bool `json:"internalPasswordDisabled,omitempty"` Groups []string `json:"groups,omitempty"` }
UpdateUserRequest represents a user to be updated
type Version ¶
Version is a self-contained go-version Version
func GetMaxVersionFor ¶
func GetMaxVersionFor(a VersionedRequest) Version
GetMaxVersionFor gets the maximum api version required for a response
func GetMinVersionFor ¶
func GetMinVersionFor(a VersionedRequest) Version
GetMinVersionFor gets the minimum api version required for a response
type VersionedRequest ¶
type VersionedRequest interface {
// contains filtered or unexported methods
}
VersionedRequest is an interface for a Rundeck Request that supports versioning information