feed

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: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ChangeTypeValues = changeTypeValuesType{

	AddOrUpdate: "addOrUpdate",

	Delete: "delete",

	PermanentDelete: "permanentDelete",
}
View Source 
var FeedBatchOperationValues = feedBatchOperationValuesType{
	SaveCachedPackages: "saveCachedPackages",
}
View Source 
var FeedCapabilitiesValues = feedCapabilitiesValuesType{

	None: "none",

	UpstreamV2: "upstreamV2",

	UnderMaintenance: "underMaintenance",

	DefaultCapabilities: "defaultCapabilities",
}
View Source 
var FeedRoleValues = feedRoleValuesType{

	Custom: "custom",

	None: "none",

	Reader: "reader",

	Contributor: "contributor",

	Administrator: "administrator",

	Collaborator: "collaborator",
}
View Source 
var FeedViewTypeValues = feedViewTypeValuesType{

	None: "none",

	Release: "release",

	Implicit: "implicit",
}
View Source 
var FeedVisibilityValues = feedVisibilityValuesType{

	Private: "private",

	Collection: "collection",

	Organization: "organization",

	AadTenant: "aadTenant",
}
View Source 
var GlobalRoleValues = globalRoleValuesType{

	Custom: "custom",

	None: "none",

	FeedCreator: "feedCreator",

	Administrator: "administrator",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("7ab4e64e-c4d8-4f50-ae73-5ef2e21642a5")
View Source 
var UpstreamSourceTypeValues = upstreamSourceTypeValuesType{

	Public: "public",

	Internal: "internal",
}
View Source 
var UpstreamStatusValues = upstreamStatusValuesType{

	Ok: "ok",

	Disabled: "disabled",
}

Functions

This section is empty.

Types

type BuildPackage 

type BuildPackage struct {
	// Display name of the feed.
	FeedName *string `json:"feedName,omitempty"`
	// Package version description.
	PackageDescription *string `json:"packageDescription,omitempty"`
	// Display name of the package.
	PackageName *string `json:"packageName,omitempty"`
	// Version of the package.
	PackageVersion *string `json:"packageVersion,omitempty"`
	// TFS project id.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// Type of the package.
	ProtocolType *string `json:"protocolType,omitempty"`
}

type ChangeType 

type ChangeType string

Type of operation last performed.

type Client 

type Client interface {
	// [Preview API] Create a feed, a container for various package types.
	CreateFeed(context.Context, CreateFeedArgs) (*Feed, error)
	// [Preview API] Create a new view on the referenced feed.
	CreateFeedView(context.Context, CreateFeedViewArgs) (*FeedView, error)
	// [Preview API] Remove a feed and all its packages. The feed moves to the recycle bin and is reversible.
	DeleteFeed(context.Context, DeleteFeedArgs) error
	// [Preview API] Delete the retention policy for a feed.
	DeleteFeedRetentionPolicies(context.Context, DeleteFeedRetentionPoliciesArgs) error
	// [Preview API] Delete a feed view.
	DeleteFeedView(context.Context, DeleteFeedViewArgs) error
	// [Preview API] Queues a job to remove all package versions from a feed's recycle bin
	EmptyRecycleBin(context.Context, EmptyRecycleBinArgs) (*operations.OperationReference, error)
	// [Preview API] Generate a SVG badge for the latest version of a package.  The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.
	GetBadge(context.Context, GetBadgeArgs) (io.ReadCloser, error)
	// [Preview API] Get the settings for a specific feed.
	GetFeed(context.Context, GetFeedArgs) (*Feed, error)
	// [Preview API] Query a feed to determine its current state.
	GetFeedChange(context.Context, GetFeedChangeArgs) (*FeedChange, error)
	// [Preview API] Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.
	GetFeedChanges(context.Context, GetFeedChangesArgs) (*FeedChangesResponse, error)
	// [Preview API] Get the permissions for a feed.
	GetFeedPermissions(context.Context, GetFeedPermissionsArgs) (*[]FeedPermission, error)
	// [Preview API] Get the retention policy for a feed.
	GetFeedRetentionPolicies(context.Context, GetFeedRetentionPoliciesArgs) (*FeedRetentionPolicy, error)
	// [Preview API] Get all feeds in an account where you have the provided role access.
	GetFeeds(context.Context, GetFeedsArgs) (*[]Feed, error)
	// [Preview API] Query for feeds within the recycle bin.
	GetFeedsFromRecycleBin(context.Context, GetFeedsFromRecycleBinArgs) (*[]Feed, error)
	// [Preview API] Get a view by Id.
	GetFeedView(context.Context, GetFeedViewArgs) (*FeedView, error)
	// [Preview API] Get all views for a feed.
	GetFeedViews(context.Context, GetFeedViewsArgs) (*[]FeedView, error)
	// [Preview API] Get all service-wide feed creation and administration permissions.
	GetGlobalPermissions(context.Context, GetGlobalPermissionsArgs) (*[]GlobalPermission, error)
	// [Preview API] Get details about a specific package.
	GetPackage(context.Context, GetPackageArgs) (*Package, error)
	// [Preview API] Get a batch of package changes made to a feed.  The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch.  While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate.
	GetPackageChanges(context.Context, GetPackageChangesArgs) (*PackageChangesResponse, error)
	// [Preview API] Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.
	GetPackages(context.Context, GetPackagesArgs) (*[]Package, error)
	// [Preview API] Get details about a specific package version.
	GetPackageVersion(context.Context, GetPackageVersionArgs) (*PackageVersion, error)
	// [Preview API] Gets provenance for a package version.
	GetPackageVersionProvenance(context.Context, GetPackageVersionProvenanceArgs) (*PackageVersionProvenance, error)
	// [Preview API] Get a list of package versions, optionally filtering by state.
	GetPackageVersions(context.Context, GetPackageVersionsArgs) (*[]PackageVersion, error)
	// [Preview API] Get information about a package and all its versions within the recycle bin.
	GetRecycleBinPackage(context.Context, GetRecycleBinPackageArgs) (*Package, error)
	// [Preview API] Query for packages within the recycle bin.
	GetRecycleBinPackages(context.Context, GetRecycleBinPackagesArgs) (*[]Package, error)
	// [Preview API] Get information about a package version within the recycle bin.
	GetRecycleBinPackageVersion(context.Context, GetRecycleBinPackageVersionArgs) (*RecycleBinPackageVersion, error)
	// [Preview API] Get a list of package versions within the recycle bin.
	GetRecycleBinPackageVersions(context.Context, GetRecycleBinPackageVersionsArgs) (*[]RecycleBinPackageVersion, error)
	// [Preview API]
	PermanentDeleteFeed(context.Context, PermanentDeleteFeedArgs) error
	// [Preview API]
	QueryPackageMetrics(context.Context, QueryPackageMetricsArgs) (*[]PackageMetrics, error)
	// [Preview API]
	QueryPackageVersionMetrics(context.Context, QueryPackageVersionMetricsArgs) (*[]PackageVersionMetrics, error)
	// [Preview API]
	RestoreDeletedFeed(context.Context, RestoreDeletedFeedArgs) error
	// [Preview API] Update the permissions on a feed.
	SetFeedPermissions(context.Context, SetFeedPermissionsArgs) (*[]FeedPermission, error)
	// [Preview API] Set the retention policy for a feed.
	SetFeedRetentionPolicies(context.Context, SetFeedRetentionPoliciesArgs) (*FeedRetentionPolicy, error)
	// [Preview API] Set service-wide permissions that govern feed creation and administration.
	SetGlobalPermissions(context.Context, SetGlobalPermissionsArgs) (*[]GlobalPermission, error)
	// [Preview API] Change the attributes of a feed.
	UpdateFeed(context.Context, UpdateFeedArgs) (*Feed, error)
	// [Preview API] Update a view.
	UpdateFeedView(context.Context, UpdateFeedViewArgs) (*FeedView, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateFeed 

func (client *ClientImpl) CreateFeed(ctx context.Context, args CreateFeedArgs) (*Feed, error)

[Preview API] Create a feed, a container for various package types.

func (*ClientImpl) CreateFeedView 

func (client *ClientImpl) CreateFeedView(ctx context.Context, args CreateFeedViewArgs) (*FeedView, error)

[Preview API] Create a new view on the referenced feed.

func (*ClientImpl) DeleteFeed 

func (client *ClientImpl) DeleteFeed(ctx context.Context, args DeleteFeedArgs) error

[Preview API] Remove a feed and all its packages. The feed moves to the recycle bin and is reversible.

func (*ClientImpl) DeleteFeedRetentionPolicies 

func (client *ClientImpl) DeleteFeedRetentionPolicies(ctx context.Context, args DeleteFeedRetentionPoliciesArgs) error

[Preview API] Delete the retention policy for a feed.

func (*ClientImpl) DeleteFeedView 

func (client *ClientImpl) DeleteFeedView(ctx context.Context, args DeleteFeedViewArgs) error

[Preview API] Delete a feed view.

func (*ClientImpl) EmptyRecycleBin 

func (client *ClientImpl) EmptyRecycleBin(ctx context.Context, args EmptyRecycleBinArgs) (*operations.OperationReference, error)

[Preview API] Queues a job to remove all package versions from a feed's recycle bin

func (*ClientImpl) GetBadge 

func (client *ClientImpl) GetBadge(ctx context.Context, args GetBadgeArgs) (io.ReadCloser, error)

[Preview API] Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.

func (*ClientImpl) GetFeed 

func (client *ClientImpl) GetFeed(ctx context.Context, args GetFeedArgs) (*Feed, error)

[Preview API] Get the settings for a specific feed.

func (*ClientImpl) GetFeedChange 

func (client *ClientImpl) GetFeedChange(ctx context.Context, args GetFeedChangeArgs) (*FeedChange, error)

[Preview API] Query a feed to determine its current state.

func (*ClientImpl) GetFeedChanges 

func (client *ClientImpl) GetFeedChanges(ctx context.Context, args GetFeedChangesArgs) (*FeedChangesResponse, error)

[Preview API] Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.

func (*ClientImpl) GetFeedPermissions 

func (client *ClientImpl) GetFeedPermissions(ctx context.Context, args GetFeedPermissionsArgs) (*[]FeedPermission, error)

[Preview API] Get the permissions for a feed.

func (*ClientImpl) GetFeedRetentionPolicies 

func (client *ClientImpl) GetFeedRetentionPolicies(ctx context.Context, args GetFeedRetentionPoliciesArgs) (*FeedRetentionPolicy, error)

[Preview API] Get the retention policy for a feed.

func (*ClientImpl) GetFeedView 

func (client *ClientImpl) GetFeedView(ctx context.Context, args GetFeedViewArgs) (*FeedView, error)

[Preview API] Get a view by Id.

func (*ClientImpl) GetFeedViews 

func (client *ClientImpl) GetFeedViews(ctx context.Context, args GetFeedViewsArgs) (*[]FeedView, error)

[Preview API] Get all views for a feed.

func (*ClientImpl) GetFeeds 

func (client *ClientImpl) GetFeeds(ctx context.Context, args GetFeedsArgs) (*[]Feed, error)

[Preview API] Get all feeds in an account where you have the provided role access.

func (*ClientImpl) GetFeedsFromRecycleBin 

func (client *ClientImpl) GetFeedsFromRecycleBin(ctx context.Context, args GetFeedsFromRecycleBinArgs) (*[]Feed, error)

[Preview API] Query for feeds within the recycle bin.

func (*ClientImpl) GetGlobalPermissions 

func (client *ClientImpl) GetGlobalPermissions(ctx context.Context, args GetGlobalPermissionsArgs) (*[]GlobalPermission, error)

[Preview API] Get all service-wide feed creation and administration permissions.

func (*ClientImpl) GetPackage 

func (client *ClientImpl) GetPackage(ctx context.Context, args GetPackageArgs) (*Package, error)

[Preview API] Get details about a specific package.

func (*ClientImpl) GetPackageChanges 

func (client *ClientImpl) GetPackageChanges(ctx context.Context, args GetPackageChangesArgs) (*PackageChangesResponse, error)

[Preview API] Get a batch of package changes made to a feed. The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch. While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate.

func (*ClientImpl) GetPackageVersion 

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

[Preview API] Get details about a specific package version.

func (*ClientImpl) GetPackageVersionProvenance 

func (client *ClientImpl) GetPackageVersionProvenance(ctx context.Context, args GetPackageVersionProvenanceArgs) (*PackageVersionProvenance, error)

[Preview API] Gets provenance for a package version.

func (*ClientImpl) GetPackageVersions 

func (client *ClientImpl) GetPackageVersions(ctx context.Context, args GetPackageVersionsArgs) (*[]PackageVersion, error)

[Preview API] Get a list of package versions, optionally filtering by state.

func (*ClientImpl) GetPackages 

func (client *ClientImpl) GetPackages(ctx context.Context, args GetPackagesArgs) (*[]Package, error)

[Preview API] Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.

func (*ClientImpl) GetRecycleBinPackage 

func (client *ClientImpl) GetRecycleBinPackage(ctx context.Context, args GetRecycleBinPackageArgs) (*Package, error)

[Preview API] Get information about a package and all its versions within the recycle bin.

func (*ClientImpl) GetRecycleBinPackageVersion 

func (client *ClientImpl) GetRecycleBinPackageVersion(ctx context.Context, args GetRecycleBinPackageVersionArgs) (*RecycleBinPackageVersion, error)

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

func (*ClientImpl) GetRecycleBinPackageVersions 

func (client *ClientImpl) GetRecycleBinPackageVersions(ctx context.Context, args GetRecycleBinPackageVersionsArgs) (*[]RecycleBinPackageVersion, error)

[Preview API] Get a list of package versions within the recycle bin.

func (*ClientImpl) GetRecycleBinPackages 

func (client *ClientImpl) GetRecycleBinPackages(ctx context.Context, args GetRecycleBinPackagesArgs) (*[]Package, error)

[Preview API] Query for packages within the recycle bin.

func (*ClientImpl) PermanentDeleteFeed 

func (client *ClientImpl) PermanentDeleteFeed(ctx context.Context, args PermanentDeleteFeedArgs) error

[Preview API]

func (*ClientImpl) QueryPackageMetrics 

func (client *ClientImpl) QueryPackageMetrics(ctx context.Context, args QueryPackageMetricsArgs) (*[]PackageMetrics, error)

[Preview API]

func (*ClientImpl) QueryPackageVersionMetrics 

func (client *ClientImpl) QueryPackageVersionMetrics(ctx context.Context, args QueryPackageVersionMetricsArgs) (*[]PackageVersionMetrics, error)

[Preview API]

func (*ClientImpl) RestoreDeletedFeed 

func (client *ClientImpl) RestoreDeletedFeed(ctx context.Context, args RestoreDeletedFeedArgs) error

[Preview API]

func (*ClientImpl) SetFeedPermissions 

func (client *ClientImpl) SetFeedPermissions(ctx context.Context, args SetFeedPermissionsArgs) (*[]FeedPermission, error)

[Preview API] Update the permissions on a feed.

func (*ClientImpl) SetFeedRetentionPolicies 

func (client *ClientImpl) SetFeedRetentionPolicies(ctx context.Context, args SetFeedRetentionPoliciesArgs) (*FeedRetentionPolicy, error)

[Preview API] Set the retention policy for a feed.

func (*ClientImpl) SetGlobalPermissions 

func (client *ClientImpl) SetGlobalPermissions(ctx context.Context, args SetGlobalPermissionsArgs) (*[]GlobalPermission, error)

[Preview API] Set service-wide permissions that govern feed creation and administration.

func (*ClientImpl) UpdateFeed 

func (client *ClientImpl) UpdateFeed(ctx context.Context, args UpdateFeedArgs) (*Feed, error)

[Preview API] Change the attributes of a feed.

func (*ClientImpl) UpdateFeedView 

func (client *ClientImpl) UpdateFeedView(ctx context.Context, args UpdateFeedViewArgs) (*FeedView, error)

[Preview API] Update a view.

type CreateFeedArgs 

type CreateFeedArgs struct {
	// (required) A JSON object containing both required and optional attributes for the feed. Name is the only required value.
	Feed *Feed
	// (optional) Project ID or project name
	Project *string
}

Arguments for the CreateFeed function

type CreateFeedViewArgs 

type CreateFeedViewArgs struct {
	// (required) View to be created.
	View *FeedView
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the CreateFeedView function

type DeleteFeedArgs 

type DeleteFeedArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteFeed function

type DeleteFeedRetentionPoliciesArgs 

type DeleteFeedRetentionPoliciesArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteFeedRetentionPolicies function

type DeleteFeedViewArgs 

type DeleteFeedViewArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Name or Id of the view.
	ViewId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteFeedView function

type EmptyRecycleBinArgs 

type EmptyRecycleBinArgs struct {
	// (required) Name or Id of the feed
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the EmptyRecycleBin function

type Feed 

type Feed struct {
	// Supported capabilities of a feed.
	Capabilities *FeedCapabilities `json:"capabilities,omitempty"`
	// This will either be the feed GUID or the feed GUID and view GUID depending on how the feed was accessed.
	FullyQualifiedId *string `json:"fullyQualifiedId,omitempty"`
	// Full name of the view, in feed@view format.
	FullyQualifiedName *string `json:"fullyQualifiedName,omitempty"`
	// A GUID that uniquely identifies this feed.
	Id *uuid.UUID `json:"id,omitempty"`
	// If set, all packages in the feed are immutable.  It is important to note that feed views are immutable; therefore, this flag will always be set for views.
	IsReadOnly *bool `json:"isReadOnly,omitempty"`
	// A name for the feed. feed names must follow these rules: <list type="bullet"><item><description> Must not exceed 64 characters </description></item><item><description> Must not contain whitespaces </description></item><item><description> Must not start with an underscore or a period </description></item><item><description> Must not end with a period </description></item><item><description> Must not contain any of the following illegal characters: <![CDATA[ @, ~, ;, {, }, \, +, =, <, >, |, /, \\, ?, :, &, $, *, \", #, [, ] ]]></description></item></list>
	Name *string `json:"name,omitempty"`
	// The project that this feed is associated with.
	Project *ProjectReference `json:"project,omitempty"`
	// This should always be true. Setting to false will override all sources in UpstreamSources.
	UpstreamEnabled *bool `json:"upstreamEnabled,omitempty"`
	// A list of sources that this feed will fetch packages from.  An empty list indicates that this feed will not search any additional sources for packages.
	UpstreamSources *[]UpstreamSource `json:"upstreamSources,omitempty"`
	// Definition of the view.
	View *FeedView `json:"view,omitempty"`
	// View Id.
	ViewId *uuid.UUID `json:"viewId,omitempty"`
	// View name.
	ViewName *string `json:"viewName,omitempty"`
	// Related REST links.
	Links interface{} `json:"_links,omitempty"`
	// If set, this feed supports generation of package badges.
	BadgesEnabled *bool `json:"badgesEnabled,omitempty"`
	// The view that the feed administrator has indicated is the default experience for readers.
	DefaultViewId *uuid.UUID `json:"defaultViewId,omitempty"`
	// The date that this feed was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// A description for the feed.  Descriptions must not exceed 255 characters.
	Description *string `json:"description,omitempty"`
	// If set, the feed will hide all deleted/unpublished versions
	HideDeletedPackageVersions *bool `json:"hideDeletedPackageVersions,omitempty"`
	// The date that this feed was permanently deleted.
	PermanentDeletedDate *azuredevops.Time `json:"permanentDeletedDate,omitempty"`
	// Explicit permissions for the feed.
	Permissions *[]FeedPermission `json:"permissions,omitempty"`
	// The date that this feed is scheduled to be permanently deleted.
	ScheduledPermanentDeleteDate *azuredevops.Time `json:"scheduledPermanentDeleteDate,omitempty"`
	// If set, time that the UpstreamEnabled property was changed. Will be null if UpstreamEnabled was never changed after Feed creation.
	UpstreamEnabledChangedDate *azuredevops.Time `json:"upstreamEnabledChangedDate,omitempty"`
	// The URL of the base feed in GUID form.
	Url *string `json:"url,omitempty"`
}

A container for artifacts.

type FeedBatchOperation 

type FeedBatchOperation string

type FeedCapabilities 

type FeedCapabilities string

[Flags] Capabilities are used to track features that are available to individual feeds. In general, newly created feeds should be given all available capabilities. These flags track breaking changes in behaviour to feeds, or changes that require user reaction.

type FeedChange 

type FeedChange struct {
	// The state of the feed after a after a create, update, or delete operation completed.
	Feed *Feed `json:"feed,omitempty"`
	// A token that identifies the next change in the log of changes.
	FeedContinuationToken *uint64 `json:"feedContinuationToken,omitempty"`
	// The type of operation.
	ChangeType *ChangeType `json:"changeType,omitempty"`
	// A token that identifies the latest package change for this feed.  This can be used to quickly determine if there have been any changes to packages in a specific feed.
	LatestPackageContinuationToken *uint64 `json:"latestPackageContinuationToken,omitempty"`
}

A container that encapsulates the state of the feed after a create, update, or delete.

type FeedChangesResponse 

type FeedChangesResponse struct {
	Links interface{} `json:"_links,omitempty"`
	// The number of changes in this set.
	Count *int `json:"count,omitempty"`
	// A container that encapsulates the state of the feed after a create, update, or delete.
	FeedChanges *[]FeedChange `json:"feedChanges,omitempty"`
	// When iterating through the log of changes this value indicates the value that should be used for the next continuation token.
	NextFeedContinuationToken *uint64 `json:"nextFeedContinuationToken,omitempty"`
}

A result set containing the feed changes for the range that was requested.

type FeedCore 

type FeedCore struct {
	// Supported capabilities of a feed.
	Capabilities *FeedCapabilities `json:"capabilities,omitempty"`
	// This will either be the feed GUID or the feed GUID and view GUID depending on how the feed was accessed.
	FullyQualifiedId *string `json:"fullyQualifiedId,omitempty"`
	// Full name of the view, in feed@view format.
	FullyQualifiedName *string `json:"fullyQualifiedName,omitempty"`
	// A GUID that uniquely identifies this feed.
	Id *uuid.UUID `json:"id,omitempty"`
	// If set, all packages in the feed are immutable.  It is important to note that feed views are immutable; therefore, this flag will always be set for views.
	IsReadOnly *bool `json:"isReadOnly,omitempty"`
	// A name for the feed. feed names must follow these rules: <list type="bullet"><item><description> Must not exceed 64 characters </description></item><item><description> Must not contain whitespaces </description></item><item><description> Must not start with an underscore or a period </description></item><item><description> Must not end with a period </description></item><item><description> Must not contain any of the following illegal characters: <![CDATA[ @, ~, ;, {, }, \, +, =, <, >, |, /, \\, ?, :, &, $, *, \", #, [, ] ]]></description></item></list>
	Name *string `json:"name,omitempty"`
	// The project that this feed is associated with.
	Project *ProjectReference `json:"project,omitempty"`
	// This should always be true. Setting to false will override all sources in UpstreamSources.
	UpstreamEnabled *bool `json:"upstreamEnabled,omitempty"`
	// A list of sources that this feed will fetch packages from.  An empty list indicates that this feed will not search any additional sources for packages.
	UpstreamSources *[]UpstreamSource `json:"upstreamSources,omitempty"`
	// Definition of the view.
	View *FeedView `json:"view,omitempty"`
	// View Id.
	ViewId *uuid.UUID `json:"viewId,omitempty"`
	// View name.
	ViewName *string `json:"viewName,omitempty"`
}

An object that contains all of the settings for a specific feed.

type FeedIdsResult 

type FeedIdsResult struct {
	Id          *uuid.UUID `json:"id,omitempty"`
	Name        *string    `json:"name,omitempty"`
	ProjectId   *uuid.UUID `json:"projectId,omitempty"`
	ProjectName *string    `json:"projectName,omitempty"`
}

type FeedPermission 

type FeedPermission struct {
	// Display name for the identity.
	DisplayName *string `json:"displayName,omitempty"`
	// Identity associated with this role.
	IdentityDescriptor *string `json:"identityDescriptor,omitempty"`
	// Id of the identity associated with this role.
	IdentityId *uuid.UUID `json:"identityId,omitempty"`
	// Boolean indicating whether the role is inherited or set directly.
	IsInheritedRole *bool `json:"isInheritedRole,omitempty"`
	// The role for this identity on a feed.
	Role *FeedRole `json:"role,omitempty"`
}

Permissions for a feed.

type FeedRetentionPolicy 

type FeedRetentionPolicy struct {
	// This attribute is deprecated and is not honoured by retention
	AgeLimitInDays *int `json:"ageLimitInDays,omitempty"`
	// Maximum versions to preserve per package and package type.
	CountLimit *int `json:"countLimit,omitempty"`
	// Number of days to preserve a package version after its latest download.
	DaysToKeepRecentlyDownloadedPackages *int `json:"daysToKeepRecentlyDownloadedPackages,omitempty"`
}

Retention policy settings.

type FeedRole 

type FeedRole string

type FeedUpdate 

type FeedUpdate struct {
	// If set, the feed will allow upload of packages that exist on the upstream
	AllowUpstreamNameConflict *bool `json:"allowUpstreamNameConflict,omitempty"`
	// If set, this feed supports generation of package badges.
	BadgesEnabled *bool `json:"badgesEnabled,omitempty"`
	// The view that the feed administrator has indicated is the default experience for readers.
	DefaultViewId *uuid.UUID `json:"defaultViewId,omitempty"`
	// A description for the feed.  Descriptions must not exceed 255 characters.
	Description *string `json:"description,omitempty"`
	// If set, feed will hide all deleted/unpublished versions
	HideDeletedPackageVersions *bool `json:"hideDeletedPackageVersions,omitempty"`
	// A GUID that uniquely identifies this feed.
	Id *uuid.UUID `json:"id,omitempty"`
	// A name for the feed. feed names must follow these rules: <list type="bullet"><item><description> Must not exceed 64 characters </description></item><item><description> Must not contain whitespaces </description></item><item><description> Must not start with an underscore or a period </description></item><item><description> Must not end with a period </description></item><item><description> Must not contain any of the following illegal characters: <![CDATA[ @, ~, ;, {, }, \, +, =, <, >, |, /, \\, ?, :, &, $, *, \", #, [, ] ]]></description></item></list>
	Name *string `json:"name,omitempty"`
	// If set, the feed can proxy packages from an upstream feed
	UpstreamEnabled *bool `json:"upstreamEnabled,omitempty"`
	// A list of sources that this feed will fetch packages from.  An empty list indicates that this feed will not search any additional sources for packages.
	UpstreamSources *[]UpstreamSource `json:"upstreamSources,omitempty"`
}

Update a feed definition with these new values.

type FeedView 

type FeedView struct {
	// Related REST links.
	Links interface{} `json:"_links,omitempty"`
	// Id of the view.
	Id *uuid.UUID `json:"id,omitempty"`
	// Name of the view.
	Name *string `json:"name,omitempty"`
	// Type of view.
	Type *FeedViewType `json:"type,omitempty"`
	// Url of the view.
	Url *string `json:"url,omitempty"`
	// Visibility status of the view.
	Visibility *FeedVisibility `json:"visibility,omitempty"`
}

A view on top of a feed.

type FeedViewType 

type FeedViewType string

The type of view, often used to control capabilities and exposure to options such as promote. Implicit views are internally created only.

type FeedVisibility 

type FeedVisibility string

Feed visibility controls the scope in which a certain feed is accessible by a particular user

type GetBadgeArgs 

type GetBadgeArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Id of the package (GUID Id, not name).
	PackageId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetBadge function

type GetFeedArgs 

type GetFeedArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) Include upstreams that have been deleted in the response.
	IncludeDeletedUpstreams *bool
}

Arguments for the GetFeed function

type GetFeedChangeArgs 

type GetFeedChangeArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetFeedChange function

type GetFeedChangesArgs 

type GetFeedChangesArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) If true, get changes for all feeds including deleted feeds. The default value is false.
	IncludeDeleted *bool
	// (optional) A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
	ContinuationToken *uint64
	// (optional) Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
	BatchSize *int
}

Arguments for the GetFeedChanges function

type GetFeedPermissionsArgs 

type GetFeedPermissionsArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to include user Ids in the response.  Default is false.
	IncludeIds *bool
	// (optional) True to only return explicitly set permissions on the feed.  Default is false.
	ExcludeInheritedPermissions *bool
	// (optional) Filter permissions to the provided identity.
	IdentityDescriptor *string
	// (optional) If includeDeletedFeeds is true, then feedId must be specified by name and not by Guid.
	IncludeDeletedFeeds *bool
}

Arguments for the GetFeedPermissions function

type GetFeedRetentionPoliciesArgs 

type GetFeedRetentionPoliciesArgs struct {
	// (required) Name or ID of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetFeedRetentionPolicies function

type GetFeedViewArgs 

type GetFeedViewArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Name or Id of the view.
	ViewId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetFeedView function

type GetFeedViewsArgs 

type GetFeedViewsArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetFeedViews function

type GetFeedsArgs 

type GetFeedsArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions.
	FeedRole *FeedRole
	// (optional) Include upstreams that have been deleted in the response.
	IncludeDeletedUpstreams *bool
	// (optional) Resolve names if true
	IncludeUrls *bool
}

Arguments for the GetFeeds function

type GetFeedsFromRecycleBinArgs 

type GetFeedsFromRecycleBinArgs struct {
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetFeedsFromRecycleBin function

type GetGlobalPermissionsArgs 

type GetGlobalPermissionsArgs struct {
	// (optional) Set to true to add IdentityIds to the permission objects.
	IncludeIds *bool
}

Arguments for the GetGlobalPermissions function

type GetPackageArgs 

type GetPackageArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) The package Id (GUID Id, not the package name).
	PackageId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to return all versions of the package in the response. Default is false (latest version only).
	IncludeAllVersions *bool
	// (optional) True to return REST Urls with the response. Default is True.
	IncludeUrls *bool
	// (optional) Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
	IsListed *bool
	// (optional) Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true.  Default is True (only return packages without prerelease versioning).
	IsRelease *bool
	// (optional) Return deleted or unpublished versions of packages in the response. Default is False.
	IncludeDeleted *bool
	// (optional) Return the description for every version of each package in the response. Default is False.
	IncludeDescription *bool
}

