Help us shape the future of Go! Take the 2026 Go Developer Survey

pypiapi

package
v6.0.1 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var PyPiBatchOperationTypeValues = pyPiBatchOperationTypeValuesType{

	Promote: "promote",

	Delete: "delete",

	PermanentDelete: "permanentDelete",

	RestoreToFeed: "restoreToFeed",
}
View Source
var ResourceAreaId, _ = uuid.Parse("92f0314b-06c5-46e0-abe7-15fd9d13276a")

Functions

This section is empty.

Types

type Client

type Client interface {
	// [Preview API] Delete a package version, moving it to the recycle bin.
	DeletePackageVersion(context.Context, DeletePackageVersionArgs) (*Package, error)
	// [Preview API] Delete a package version from the feed, moving it to the recycle bin.
	DeletePackageVersionFromRecycleBin(context.Context, DeletePackageVersionFromRecycleBinArgs) error
	// [Preview API] Download a python package file directly. This API is intended for manual UI download options, not for programmatic access and scripting.
	DownloadPackage(context.Context, DownloadPackageArgs) (io.ReadCloser, 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) (*PyPiPackageVersionDeletionState, error)
	// [Preview API] Restore a package version from the recycle bin to its associated feed.
	RestorePackageVersionFromRecycleBin(context.Context, RestorePackageVersionFromRecycleBinArgs) error
	// [Preview API] Update state for a package version.
	UpdatePackageVersion(context.Context, UpdatePackageVersionArgs) 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, moving it to the recycle bin.

func (*ClientImpl) DeletePackageVersionFromRecycleBin

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

[Preview API] Delete a package version from the feed, moving it to the recycle bin.

func (*ClientImpl) DownloadPackage

func (client *ClientImpl) DownloadPackage(ctx context.Context, args DownloadPackageArgs) (io.ReadCloser, error)

[Preview API] Download a python package file directly. This API is intended for manual UI download options, not for programmatic access and scripting.

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) (*PyPiPackageVersionDeletionState, 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 state for a package version.

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 DownloadPackageArgs

type DownloadPackageArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (required) Name of the package.
	PackageName *string
	// (required) Version of the package.
	PackageVersion *string
	// (required) Name of the file in the package
	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.
	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 package 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 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 Python package

type PackageVersionDetails

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

type PyPiBatchOperationType

type PyPiBatchOperationType string

Describes PyPi batch operation types.

type PyPiPackageVersionDeletionState

type PyPiPackageVersionDeletionState 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 Python package.

type PyPiPackagesBatchRequest

type PyPiPackagesBatchRequest 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 *PyPiBatchOperationType `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 PyPiRecycleBinPackageVersionDetails

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

type RestorePackageVersionFromRecycleBinArgs

type RestorePackageVersionFromRecycleBinArgs struct {
	// (required) Set the 'Deleted' state to 'false' to restore the package to its feed.
	PackageVersionDetails *PyPiRecycleBinPackageVersionDetails
	// (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 UpdatePackageVersionArgs

type UpdatePackageVersionArgs struct {
	// (required) Details to be updated.
	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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL