feeds

package
v2.40.3 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: Apache-2.0 Imports: 15 Imported by: 4

Documentation

Index

Constants

View Source 
const (
	FeedTypeAwsElasticContainerRegistry = FeedType("AwsElasticContainerRegistry")
	FeedTypeBuiltIn                     = FeedType("BuiltIn")
	FeedTypeDocker                      = FeedType("Docker")
	FeedTypeGitHub                      = FeedType("GitHub")
	FeedTypeHelm                        = FeedType("Helm")
	FeedTypeMaven                       = FeedType("Maven")
	FeedTypeNuGet                       = FeedType("NuGet")
	FeedTypeOctopusProject              = FeedType("OctopusProject")
	FeedTypeArtifactoryGeneric          = FeedType("ArtifactoryGeneric")
	FeedTypeS3                          = FeedType("S3")
)

Variables

This section is empty.

Functions

func DeleteByID added in v2.33.0 

func DeleteByID(client newclient.Client, spaceID string, id string) error

DeleteByID will delete a account with the provided id.

func IsNil 

func IsNil(i interface{}) bool

func SearchPackageVersions added in v2.6.0 

func SearchPackageVersions(client newclient.Client, spaceID string, feedID string, packageID string, filter string, limit int) (*resources.Resources[*packages.PackageVersion], error)

note, the FeedID here has to be a real ID. You can't supply "feeds-builtin", you need to lookup the ID as "Feeds-101" etc, and use that instead

Types

type ArtifactoryGenericFeed added in v2.35.0 

type ArtifactoryGenericFeed struct {
	LayoutRegex string `json:"LayoutRegex,omitempty"`
	FeedURI     string `json:"FeedUri,omitempty"`
	Repository  string `json:"Repository"`
	// contains filtered or unexported fields
}

func NewArtifactoryGenericFeed added in v2.35.0 

func NewArtifactoryGenericFeed(name string) (*ArtifactoryGenericFeed, error)

func (*ArtifactoryGenericFeed) GetFeedType added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*ArtifactoryGenericFeed) GetName added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetName() string

GetName returns the name of the feed.

func (*ArtifactoryGenericFeed) GetPackageAcquisitionLocationOptions added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*ArtifactoryGenericFeed) GetPassword added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*ArtifactoryGenericFeed) GetSpaceID added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*ArtifactoryGenericFeed) GetUsername added in v2.35.0 

func (f *ArtifactoryGenericFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*ArtifactoryGenericFeed) SetFeedType added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*ArtifactoryGenericFeed) SetName added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetName(name string)

SetName sets the name of the feed.

func (*ArtifactoryGenericFeed) SetPackageAcquisitionLocationOptions added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*ArtifactoryGenericFeed) SetPassword added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*ArtifactoryGenericFeed) SetSpaceID added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*ArtifactoryGenericFeed) SetUsername added in v2.35.0 

func (f *ArtifactoryGenericFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*ArtifactoryGenericFeed) Validate added in v2.35.0 

func (g *ArtifactoryGenericFeed) Validate() error

type AwsElasticContainerRegistry 

type AwsElasticContainerRegistry struct {
	AccessKey string               `json:"AccessKey" validate:"required"`
	Region    string               `json:"Region" validate:"required"`
	SecretKey *core.SensitiveValue `json:"SecretKey" validate:"required"`
	// contains filtered or unexported fields
}

AwsElasticContainerRegistry represents an Amazon Web Services (AWS) Elastic Container Registry (ECR).

func NewAwsElasticContainerRegistry 

func NewAwsElasticContainerRegistry(name string, accessKey string, secretKey *core.SensitiveValue, region string) (*AwsElasticContainerRegistry, error)

NewAwsElasticContainerRegistry creates and initializes an Amazon Web Services (AWS) Elastic Container Registry (ECR).

func (*AwsElasticContainerRegistry) GetFeedType 

func (f *AwsElasticContainerRegistry) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*AwsElasticContainerRegistry) GetName 

func (f *AwsElasticContainerRegistry) GetName() string

GetName returns the name of the feed.

func (*AwsElasticContainerRegistry) GetPackageAcquisitionLocationOptions 

func (f *AwsElasticContainerRegistry) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*AwsElasticContainerRegistry) GetPassword 

func (f *AwsElasticContainerRegistry) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*AwsElasticContainerRegistry) GetSpaceID 

func (f *AwsElasticContainerRegistry) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*AwsElasticContainerRegistry) GetUsername 

func (f *AwsElasticContainerRegistry) GetUsername() string

GetUsername returns the username of the feed.

func (*AwsElasticContainerRegistry) SetFeedType 

func (f *AwsElasticContainerRegistry) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*AwsElasticContainerRegistry) SetName 

func (f *AwsElasticContainerRegistry) SetName(name string)

SetName sets the name of the feed.

func (*AwsElasticContainerRegistry) SetPackageAcquisitionLocationOptions 

func (f *AwsElasticContainerRegistry) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*AwsElasticContainerRegistry) SetPassword 

func (f *AwsElasticContainerRegistry) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*AwsElasticContainerRegistry) SetSpaceID 

func (f *AwsElasticContainerRegistry) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*AwsElasticContainerRegistry) SetUsername 

func (f *AwsElasticContainerRegistry) SetUsername(username string)

SetUsername sets the username of the feed.

func (*AwsElasticContainerRegistry) Validate 

func (a *AwsElasticContainerRegistry) Validate() error

Validate checks the state of this Amazon Web Services (AWS) Elastic Container Registry (ECR) and returns an error if invalid.

type BuiltInFeed 

type BuiltInFeed struct {
	DeleteUnreleasedPackagesAfterDays int  `json:"DeleteUnreleasedPackagesAfterDays"`
	DownloadAttempts                  int  `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds       int  `json:"DownloadRetryBackoffSeconds"`
	IsBuiltInRepoSyncEnabled          bool `json:"IsBuiltInRepoSyncEnabled"`
	// contains filtered or unexported fields
}

BuiltInFeed represents a built-in feed.

func NewBuiltInFeed 

func NewBuiltInFeed(name string) (*BuiltInFeed, error)

NewBuiltInFeed creates and initializes a built-in feed.

func (*BuiltInFeed) GetFeedType 

func (f *BuiltInFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*BuiltInFeed) GetName 

func (f *BuiltInFeed) GetName() string

GetName returns the name of the feed.

func (*BuiltInFeed) GetPackageAcquisitionLocationOptions 

func (f *BuiltInFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*BuiltInFeed) GetPassword 

func (f *BuiltInFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*BuiltInFeed) GetSpaceID 

func (f *BuiltInFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*BuiltInFeed) GetUsername 

func (f *BuiltInFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*BuiltInFeed) SetFeedType 

func (f *BuiltInFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*BuiltInFeed) SetName 

func (f *BuiltInFeed) SetName(name string)

SetName sets the name of the feed.

func (*BuiltInFeed) SetPackageAcquisitionLocationOptions 

func (f *BuiltInFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*BuiltInFeed) SetPassword 

func (f *BuiltInFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*BuiltInFeed) SetSpaceID 

func (f *BuiltInFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*BuiltInFeed) SetUsername 

func (f *BuiltInFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*BuiltInFeed) Validate 

func (b *BuiltInFeed) Validate() error

Validate checks the state of this built-in feed and returns an error if invalid.

type BuiltInFeedStatistics 

type BuiltInFeedStatistics struct {
	TotalPackages int32 `json:"TotalPackages,omitempty"`

	resources.Resource
}

type DockerContainerRegistry 

type DockerContainerRegistry struct {
	APIVersion   string `json:"ApiVersion,omitempty"`
	FeedURI      string `json:"FeedUri,omitempty"`
	RegistryPath string `json:"RegistryPath,omitempty"`
	// contains filtered or unexported fields
}

DockerContainerRegistry represents a Docker container registry.

func NewDockerContainerRegistry 

func NewDockerContainerRegistry(name string) (*DockerContainerRegistry, error)

NewDockerContainerRegistry creates and initializes a Docker container registry.

func (*DockerContainerRegistry) GetFeedType 

func (f *DockerContainerRegistry) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*DockerContainerRegistry) GetName 

func (f *DockerContainerRegistry) GetName() string

GetName returns the name of the feed.

func (*DockerContainerRegistry) GetPackageAcquisitionLocationOptions 

func (f *DockerContainerRegistry) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*DockerContainerRegistry) GetPassword 

func (f *DockerContainerRegistry) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*DockerContainerRegistry) GetSpaceID 

func (f *DockerContainerRegistry) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*DockerContainerRegistry) GetUsername 

func (f *DockerContainerRegistry) GetUsername() string

GetUsername returns the username of the feed.

func (*DockerContainerRegistry) SetFeedType 

func (f *DockerContainerRegistry) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*DockerContainerRegistry) SetName 

func (f *DockerContainerRegistry) SetName(name string)

SetName sets the name of the feed.

func (*DockerContainerRegistry) SetPackageAcquisitionLocationOptions 

func (f *DockerContainerRegistry) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*DockerContainerRegistry) SetPassword 

func (f *DockerContainerRegistry) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*DockerContainerRegistry) SetSpaceID 

func (f *DockerContainerRegistry) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*DockerContainerRegistry) SetUsername 

func (f *DockerContainerRegistry) SetUsername(username string)

SetUsername sets the username of the feed.

func (*DockerContainerRegistry) Validate 

func (d *DockerContainerRegistry) Validate() error

Validate checks the state of this Docker container registry and returns an error if invalid.

type FeedResource 

type FeedResource struct {
	AccessKey                         string               `json:"AccessKey,omitempty"`
	APIVersion                        string               `json:"ApiVersion,omitempty"`
	DeleteUnreleasedPackagesAfterDays int                  `json:"DeleteUnreleasedPackagesAfterDays"`
	DownloadAttempts                  int                  `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds       int                  `json:"DownloadRetryBackoffSeconds"`
	EnhancedMode                      bool                 `json:"EnhancedMode"`
	FeedType                          FeedType             `json:"FeedType" validate:"required,notblank"`
	FeedURI                           string               `json:"FeedUri,omitempty"`
	IsBuiltInRepoSyncEnabled          bool                 `json:"IsBuiltInRepoSyncEnabled"`
	Name                              string               `json:"Name" validate:"required,notblank"`
	Password                          *core.SensitiveValue `json:"Password,omitempty"`
	PackageAcquisitionLocationOptions []string             `json:"PackageAcquisitionLocationOptions,omitempty"`
	Region                            string               `json:"Region,omitempty"`
	RegistryPath                      string               `json:"RegistryPath,omitempty"`
	SecretKey                         *core.SensitiveValue `json:"SecretKey,omitempty"`
	SpaceID                           string               `json:"SpaceId,omitempty"`
	Username                          string               `json:"Username,omitempty"`
	LayoutRegex                       string               `json:"LayoutRegex,omitempty"`
	Repository                        string               `json:"Repository,omitempty"`
	UseMachineCredentials             bool                 `json:"UseMachineCredentials,omitempty"`
	resources.Resource
}

func NewFeedResource 

func NewFeedResource(name string, feedType FeedType) *FeedResource

func ToFeedResource 

func ToFeedResource(feed IFeed) (*FeedResource, error)

func (*FeedResource) GetFeedType 

func (f *FeedResource) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*FeedResource) GetName 

func (f *FeedResource) GetName() string

GetName returns the name of the feed.

func (*FeedResource) GetPackageAcquisitionLocationOptions 

func (f *FeedResource) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*FeedResource) GetPassword 

func (f *FeedResource) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*FeedResource) GetSpaceID 

func (f *FeedResource) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*FeedResource) GetUsername 

func (f *FeedResource) GetUsername() string

GetUsername returns the username of the feed.

func (*FeedResource) SetFeedType 

func (f *FeedResource) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*FeedResource) SetName 

func (f *FeedResource) SetName(name string)

SetName sets the name of the feed.

func (*FeedResource) SetPackageAcquisitionLocationOptions 

func (f *FeedResource) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*FeedResource) SetPassword 

func (f *FeedResource) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*FeedResource) SetSpaceID 

func (f *FeedResource) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*FeedResource) SetUsername 