Arguments for the GetPackage function

type GetPackageChangesArgs 

type GetPackageChangesArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
	ContinuationToken *uint64
	// (optional) Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
	BatchSize *int
}

Arguments for the GetPackageChanges function

type GetPackageVersionArgs 

type GetPackageVersionArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Id of the package (GUID Id, not name).
	PackageId *string
	// (required) Id of the package version (GUID Id, not name).
	PackageVersionId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to include urls for each version. Default is true.
	IncludeUrls *bool
	// (optional) Only applicable for NuGet packages. If false, delisted package versions will be returned.
	IsListed *bool
	// (optional) This does not have any effect on the requested package version, for other versions returned specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).
	IsDeleted *bool
}

Arguments for the GetPackageVersion function

type GetPackageVersionProvenanceArgs 

type GetPackageVersionProvenanceArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Id of the package (GUID Id, not name).
	PackageId *uuid.UUID
	// (required) Id of the package version (GUID Id, not name).
	PackageVersionId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetPackageVersionProvenance function

type GetPackageVersionsArgs 

type GetPackageVersionsArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Id of the package (GUID Id, not name).
	PackageId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) True to include urls for each version. Default is true.
	IncludeUrls *bool
	// (optional) Only applicable for NuGet packages. If false, delisted package versions will be returned.
	IsListed *bool
	// (optional) If set specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).
	IsDeleted *bool
}

