universal

package
v7.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ResourceAreaId, _ = uuid.Parse("d397749b-f115-4027-b6dd-77a65dd10d21")
View Source 
var UPackBatchOperationTypeValues = uPackBatchOperationTypeValuesType{

	Promote: "promote",

	Delete: "delete",

	PermanentDelete: "permanentDelete",

	RestoreToFeed: "restoreToFeed",
}
View Source 
var UPackGetPackageMetadataIntentValues = uPackGetPackageMetadataIntentValuesType{

	FetchMetadataOnly: "fetchMetadataOnly",

	Download: "download",
}

Functions

This section is empty.

Types

type Client 

type Client interface {
	// [Preview API] Delete a package version from a feed's recycle bin.
	DeletePackageVersion(context.Context, DeletePackageVersionArgs) (*Package, error)
	// [Preview API] Delete a package version from the recycle bin.
	DeletePackageVersionFromRecycleBin(context.Context, DeletePackageVersionFromRecycleBinArgs) error
	// [Preview API] Show 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) (*UPackPackageVersionDeletionState, error)
	// [Preview API] Restore a package version from the recycle bin to its associated feed.
	RestorePackageVersionFromRecycleBin(context.Context, RestorePackageVersionFromRecycleBinArgs) error
	// [Preview API] Update information for a package version.
	UpdatePackageVersion(context.Context, UpdatePackageVersionArgs) error
	// [Preview API] Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.
	UpdatePackageVersions(context.Context, UpdatePackageVersionsArgs) error
	// [Preview API] Delete or restore several package versions from the recycle bin.
	UpdateRecycleBinPackageVersions(context.Context, UpdateRecycleBinPackageVersionsArgs) error
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) DeletePackageVersion 

func (client *ClientImpl) DeletePackageVersion(ctx context.Context, args DeletePackageVersionArgs) (*Package, error)

[Preview API] Delete a package version from a feed's recycle bin.

func (*ClientImpl) DeletePackageVersionFromRecycleBin 

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

[Preview API] Delete a package version from the recycle bin.

func (*ClientImpl) GetPackageVersion 

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

[Preview API] Show information about a package version.

func (*ClientImpl) GetPackageVersionMetadataFromRecycleBin 

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

[Preview API] Get information about a package version in the 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.

func (*ClientImpl) UpdatePackageVersion 

func (client *ClientImpl) UpdatePackageVersion(ctx context.Context, args UpdatePackageVersionArgs) error

[Preview API] Update information for a package version.

func (*ClientImpl) UpdatePackageVersions 

func (client *ClientImpl) UpdatePackageVersions(ctx context.Context, args UpdatePackageVersionsArgs) error

[Preview API] Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.

func (*ClientImpl) UpdateRecycleBinPackageVersions 

func (client *ClientImpl) UpdateRecycleBinPackageVersions(ctx context.Context, args UpdateRecycleBinPackageVersionsArgs) error

[Preview API] Delete or restore several package versions from the recycle bin.

type DeletePackageVersionArgs 

type DeletePackageVersionArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeletePackageVersion function

type DeletePackageVersionFromRecycleBinArgs 

type DeletePackageVersionFromRecycleBinArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeletePackageVersionFromRecycleBin function

type GetPackageVersionArgs 

type GetPackageVersionArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to show information for deleted versions
	ShowDeleted *bool
}

Arguments for the GetPackageVersion function

type GetPackageVersionMetadataFromRecycleBinArgs 

type GetPackageVersionMetadataFromRecycleBinArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetPackageVersionMetadataFromRecycleBin function

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 version of the package.
	Version *string `json:"version,omitempty"`
}

Package version metadata for a Universal package

type PackageVersionDetails 

type PackageVersionDetails struct {
	// The view to which the package version will be added
	Views *webapi.JsonPatchOperation `json:"views,omitempty"`
}

type RestorePackageVersionFromRecycleBinArgs 

type RestorePackageVersionFromRecycleBinArgs struct {
	// (required) Set the 'Deleted' property to 'false' to restore the package.
	PackageVersionDetails *UPackRecycleBinPackageVersionDetails
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the RestorePackageVersionFromRecycleBin function

type UPackBatchOperationType 

type UPackBatchOperationType string

Describes UPack batch operation types.

type UPackGetPackageMetadataIntent 

type UPackGetPackageMetadataIntent string

Describes intent when calling the API GetPackageMetadata.

type UPackPackageVersionDeletionState 

type UPackPackageVersionDeletionState struct {
	// UTC date the package was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// Name of the package.
	Name *string `json:"name,omitempty"`
	// Version of the package.
	Version *string `json:"version,omitempty"`
}

Deletion state of a Universal package.

type UPackPackagesBatchRequest 

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

A batch of operations to apply to package versions.

type UPackRecycleBinPackageVersionDetails 

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

type UpdatePackageVersionArgs 

type UpdatePackageVersionArgs struct {
	// (required)
	PackageVersionDetails *PackageVersionDetails
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdatePackageVersion function

type UpdatePackageVersionsArgs 

type UpdatePackageVersionsArgs struct {
	// (required) Information about the packages to update, the operation to perform, and its associated data.
	BatchRequest *UPackPackagesBatchRequest
	// (required) Name or ID of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdatePackageVersions function

type UpdateRecycleBinPackageVersionsArgs 

type UpdateRecycleBinPackageVersionsArgs struct {
	// (required) Information about the packages to update, the operation to perform, and its associated data. <c>Operation</c> must be <c>PermanentDelete</c> or <c>RestoreToFeed</c>
	BatchRequest *UPackPackagesBatchRequest
	// (required) Feed which contains the packages to update.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdateRecycleBinPackageVersions function

Source Files

View all Source files

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.