func (f *FeedResource) SetUsername(username string)

SetUsername sets the username of the feed.

func (FeedResource) Validate 

func (f FeedResource) Validate() error

Validate checks the state of the feed resource and returns an error if invalid.

type FeedService 

type FeedService struct {
	services.CanDeleteService
	// contains filtered or unexported fields
}

FeedService handles communication with feed-related methods of the Octopus API.

func NewFeedService 

func NewFeedService(sling *sling.Sling, uriTemplate string, builtInFeedStats string) *FeedService

NewFeedService returns an feed service with a preconfigured client.

func (*FeedService) Add deprecated 

func (s *FeedService) Add(feed IFeed) (IFeed, error)

Add creates a new feed.

Deprecated: use feeds.Add

func (*FeedService) Get deprecated 

func (s *FeedService) Get(feedsQuery FeedsQuery) (*Feeds, error)

Get returns a collection of feeds based on the criteria defined by its input query parameter. If an error occurs, an empty collection is returned along with the associated error.

Deprecated: use feeds.Get

func (*FeedService) GetAll 

func (s *FeedService) GetAll() ([]IFeed, error)

GetAll returns all feeds. If none can be found or an error occurs, it returns an empty collection.

func (*FeedService) GetBuiltInFeedStatistics 

func (s *FeedService) GetBuiltInFeedStatistics() (*BuiltInFeedStatistics, error)

GetBuiltInFeedStatistics returns statistics for the built-in feeds.

func (*FeedService) GetByID deprecated 

func (s *FeedService) GetByID(id string) (IFeed, error)

GetByID returns the feed that matches the input ID. If one cannot be found, it returns nil and an error.

Deprecated: use feeds.GetByID

func (*FeedService) SearchFeedPackageVersions added in v2.3.3 

func (s *FeedService) SearchFeedPackageVersions(feed IFeed, searchPackageVersionsQuery SearchPackageVersionsQuery) (*resources.Resources[*packages.PackageVersion], error)

TODO this method should be called SearchFeedPackageVersions for consistency, but that would be a breaking change in v2 of the client; defer to v3

func (*FeedService) SearchPackageVersions added in v2.3.0 

func (s *FeedService) SearchPackageVersions(packageDescription *packages.PackageDescription, searchPackageVersionsQuery SearchPackageVersionsQuery) (*resources.Resources[*packages.PackageVersion], error)

TODO remove or rename this method in API Client v3; the first parameter wants to be an IFeed, not a PackageDescription

func (*FeedService) SearchPackages 

func (s *FeedService) SearchPackages(feed IFeed, searchPackagesQuery SearchPackagesQuery) (*resources.Resources[*packages.PackageDescription], error)

func (*FeedService) Update deprecated 

func (s *FeedService) Update(feed IFeed) (IFeed, error)

Update modifies a feed based on the one provided as input.

Deprecated: use feeds.Update

type FeedType 

type FeedType string

type Feeds 

type Feeds struct {
	Items []IFeed `json:"Items"`
	resources.PagedResults
}

func Get added in v2.33.0 

func Get(client newclient.Client, spaceID string, feedsQuery FeedsQuery) (*Feeds, error)

Get returns a collection of feeds based on the criteria defined by its input query parameter.

func ToFeeds 

func ToFeeds(feedResources *resources.Resources[*FeedResource]) *Feeds

type FeedsQuery 

type FeedsQuery struct {
	FeedType    string   `uri:"feedType,omitempty" url:"feedType,omitempty"`
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type GitHubRepositoryFeed 

type GitHubRepositoryFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	FeedURI                     string `json:"FeedUri,omitempty"`
	// contains filtered or unexported fields
}

GitHubRepositoryFeed represents a GitHub repository feed.

func NewGitHubRepositoryFeed 

func NewGitHubRepositoryFeed(name string) (*GitHubRepositoryFeed, error)

NewGitHubRepositoryFeed creates and initializes a GitHub repository feed.

func (*GitHubRepositoryFeed) GetFeedType 

func (f *GitHubRepositoryFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*GitHubRepositoryFeed) GetName 

func (f *GitHubRepositoryFeed) GetName() string

