maven

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
• type ClientImpl
  • func (client *ClientImpl) DeletePackageVersionFromRecycleBin(ctx context.Context, args DeletePackageVersionFromRecycleBinArgs) error
  • func (client *ClientImpl) DownloadPackage(ctx context.Context, args DownloadPackageArgs) (interface{}, error)
  • func (client *ClientImpl) GetPackageVersion(ctx context.Context, args GetPackageVersionArgs) (*Package, error)
  • func (client *ClientImpl) GetPackageVersionMetadataFromRecycleBin(ctx context.Context, args GetPackageVersionMetadataFromRecycleBinArgs) (*MavenPackageVersionDeletionState, error)
  • func (client *ClientImpl) PackageDelete(ctx context.Context, args PackageDeleteArgs) error
  • func (client *ClientImpl) RestorePackageVersionFromRecycleBin(ctx context.Context, args RestorePackageVersionFromRecycleBinArgs) error
• type DeletePackageVersionFromRecycleBinArgs
• type DownloadPackageArgs
• type GetPackageVersionArgs
• type GetPackageVersionMetadataFromRecycleBinArgs
• type MavenBatchOperationType
• type MavenDistributionManagement
• type MavenMinimalPackageDetails
• type MavenPackage
• type MavenPackageVersionDeletionState
• type MavenPackagesBatchRequest
• type MavenPomBuild
• type MavenPomCi
• type MavenPomCiNotifier
• type MavenPomDependency
• type MavenPomDependencyManagement
• type MavenPomGav
• type MavenPomIssueManagement
• type MavenPomLicense
• type MavenPomMailingList
• type MavenPomMetadata
• type MavenPomOrganization
• type MavenPomParent
• type MavenPomPerson
• type MavenPomScm
• type MavenRecycleBinPackageVersionDetails
• type MavenRepository
• type MavenSnapshotRepository
• type Package
• type PackageDeleteArgs
• type Plugin
• type PluginConfiguration
• type RestorePackageVersionFromRecycleBinArgs

Variables

var MavenBatchOperationTypeValues = mavenBatchOperationTypeValuesType{

	Promote: "promote",

	Delete: "delete",

	PermanentDelete: "permanentDelete",

	RestoreToFeed: "restoreToFeed",
}

var ResourceAreaId, _ = uuid.Parse("6f7f8c07-ff36-473c-bcf3-bd6cc9b6c066")

Types

type Client

type Client interface {
	// [Preview API] Permanently delete a package from a feed's recycle bin.
	DeletePackageVersionFromRecycleBin(context.Context, DeletePackageVersionFromRecycleBinArgs) error
	// [Preview API] Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.
	DownloadPackage(context.Context, DownloadPackageArgs) (interface{}, error)
	// [Preview API] Get information about a package version.
	GetPackageVersion(context.Context, GetPackageVersionArgs) (*Package, error)
	// [Preview API] Get information about a package version in the recycle bin.
	GetPackageVersionMetadataFromRecycleBin(context.Context, GetPackageVersionMetadataFromRecycleBinArgs) (*MavenPackageVersionDeletionState, error)
	// [Preview API] Delete a package version from the feed and move it to the feed's recycle bin.
	PackageDelete(context.Context, PackageDeleteArgs) error
	// [Preview API] Restore a package version from the recycle bin to its associated feed.
	RestorePackageVersionFromRecycleBin(context.Context, RestorePackageVersionFromRecycleBinArgs) error
}

func NewClient

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) DeletePackageVersionFromRecycleBin

func (client *ClientImpl) DeletePackageVersionFromRecycleBin(ctx context.Context, args DeletePackageVersionFromRecycleBinArgs) error

[Preview API] Permanently delete a package from a feed's recycle bin.

func (*ClientImpl) DownloadPackage

func (client *ClientImpl) DownloadPackage(ctx context.Context, args DownloadPackageArgs) (interface{}, error)

[Preview API] Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.

func (*ClientImpl) GetPackageVersion

func (client *ClientImpl) GetPackageVersion(ctx context.Context, args GetPackageVersionArgs) (*Package, error)

[Preview API] Get information about a package version.

func (*ClientImpl) GetPackageVersionMetadataFromRecycleBin