Arguments for the GetPackageVersions function

type GetPackagesArgs 

type GetPackagesArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) One of the supported artifact package types.
	ProtocolType *string
	// (optional) Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.
	PackageNameQuery *string
	// (optional) [Obsolete] Used for legacy scenarios and may be removed in future versions.
	NormalizedPackageName *string
	// (optional) True to return REST Urls with the response. Default is True.
	IncludeUrls *bool
	// (optional) True to return all versions of the package in the response. Default is false (latest version only).
	IncludeAllVersions *bool
	// (optional) Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
	IsListed *bool
	// (optional) Changes the behavior of $top and $skip to return all versions of each package up to $top. Must be used in conjunction with includeAllVersions=true
	GetTopPackageVersions *bool
	// (optional) Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).
	IsRelease *bool
	// (optional) Return the description for every version of each package in the response. Default is False.
	IncludeDescription *bool
	// (optional) Get the top N packages (or package versions where getTopPackageVersions=true)
	Top *int
	// (optional) Skip the first N packages (or package versions where getTopPackageVersions=true)
	Skip *int
	// (optional) Return deleted or unpublished versions of packages in the response. Default is False.
	IncludeDeleted *bool
	// (optional) [Obsolete] Used for legacy scenarios and may be removed in future versions.
	IsCached *bool
	// (optional) Filter results to return packages from a specific upstream.
	DirectUpstreamId *uuid.UUID
}