GetName returns the name of the feed.

func (*GitHubRepositoryFeed) GetPackageAcquisitionLocationOptions 

func (f *GitHubRepositoryFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*GitHubRepositoryFeed) GetPassword 

func (f *GitHubRepositoryFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*GitHubRepositoryFeed) GetSpaceID 

func (f *GitHubRepositoryFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*GitHubRepositoryFeed) GetUsername 

func (f *GitHubRepositoryFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*GitHubRepositoryFeed) SetFeedType 

func (f *GitHubRepositoryFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*GitHubRepositoryFeed) SetName 

func (f *GitHubRepositoryFeed) SetName(name string)

SetName sets the name of the feed.

func (*GitHubRepositoryFeed) SetPackageAcquisitionLocationOptions 

func (f *GitHubRepositoryFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*GitHubRepositoryFeed) SetPassword 

func (f *GitHubRepositoryFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*GitHubRepositoryFeed) SetSpaceID 

func (f *GitHubRepositoryFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*GitHubRepositoryFeed) SetUsername 

func (f *GitHubRepositoryFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*GitHubRepositoryFeed) Validate 

func (g *GitHubRepositoryFeed) Validate() error

Validate checks the state of this GitHub repository feed and returns an error if invalid.

type HelmFeed 

type HelmFeed struct {
	FeedURI string `json:"FeedUri,omitempty"`
	// contains filtered or unexported fields
}

HelmFeed represents a Helm feed.

func NewHelmFeed 

func NewHelmFeed(name string) (*HelmFeed, error)

NewHelmFeed creates and initializes a Helm feed.

func (*HelmFeed) GetFeedType 

func (f *HelmFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*HelmFeed) GetName 

func (f *HelmFeed) GetName() string

GetName returns the name of the feed.

func (*HelmFeed) GetPackageAcquisitionLocationOptions 

func (f *HelmFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*HelmFeed) GetPassword 

func (f *HelmFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*HelmFeed) GetSpaceID 

func (f *HelmFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*HelmFeed) GetUsername 

func (f *HelmFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*HelmFeed) SetFeedType 

func (f *HelmFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*HelmFeed) SetName 

func (f *HelmFeed) SetName(name string)

SetName sets the name of the feed.

func (*HelmFeed) SetPackageAcquisitionLocationOptions 

func (f *HelmFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*HelmFeed) SetPassword 

func (f *HelmFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*HelmFeed) SetSpaceID 

func (f *HelmFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*HelmFeed) SetUsername 

func (f *HelmFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*HelmFeed) Validate 

func (h *HelmFeed) Validate() error

Validate checks the state of this Helm feed and returns an error if invalid.

type IFeed 

type IFeed interface {
	GetFeedType() FeedType
	GetName() string
	GetPackageAcquisitionLocationOptions() []string
	GetPassword() *core.SensitiveValue
	GetSpaceID() string
	GetUsername() string
	SetFeedType(FeedType)
	SetName(string)
	SetPackageAcquisitionLocationOptions([]string)
	SetPassword(*core.SensitiveValue)
	SetSpaceID(string)
	SetUsername(string)

	resources.IResource
}

func Add added in v2.33.0 

func Add(client newclient.Client, feed IFeed) (IFeed, error)

Add creates a new feed.

func GetAll added in v2.34.0 

func GetAll(client newclient.Client, spaceID string) ([]IFeed, error)

GetAll returns all feeds. If an error occurs, it returns nil.

func GetByID added in v2.33.0 

func GetByID(client newclient.Client, spaceID string, id string) (IFeed, error)

GetByID returns the feed that matches the input ID. If one cannot be found, it returns nil and an error.

func ToFeed 

func ToFeed(feedResource *FeedResource) (IFeed, error)

func ToFeedArray 

func ToFeedArray(feedResources []*FeedResource) []IFeed

func Update added in v2.33.0 

func Update(client newclient.Client, feed IFeed) (IFeed, error)

Update modifies a feed based on the one provided as input.

type MavenFeed 

type MavenFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	FeedURI                     string `json:"FeedUri,omitempty"`
	// contains filtered or unexported fields
}

MavenFeed represents a Maven feed.