func (client *ClientImpl) GetPackageVersionMetadataFromRecycleBin(ctx context.Context, args GetPackageVersionMetadataFromRecycleBinArgs) (*MavenPackageVersionDeletionState, error)

[Preview API] Get information about a package version in the recycle bin.

func (*ClientImpl) PackageDelete

func (client *ClientImpl) PackageDelete(ctx context.Context, args PackageDeleteArgs) error

[Preview API] Delete a package version from the feed and move it to the feed's recycle bin.

func (*ClientImpl) RestorePackageVersionFromRecycleBin

func (client *ClientImpl) RestorePackageVersionFromRecycleBin(ctx context.Context, args RestorePackageVersionFromRecycleBinArgs) error

[Preview API] Restore a package version from the recycle bin to its associated feed.

type DeletePackageVersionFromRecycleBinArgs

type DeletePackageVersionFromRecycleBinArgs struct {
	// (required) Name or ID of the feed.
	Feed *string
	// (required) Group ID of the package.
	GroupId *string
	// (required) Artifact ID of the package.
	ArtifactId *string
	// (required) Version of the package.
	Version *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeletePackageVersionFromRecycleBin function

type DownloadPackageArgs

type DownloadPackageArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) GroupId of the maven package
	GroupId *string
	// (required) ArtifactId of the maven package
	ArtifactId *string
	// (required) Version of the package
	Version *string
	// (required) File name to download
	FileName *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DownloadPackage function

type GetPackageVersionArgs

type GetPackageVersionArgs struct {
	// (required) Name or ID of the feed.
	Feed *string
	// (required) Group ID of the package.
	GroupId *string
	// (required) Artifact ID of the package.
	ArtifactId *string
	// (required) Version of the package.
	Version *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to show information for deleted packages.
	ShowDeleted *bool
}

Arguments for the GetPackageVersion function

type GetPackageVersionMetadataFromRecycleBinArgs