Arguments for the GetPackages function

type GetRecycleBinPackageArgs 

type GetRecycleBinPackageArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) The package Id (GUID Id, not the package name).
	PackageId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) True to return REST Urls with the response.  Default is True.
	IncludeUrls *bool
}

Arguments for the GetRecycleBinPackage function

type GetRecycleBinPackageVersionArgs 

type GetRecycleBinPackageVersionArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) The package Id (GUID Id, not the package name).
	PackageId *uuid.UUID
	// (required) The package version Id 9guid Id, not the version string).
	PackageVersionId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) True to return REST Urls with the response.  Default is True.
	IncludeUrls *bool
}

Arguments for the GetRecycleBinPackageVersion function

type GetRecycleBinPackageVersionsArgs 

type GetRecycleBinPackageVersionsArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) The package Id (GUID Id, not the package name).
	PackageId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) True to return REST Urls with the response.  Default is True.
	IncludeUrls *bool
}

Arguments for the GetRecycleBinPackageVersions function

type GetRecycleBinPackagesArgs 

type GetRecycleBinPackagesArgs struct {
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
	// (optional) Type of package (e.g. NuGet, npm, ...).
	ProtocolType *string
	// (optional) Filter to packages matching this name.
	PackageNameQuery *string
	// (optional) True to return REST Urls with the response.  Default is True.
	IncludeUrls *bool
	// (optional) Get the top N packages.
	Top *int
	// (optional) Skip the first N packages.
	Skip *int
	// (optional) True to return all versions of the package in the response.  Default is false (latest version only).
	IncludeAllVersions *bool
}