func NewMavenFeed 

func NewMavenFeed(name string) (*MavenFeed, error)

NewMavenFeed creates and initializes a Maven feed.

func (*MavenFeed) GetFeedType 

func (f *MavenFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*MavenFeed) GetName 

func (f *MavenFeed) GetName() string

GetName returns the name of the feed.

func (*MavenFeed) GetPackageAcquisitionLocationOptions 

func (f *MavenFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*MavenFeed) GetPassword 

func (f *MavenFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*MavenFeed) GetSpaceID 

func (f *MavenFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*MavenFeed) GetUsername 

func (f *MavenFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*MavenFeed) SetFeedType 

func (f *MavenFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*MavenFeed) SetName 

func (f *MavenFeed) SetName(name string)

SetName sets the name of the feed.

func (*MavenFeed) SetPackageAcquisitionLocationOptions 

func (f *MavenFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*MavenFeed) SetPassword 

func (f *MavenFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*MavenFeed) SetSpaceID 

func (f *MavenFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*MavenFeed) SetUsername 

func (f *MavenFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*MavenFeed) Validate 

func (m *MavenFeed) Validate() error

Validate checks the state of this Maven feed and returns an error if invalid.

type NuGetFeed 

type NuGetFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	EnhancedMode                bool   `json:"EnhancedMode"`
	FeedURI                     string `json:"FeedUri,omitempty"`
	// contains filtered or unexported fields
}

NuGetFeed represents a NuGet feed.

func NewNuGetFeed 

func NewNuGetFeed(name string, feedURI string) (*NuGetFeed, error)

NewNuGetFeed creates and initializes a NuGet feed.

func (*NuGetFeed) GetFeedType 

func (f *NuGetFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*NuGetFeed) GetName 

func (f *NuGetFeed) GetName() string

GetName returns the name of the feed.

func (*NuGetFeed) GetPackageAcquisitionLocationOptions 

func (f *NuGetFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*NuGetFeed) GetPassword 

func (f *NuGetFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*NuGetFeed) GetSpaceID 

func (f *NuGetFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*NuGetFeed) GetUsername 

func (f *NuGetFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*NuGetFeed) SetFeedType 

func (f *NuGetFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*NuGetFeed) SetName 

func (f *NuGetFeed) SetName(name string)

SetName sets the name of the feed.

func (*NuGetFeed) SetPackageAcquisitionLocationOptions 

func (f *NuGetFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*NuGetFeed) SetPassword 

func (f *NuGetFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*NuGetFeed) SetSpaceID 

func (f *NuGetFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*NuGetFeed) SetUsername 

func (f *NuGetFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*NuGetFeed) Validate 

func (n *NuGetFeed) Validate() error

Validate checks the state of this NuGet feed and returns an error if invalid.

type OctopusProjectFeed 

type OctopusProjectFeed struct {
	// contains filtered or unexported fields
}

OctopusProjectFeed represents an Octopus project feed.

func NewOctopusProjectFeed 

func NewOctopusProjectFeed(name string) (*OctopusProjectFeed, error)

NewOctopusProjectFeed creates and initializes a Octopus project feed.

func (*OctopusProjectFeed) GetFeedType 

func (f *OctopusProjectFeed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*OctopusProjectFeed) GetName 

func (f *OctopusProjectFeed) GetName() string

GetName returns the name of the feed.

func (*OctopusProjectFeed) GetPackageAcquisitionLocationOptions 

func (f *OctopusProjectFeed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*OctopusProjectFeed) GetPassword 

func (f *OctopusProjectFeed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*OctopusProjectFeed) GetSpaceID 

func (f *OctopusProjectFeed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*OctopusProjectFeed) GetUsername 

func (f *OctopusProjectFeed) GetUsername() string

GetUsername returns the username of the feed.

func (*OctopusProjectFeed) SetFeedType 

func (f *OctopusProjectFeed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*OctopusProjectFeed) SetName 

func (f *OctopusProjectFeed) SetName(name string)

SetName sets the name of the feed.

func (*OctopusProjectFeed) SetPackageAcquisitionLocationOptions 