type GetPackageVersionMetadataFromRecycleBinArgs struct {
	// (required) Name or ID of the feed.
	Feed *string
	// (required) Group ID of the package.
	GroupId *string
	// (required) Artifact ID of the package.
	ArtifactId *string
	// (required) Version of the package.
	Version *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetPackageVersionMetadataFromRecycleBin function

type MavenBatchOperationType

type MavenBatchOperationType string

type MavenDistributionManagement

type MavenDistributionManagement struct {
	Repository         *MavenRepository         `json:"repository,omitempty"`
	SnapshotRepository *MavenSnapshotRepository `json:"snapshotRepository,omitempty"`
}

type MavenMinimalPackageDetails

type MavenMinimalPackageDetails struct {
	// Package artifact ID
	Artifact *string `json:"artifact,omitempty"`
	// Package group ID
	Group *string `json:"group,omitempty"`
	// Package version
	Version *string `json:"version,omitempty"`
}

Identifies a particular Maven package version

type MavenPackage

type MavenPackage struct {
	ArtifactId       *string               `json:"artifactId,omitempty"`
	ArtifactIndex    *webapi.ReferenceLink `json:"artifactIndex,omitempty"`
	ArtifactMetadata *webapi.ReferenceLink `json:"artifactMetadata,omitempty"`
	DeletedDate      *azuredevops.Time     `json:"deletedDate,omitempty"`
	Files            interface{}           `json:"files,omitempty"`
	GroupId          *string               `json:"groupId,omitempty"`
	Pom              *MavenPomMetadata     `json:"pom,omitempty"`
	RequestedFile    *webapi.ReferenceLink `json:"requestedFile,omitempty"`
	SnapshotMetadata *webapi.ReferenceLink `json:"snapshotMetadata,omitempty"`
	Version          *string               `json:"version,omitempty"`
	Versions         interface{}           `json:"versions,omitempty"`
	VersionsIndex    *webapi.ReferenceLink `json:"versionsIndex,omitempty"`
}

type MavenPackageVersionDeletionState

type MavenPackageVersionDeletionState struct {
	// Artifact Id of the package.
	ArtifactId *string `json:"artifactId,omitempty"`
	// UTC date the package was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// Group Id of the package.
	GroupId *string `json:"groupId,omitempty"`
	// Version of the package.
	Version *string `json:"version,omitempty"`
}

Deletion state of a maven package.

type MavenPackagesBatchRequest

type MavenPackagesBatchRequest struct {
	// Data required to perform the operation. This is optional based on type of operation. Use BatchPromoteData if performing a promote operation.
	Data interface{} `json:"data,omitempty"`
	// Type of operation that needs to be performed on packages.
	Operation *MavenBatchOperationType `json:"operation,omitempty"`
	// The packages onto which the operation will be performed.
	Packages *[]MavenMinimalPackageDetails `json:"packages,omitempty"`
}

A batch of operations to apply to package versions.

type MavenPomBuild

type MavenPomBuild struct {
	Plugins *[]Plugin `json:"plugins,omitempty"`
}

type MavenPomCi

type MavenPomCi struct {
	Notifiers *[]MavenPomCiNotifier `json:"notifiers,omitempty"`
	System    *string               `json:"system,omitempty"`
	Url       *string               `json:"url,omitempty"`
}

type MavenPomCiNotifier

type MavenPomCiNotifier struct {
	Configuration *[]string `json:"configuration,omitempty"`
	SendOnError   *string   `json:"sendOnError,omitempty"`
	SendOnFailure *string   `json:"sendOnFailure,omitempty"`
	SendOnSuccess *string   `json:"sendOnSuccess,omitempty"`
	SendOnWarning *string   `json:"sendOnWarning,omitempty"`
	Type          *string   `json:"type,omitempty"`
}

type MavenPomDependency

type MavenPomDependency struct {
	ArtifactId *string `json:"artifactId,omitempty"`
	GroupId    *string `json:"groupId,omitempty"`
	Version    *string `json:"version,omitempty"`
	Optional   *bool   `json:"optional,omitempty"`
	Scope      *string `json:"scope,omitempty"`
	Type       *string `json:"type,omitempty"`
}

type MavenPomDependencyManagement

type MavenPomDependencyManagement struct {
	Dependencies *[]MavenPomDependency `json:"dependencies,omitempty"`
}

type MavenPomGav

type MavenPomGav struct {
	ArtifactId *string `json:"artifactId,omitempty"`
	GroupId    *string `json:"groupId,omitempty"`
	Version    *string `json:"version,omitempty"`
}

type MavenPomIssueManagement

type MavenPomIssueManagement struct {
	System *string `json:"system,omitempty"`
	Url    *string `json:"url,omitempty"`
}

type MavenPomLicense

type MavenPomLicense struct {
	Name         *string `json:"name,omitempty"`
	Url          *string `json:"url,omitempty"`
	Distribution *string `json:"distribution,omitempty"`
}

type MavenPomMailingList

type MavenPomMailingList struct {
	Archive       *string   `json:"archive,omitempty"`
	Name          *string   `json:"name,omitempty"`
	OtherArchives *[]string `json:"otherArchives,omitempty"`
	Post          *string   `json:"post,omitempty"`
	Subscribe     *string   `json:"subscribe,omitempty"`
	Unsubscribe   *string   `json:"unsubscribe,omitempty"`
}

type MavenPomMetadata

type MavenPomMetadata struct {
	ArtifactId             *string                       `json:"artifactId,omitempty"`
	GroupId                *string                       `json:"groupId,omitempty"`
	Version                *string                       `json:"version,omitempty"`
	Build                  *MavenPomBuild                `json:"build,omitempty"`
	CiManagement           *MavenPomCi                   `json:"ciManagement,omitempty"`
	Contributors           *[]MavenPomPerson             `json:"contributors,omitempty"`
	Dependencies           *[]MavenPomDependency         `json:"dependencies,omitempty"`
	DependencyManagement   *MavenPomDependencyManagement `json:"dependencyManagement,omitempty"`
	Description            *string                       `json:"description,omitempty"`
	Developers             *[]MavenPomPerson             `json:"developers,omitempty"`
	DistributionManagement *MavenDistributionManagement  `json:"distributionManagement,omitempty"`
	InceptionYear          *string                       `json:"inceptionYear,omitempty"`
	IssueManagement        *MavenPomIssueManagement      `json:"issueManagement,omitempty"`
	Licenses               *[]MavenPomLicense            `json:"licenses,omitempty"`
	MailingLists           *[]MavenPomMailingList        `json:"mailingLists,omitempty"`
	ModelVersion           *string                       `json:"modelVersion,omitempty"`
	Modules                *[]string                     `json:"modules,omitempty"`
	Name                   *string                       `json:"name,omitempty"`
	Organization           *MavenPomOrganization         `json:"organization,omitempty"`
	Packaging              *string                       `json:"packaging,omitempty"`
	Parent                 *MavenPomParent               `json:"parent,omitempty"`
	Prerequisites          *map[string]string            `json:"prerequisites,omitempty"`
	Properties             *map[string]string            `json:"properties,omitempty"`
	Scm                    *MavenPomScm                  `json:"scm,omitempty"`
	Url                    *string                       `json:"url,omitempty"`
}

type MavenPomOrganization

type MavenPomOrganization struct {
	Name *string `json:"name,omitempty"`
	Url  *string `json:"url,omitempty"`
}

type MavenPomParent

type MavenPomParent struct {
	ArtifactId   *string `json:"artifactId,omitempty"`
	GroupId      *string `json:"groupId,omitempty"`
	Version      *string `json:"version,omitempty"`
	RelativePath *string `json:"relativePath,omitempty"`
}

type MavenPomPerson

type MavenPomPerson struct {
	Email           *string   `json:"email,omitempty"`
	Id              *string   `json:"id,omitempty"`
	Name            *string   `json:"name,omitempty"`
	Organization    *string   `json:"organization,omitempty"`
	OrganizationUrl *string   `json:"organizationUrl,omitempty"`
	Roles           *[]string `json:"roles,omitempty"`
	Timezone        *string   `json:"timezone,omitempty"`
	Url             *string   `json:"url,omitempty"`
}

type MavenPomScm

type MavenPomScm struct {
	Connection          *string `json:"connection,omitempty"`
	DeveloperConnection *string `json:"developerConnection,omitempty"`
	Tag                 *string `json:"tag,omitempty"`
	Url                 *string `json:"url,omitempty"`
}

type MavenRecycleBinPackageVersionDetails

type MavenRecycleBinPackageVersionDetails struct {
	// Setting to false will undo earlier deletion and restore the package to feed.
	Deleted *bool `json:"deleted,omitempty"`
}

type MavenRepository

type MavenRepository struct {
	UniqueVersion *bool `json:"uniqueVersion,omitempty"`
}

type MavenSnapshotRepository

type MavenSnapshotRepository struct {
	UniqueVersion *bool `json:"uniqueVersion,omitempty"`
}

type Package

type Package struct {
	// Related REST links.
	Links interface{} `json:"_links,omitempty"`
	// If and when the package was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// Package Id.
	Id *string `json:"id,omitempty"`
	// The display name of the package.
	Name *string `json:"name,omitempty"`
	// If and when the package was permanently deleted.
	PermanentlyDeletedDate *azuredevops.Time `json:"permanentlyDeletedDate,omitempty"`
	// The history of upstream sources for this package. The first source in the list is the immediate source from which this package was saved.
	SourceChain *[]packagingshared.UpstreamSourceInfo `json:"sourceChain,omitempty"`
	// The version of the package.
	Version *string `json:"version,omitempty"`
}

Package version metadata for a Maven package

type PackageDeleteArgs

type PackageDeleteArgs struct {
	// (required) Name or ID of the feed.
	Feed *string
	// (required) Group ID of the package.
	GroupId *string
	// (required) Artifact ID of the package.
	ArtifactId *string
	// (required) Version of the package.
	Version *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the PackageDelete function

type Plugin

type Plugin struct {
	ArtifactId    *string              `json:"artifactId,omitempty"`
	GroupId       *string              `json:"groupId,omitempty"`
	Version       *string              `json:"version,omitempty"`
	Configuration *PluginConfiguration `json:"configuration,omitempty"`
}

type PluginConfiguration

type PluginConfiguration struct {
	GoalPrefix *string `json:"goalPrefix,omitempty"`
}

type RestorePackageVersionFromRecycleBinArgs

type RestorePackageVersionFromRecycleBinArgs struct {
	// (required) Set the 'Deleted' property to false to restore the package.
	PackageVersionDetails *MavenRecycleBinPackageVersionDetails
	// (required) Name or ID of the feed.
	Feed *string
	// (required) Group ID of the package.
	GroupId *string
	// (required) Artifact ID of the package.
	ArtifactId *string
	// (required) Version of the package.
	Version *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the RestorePackageVersionFromRecycleBin function