Arguments for the GetRecycleBinPackages function

type GlobalPermission 

type GlobalPermission struct {
	// Identity of the user with the provided Role.
	IdentityDescriptor *string `json:"identityDescriptor,omitempty"`
	// IdentityId corresponding to the IdentityDescriptor
	IdentityId *uuid.UUID `json:"identityId,omitempty"`
	// Role associated with the Identity.
	Role *GlobalRole `json:"role,omitempty"`
}

Permissions for feed service-wide operations such as the creation of new feeds.

type GlobalRole 

type GlobalRole string

type MinimalPackageVersion 

type MinimalPackageVersion struct {
	// Upstream source this package was ingested from.
	DirectUpstreamSourceId *uuid.UUID `json:"directUpstreamSourceId,omitempty"`
	// Id for the package.
	Id *uuid.UUID `json:"id,omitempty"`
	// [Obsolete] Used for legacy scenarios and may be removed in future versions.
	IsCachedVersion *bool `json:"isCachedVersion,omitempty"`
	// True if this package has been deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// True if this is the latest version of the package by package type sort order.
	IsLatest *bool `json:"isLatest,omitempty"`
	// (NuGet and Cargo Only) True if this package is listed.
	IsListed *bool `json:"isListed,omitempty"`
	// Normalized version using normalization rules specific to a package type.
	NormalizedVersion *string `json:"normalizedVersion,omitempty"`
	// Package description.
	PackageDescription *string `json:"packageDescription,omitempty"`
	// UTC Date the package was published to the service.
	PublishDate *azuredevops.Time `json:"publishDate,omitempty"`
	// Internal storage id.
	StorageId *string `json:"storageId,omitempty"`
	// Display version.
	Version *string `json:"version,omitempty"`
	// List of views containing this package version.
	Views *[]FeedView `json:"views,omitempty"`
}

Core data about any package, including its id and version information and basic state.

type Package 

type Package struct {
	// Related REST links.
	Links interface{} `json:"_links,omitempty"`
	// Id of the package.
	Id *uuid.UUID `json:"id,omitempty"`
	// Used for legacy scenarios and may be removed in future versions.
	IsCached *bool `json:"isCached,omitempty"`
	// The display name of the package.
	Name *string `json:"name,omitempty"`
	// The normalized name representing the identity of this package within its package type.
	NormalizedName *string `json:"normalizedName,omitempty"`
	// Type of the package.
	ProtocolType *string `json:"protocolType,omitempty"`
	// [Obsolete] - this field is unused and will be removed in a future release.
	StarCount *int `json:"starCount,omitempty"`
	// Url for this package.
	Url *string `json:"url,omitempty"`
	// All versions for this package within its feed.
	Versions *[]MinimalPackageVersion `json:"versions,omitempty"`
}

A package, which is a container for one or more package versions.

type PackageChange 

type PackageChange struct {
	// Package that was changed.
	Package *Package `json:"package,omitempty"`
	// Change that was performed on a package version.
	PackageVersionChange *PackageVersionChange `json:"packageVersionChange,omitempty"`
}

A single change to a feed's packages.

type PackageChangesResponse 

type PackageChangesResponse struct {
	// Related REST links.
	Links interface{} `json:"_links,omitempty"`
	// Number of changes in this batch.
	Count *int `json:"count,omitempty"`
	// Token that should be used in future calls for this feed to retrieve new changes.
	NextPackageContinuationToken *uint64 `json:"nextPackageContinuationToken,omitempty"`
	// List of changes.
	PackageChanges *[]PackageChange `json:"packageChanges,omitempty"`
}

A set of change operations to a feed's packages.

type PackageDependency 

type PackageDependency struct {
	// Dependency package group (an optional classification within some package types).
	Group *string `json:"group,omitempty"`
	// Dependency package name.
	PackageName *string `json:"packageName,omitempty"`
	// Dependency package version range.
	VersionRange *string `json:"versionRange,omitempty"`
}

A dependency on another package version.

type PackageFile 

type PackageFile struct {
	// Hierarchical representation of files.
	Children *[]PackageFile `json:"children,omitempty"`
	// File name.
	Name *string `json:"name,omitempty"`
	// Extended data unique to a specific package type.
	ProtocolMetadata *ProtocolMetadata `json:"protocolMetadata,omitempty"`
}

A package file for a specific package version, only relevant to package types that contain multiple files per version.

type PackageMetrics 