func (f *OctopusProjectFeed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*OctopusProjectFeed) SetPassword 

func (f *OctopusProjectFeed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*OctopusProjectFeed) SetSpaceID 

func (f *OctopusProjectFeed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*OctopusProjectFeed) SetUsername 

func (f *OctopusProjectFeed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*OctopusProjectFeed) Validate 

func (o *OctopusProjectFeed) Validate() error

Validate checks the state of this Octopus project feed and returns an error if invalid.

type S3Feed added in v2.37.1 

type S3Feed struct {
	AccessKey             string               `json:"AccessKey,omitempty"`
	SecretKey             *core.SensitiveValue `json:"SecretKey,omitempty"`
	UseMachineCredentials bool                 `json:"UseMachineCredentials"`
	// contains filtered or unexported fields
}

S3Feed represents an Amazon Web Services (AWS) S3 Bucket Feed

func NewS3Feed added in v2.37.1 

func NewS3Feed(name string, accessKey string, secretKey *core.SensitiveValue, useMachineCredentials bool) (*S3Feed, error)

NewS3Feed creates and initializes an Amazon S3 Bucket Feed

func (*S3Feed) GetFeedType added in v2.37.1 

func (f *S3Feed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*S3Feed) GetName added in v2.37.1 

func (f *S3Feed) GetName() string

GetName returns the name of the feed.

func (*S3Feed) GetPackageAcquisitionLocationOptions added in v2.37.1 

func (f *S3Feed) GetPackageAcquisitionLocationOptions() []string

GetPackageAcquisitionLocationOptions returns the package acquisition location options of the feed.

func (*S3Feed) GetPassword added in v2.37.1 

func (f *S3Feed) GetPassword() *core.SensitiveValue

GetPassword returns the password of the feed.

func (*S3Feed) GetSpaceID added in v2.37.1 

func (f *S3Feed) GetSpaceID() string

GetSpaceID returns the space ID of the feed.

func (*S3Feed) GetUsername added in v2.37.1 

func (f *S3Feed) GetUsername() string

GetUsername returns the username of the feed.

func (*S3Feed) SetFeedType added in v2.37.1 

func (f *S3Feed) SetFeedType(feedType FeedType)

SetFeedType returns the type of this feed.

func (*S3Feed) SetName added in v2.37.1 

func (f *S3Feed) SetName(name string)

SetName sets the name of the feed.

func (*S3Feed) SetPackageAcquisitionLocationOptions added in v2.37.1 

func (f *S3Feed) SetPackageAcquisitionLocationOptions(packageAcquisitionLocationOptions []string)

SetPackageAcquisitionLocationOptions sets the package acquisition location options of the feed.

func (*S3Feed) SetPassword added in v2.37.1 

func (f *S3Feed) SetPassword(password *core.SensitiveValue)

SetPassword sets the password of the feed.

func (*S3Feed) SetSpaceID added in v2.37.1 

func (f *S3Feed) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of the feed.

func (*S3Feed) SetUsername added in v2.37.1 

func (f *S3Feed) SetUsername(username string)

SetUsername sets the username of the feed.

func (*S3Feed) Validate added in v2.37.1 

func (a *S3Feed) Validate() error

Validate checks the state of this Amazon Web Services (AWS) S3 Bucket Feed

type SearchPackageVersionsQuery added in v2.3.0 

type SearchPackageVersionsQuery struct {
	FeedID              string `uri:"id,omitempty"`
	Filter              string `uri:"filter,omitempty"`
	IncludePreRelease   bool   `uri:"includePreRelease,omitempty"`
	IncludeReleaseNotes bool   `uri:"includeReleaseNotes,omitempty"`
	PackageID           string `uri:"packageId,omitempty"`
	PreReleaseTag       string `uri:"preReleaseTag,omitempty"`
	Skip                int    `uri:"skip,omitempty"`
	Take                int    `uri:"take,omitempty"`
	VersionRange        string `uri:"versionRange,omitempty"`
}

type SearchPackagesQuery 

type SearchPackagesQuery struct {
	Skip int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int    `uri:"take,omitempty" url:"take,omitempty"`
	Term string `uri:"term,omitempty" url:"term,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.