type PackageMetrics struct {
	// Total count of downloads per package id.
	DownloadCount *float64 `json:"downloadCount,omitempty"`
	// Number of downloads per unique user per package id.
	DownloadUniqueUsers *float64 `json:"downloadUniqueUsers,omitempty"`
	// UTC date and time when package was last downloaded.
	LastDownloaded *azuredevops.Time `json:"lastDownloaded,omitempty"`
	// Package id.
	PackageId *uuid.UUID `json:"packageId,omitempty"`
}

All metrics for a certain package id

type PackageMetricsQuery 

type PackageMetricsQuery struct {
	// List of package ids
	PackageIds *[]uuid.UUID `json:"packageIds,omitempty"`
}

Query to get package metrics

type PackageVersion 

type PackageVersion struct {
	// Upstream source this package was ingested from.
	DirectUpstreamSourceId *uuid.UUID `json:"directUpstreamSourceId,omitempty"`
	// Id for the package.
	Id *uuid.UUID `json:"id,omitempty"`
	// [Obsolete] Used for legacy scenarios and may be removed in future versions.
	IsCachedVersion *bool `json:"isCachedVersion,omitempty"`
	// True if this package has been deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// True if this is the latest version of the package by package type sort order.
	IsLatest *bool `json:"isLatest,omitempty"`
	// (NuGet and Cargo Only) True if this package is listed.
	IsListed *bool `json:"isListed,omitempty"`
	// Normalized version using normalization rules specific to a package type.
	NormalizedVersion *string `json:"normalizedVersion,omitempty"`
	// Package description.
	PackageDescription *string `json:"packageDescription,omitempty"`
	// UTC Date the package was published to the service.
	PublishDate *azuredevops.Time `json:"publishDate,omitempty"`
	// Internal storage id.
	StorageId *string `json:"storageId,omitempty"`
	// Display version.
	Version *string `json:"version,omitempty"`
	// List of views containing this package version.
	Views *[]FeedView `json:"views,omitempty"`
	// Related links
	Links interface{} `json:"_links,omitempty"`
	// Package version author.
	Author *string `json:"author,omitempty"`
	// UTC date that this package version was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// List of dependencies for this package version.
	Dependencies *[]PackageDependency `json:"dependencies,omitempty"`
	// Package version description.
	Description *string `json:"description,omitempty"`
	// Files associated with this package version, only relevant for multi-file package types.
	Files *[]PackageFile `json:"files,omitempty"`
	// Other versions of this package.
	OtherVersions *[]MinimalPackageVersion `json:"otherVersions,omitempty"`
	// Extended data specific to a package type.
	ProtocolMetadata *ProtocolMetadata `json:"protocolMetadata,omitempty"`
	// List of upstream sources through which a package version moved to land in this feed.
	SourceChain *[]UpstreamSource `json:"sourceChain,omitempty"`
	// Package version summary.
	Summary *string `json:"summary,omitempty"`
	// Package version tags.
	Tags *[]string `json:"tags,omitempty"`
	// Package version url.
	Url *string `json:"url,omitempty"`
}

A specific version of a package.

type PackageVersionChange 

type PackageVersionChange struct {
	// Token marker for this change, allowing the caller to send this value back to the service and receive changes beyond this one.
	ContinuationToken *uint64 `json:"continuationToken,omitempty"`
	// The type of change that was performed.
	ChangeType *ChangeType `json:"changeType,omitempty"`
	// Package version that was changed.
	PackageVersion *PackageVersion `json:"packageVersion,omitempty"`
}

A change to a single package version.

type PackageVersionMetrics 

type PackageVersionMetrics struct {
	// Total count of downloads per package version id.
	DownloadCount *float64 `json:"downloadCount,omitempty"`
	// Number of downloads per unique user per package version id.
	DownloadUniqueUsers *float64 `json:"downloadUniqueUsers,omitempty"`
	// UTC date and time when package version was last downloaded.
	LastDownloaded *azuredevops.Time `json:"lastDownloaded,omitempty"`
	// Package id.
	PackageId *uuid.UUID `json:"packageId,omitempty"`
	// Package version id.
	PackageVersionId *uuid.UUID `json:"packageVersionId,omitempty"`
}

All metrics for a certain package version id

type PackageVersionMetricsQuery 

type PackageVersionMetricsQuery struct {
	// List of package version ids
	PackageVersionIds *[]uuid.UUID `json:"packageVersionIds,omitempty"`
}

Query to get package version metrics

type PackageVersionProvenance 

type PackageVersionProvenance struct {
	// Name or Id of the feed.
	FeedId *uuid.UUID `json:"feedId,omitempty"`
	// Id of the package (GUID Id, not name).
	PackageId *uuid.UUID `json:"packageId,omitempty"`
	// Id of the package version (GUID Id, not name).
	PackageVersionId *uuid.UUID `json:"packageVersionId,omitempty"`
	// Provenance information for this package version.
	Provenance *Provenance `json:"provenance,omitempty"`
}

Provenance for a published package version

type PermanentDeleteFeedArgs 

type PermanentDeleteFeedArgs struct {
	// (required)
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the PermanentDeleteFeed function

type ProjectReference 

type ProjectReference struct {
	// Gets or sets id of the project.
	Id *uuid.UUID `json:"id,omitempty"`
	// Gets or sets name of the project.
	Name *string `json:"name,omitempty"`
	// Gets or sets visibility of the project.
	Visibility *string `json:"visibility,omitempty"`
}

type ProtocolMetadata 

type ProtocolMetadata struct {
	// Extended metadata for a specific package type, formatted to the associated schema version definition.
	Data interface{} `json:"data,omitempty"`
	// Schema version.
	SchemaVersion *int `json:"schemaVersion,omitempty"`
}

Extended metadata for a specific package type.

type Provenance 

type Provenance struct {
	// Other provenance data.
	Data *map[string]string `json:"data,omitempty"`
	// Type of provenance source, for example "InternalBuild", "InternalRelease"
	ProvenanceSource *string `json:"provenanceSource,omitempty"`
	// Identity of user that published the package
	PublisherUserIdentity *uuid.UUID `json:"publisherUserIdentity,omitempty"`
	// HTTP User-Agent used when pushing the package.
	UserAgent *string `json:"userAgent,omitempty"`
}

Data about the origin of a published package

type QueryPackageMetricsArgs 

type QueryPackageMetricsArgs struct {
	// (required)
	PackageIdQuery *PackageMetricsQuery
	// (required)
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the QueryPackageMetrics function

type QueryPackageVersionMetricsArgs 

type QueryPackageVersionMetricsArgs struct {
	// (required)
	PackageVersionIdQuery *PackageVersionMetricsQuery
	// (required)
	FeedId *string
	// (required)
	PackageId *uuid.UUID
	// (optional) Project ID or project name
	Project *string
}

Arguments for the QueryPackageVersionMetrics function

type RecycleBinPackageVersion 

type RecycleBinPackageVersion struct {
	// Upstream source this package was ingested from.
	DirectUpstreamSourceId *uuid.UUID `json:"directUpstreamSourceId,omitempty"`
	// Id for the package.
	Id *uuid.UUID `json:"id,omitempty"`
	// [Obsolete] Used for legacy scenarios and may be removed in future versions.
	IsCachedVersion *bool `json:"isCachedVersion,omitempty"`
	// True if this package has been deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// True if this is the latest version of the package by package type sort order.
	IsLatest *bool `json:"isLatest,omitempty"`
	// (NuGet and Cargo Only) True if this package is listed.
	IsListed *bool `json:"isListed,omitempty"`
	// Normalized version using normalization rules specific to a package type.
	NormalizedVersion *string `json:"normalizedVersion,omitempty"`
	// Package description.
	PackageDescription *string `json:"packageDescription,omitempty"`
	// UTC Date the package was published to the service.
	PublishDate *azuredevops.Time `json:"publishDate,omitempty"`
	// Internal storage id.
	StorageId *string `json:"storageId,omitempty"`
	// Display version.
	Version *string `json:"version,omitempty"`
	// List of views containing this package version.
	Views *[]FeedView `json:"views,omitempty"`
	// Related links
	Links interface{} `json:"_links,omitempty"`
	// Package version author.
	Author *string `json:"author,omitempty"`
	// UTC date that this package version was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// List of dependencies for this package version.
	Dependencies *[]PackageDependency `json:"dependencies,omitempty"`
	// Package version description.
	Description *string `json:"description,omitempty"`
	// Files associated with this package version, only relevant for multi-file package types.
	Files *[]PackageFile `json:"files,omitempty"`
	// Other versions of this package.
	OtherVersions *[]MinimalPackageVersion `json:"otherVersions,omitempty"`
	// Extended data specific to a package type.
	ProtocolMetadata *ProtocolMetadata `json:"protocolMetadata,omitempty"`
	// List of upstream sources through which a package version moved to land in this feed.
	SourceChain *[]UpstreamSource `json:"sourceChain,omitempty"`
	// Package version summary.
	Summary *string `json:"summary,omitempty"`
	// Package version tags.
	Tags *[]string `json:"tags,omitempty"`
	// Package version url.
	Url *string `json:"url,omitempty"`
	// UTC date on which the package will automatically be removed from the recycle bin and permanently deleted.
	ScheduledPermanentDeleteDate *azuredevops.Time `json:"scheduledPermanentDeleteDate,omitempty"`
}

A single package version within the recycle bin.

type RestoreDeletedFeedArgs 

type RestoreDeletedFeedArgs struct {
	// (required)
	PatchJson *[]webapi.JsonPatchOperation
	// (required)
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the RestoreDeletedFeed function

type SetFeedPermissionsArgs 

type SetFeedPermissionsArgs struct {
	// (required) Permissions to set.
	FeedPermission *[]FeedPermission
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the SetFeedPermissions function

type SetFeedRetentionPoliciesArgs 

type SetFeedRetentionPoliciesArgs struct {
	// (required) Feed retention policy.
	Policy *FeedRetentionPolicy
	// (required) Name or ID of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the SetFeedRetentionPolicies function

type SetGlobalPermissionsArgs 

type SetGlobalPermissionsArgs struct {
	// (required) New permissions for the organization.
	GlobalPermissions *[]GlobalPermission
}

Arguments for the SetGlobalPermissions function

type UpdateFeedArgs 

type UpdateFeedArgs struct {
	// (required) A JSON object containing the feed settings to be updated.
	Feed *FeedUpdate
	// (required) Name or Id of the feed.
	FeedId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdateFeed function

type UpdateFeedViewArgs 

type UpdateFeedViewArgs struct {
	// (required) New settings to apply to the specified view.
	View *FeedView
	// (required) Name or Id of the feed.
	FeedId *string
	// (required) Name or Id of the view.
	ViewId *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdateFeedView function

type UpstreamSource 

type UpstreamSource struct {
	// UTC date that this upstream was deleted.
	DeletedDate *azuredevops.Time `json:"deletedDate,omitempty"`
	// Locator for connecting to the upstream source in a user friendly format, that may potentially change over time
	DisplayLocation *string `json:"displayLocation,omitempty"`
	// Identity of the upstream source.
	Id *uuid.UUID `json:"id,omitempty"`
	// For an internal upstream type, track the Azure DevOps organization that contains it.
	InternalUpstreamCollectionId *uuid.UUID `json:"internalUpstreamCollectionId,omitempty"`
	// For an internal upstream type, track the feed id being referenced.
	InternalUpstreamFeedId *uuid.UUID `json:"internalUpstreamFeedId,omitempty"`
	// For an internal upstream type, track the project of the feed being referenced.
	InternalUpstreamProjectId *uuid.UUID `json:"internalUpstreamProjectId,omitempty"`
	// For an internal upstream type, track the view of the feed being referenced.
	InternalUpstreamViewId *uuid.UUID `json:"internalUpstreamViewId,omitempty"`
	// Consistent locator for connecting to the upstream source.
	Location *string `json:"location,omitempty"`
	// Display name.
	Name *string `json:"name,omitempty"`
	// Package type associated with the upstream source.
	Protocol *string `json:"protocol,omitempty"`
	// The identity of the service endpoint that holds credentials to use when accessing the upstream.
	ServiceEndpointId *uuid.UUID `json:"serviceEndpointId,omitempty"`
	// Specifies the projectId of the Service Endpoint.
	ServiceEndpointProjectId *uuid.UUID `json:"serviceEndpointProjectId,omitempty"`
	// Specifies the status of the upstream.
	Status *UpstreamStatus `json:"status,omitempty"`
	// Provides a human-readable reason for the status of the upstream.
	StatusDetails *[]UpstreamStatusDetail `json:"statusDetails,omitempty"`
	// Source type, such as Public or Internal.
	UpstreamSourceType *UpstreamSourceType `json:"upstreamSourceType,omitempty"`
}

Upstream source definition, including its Identity, package type, and other associated information.

type UpstreamSourceType 

type UpstreamSourceType string

Type of an upstream source, such as Public or Internal.

type UpstreamStatus 

type UpstreamStatus string

Status of the upstream, such as Ok or Disabled.

type UpstreamStatusDetail 

type UpstreamStatusDetail struct {
	// Provides a human-readable reason for the status of the upstream.
	Reason *string `json:"reason,omitempty"`
}

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.