packages

Documentation

Index

• func IsNil(i interface{}) bool
• type DeploymentActionPackage
• type OctopusPackageMetadataService
• type Package
  • func NewPackage() *Package
• type PackageDeltaSignatureQuery
• type PackageDeltaUploadQuery
• type PackageDescription
• type PackageMetadataQuery
• type PackageMetadataService
  • func NewPackageMetadataService(sling *sling.Sling, uriTemplate string) *PackageMetadataService
• type PackageNote
  • func NewPackageNote() *PackageNote
• type PackageNotesListQuery
• type PackageNotesResult
  • func NewPackageNotesResult() *PackageNotesResult
• type PackageReference
• type PackageService
  • func NewPackageService(sling *sling.Sling, uriTemplate string, deltaSignaturePath string, ...) *PackageService
  • func (s *PackageService) GetAll() ([]*Package, error)
  • func (s *PackageService) GetByID(id string) (*Package, error)
  • func (s *PackageService) Update(octopusPackage *Package) (*Package, error)
• type PackageUploadQuery
• type PackageVersion
  • func NewPackageVersion() *PackageVersion
• type PackagesBulkQuery
• type PackagesQuery
• type SelectedPackage

Functions

func IsNil

func IsNil(i interface{}) bool

Types

type DeploymentActionPackage

type DeploymentActionPackage struct {
	DeploymentAction string `json:"DeploymentAction,omitempty"`
	PackageReference string `json:"PackageReference,omitempty"`
}

type OctopusPackageMetadataService

type OctopusPackageMetadataService struct {
	services.Service
}

type Package

type Package struct {
	Description      string                             `json:"Description,omitempty"`
	FeedID           string                             `json:"FeedId,omitempty"`
	FileExtension    string                             `json:"FileExtension,omitempty"`
	NuGetFeedID      string                             `json:"NuGetFeedId,omitempty"`
	NuGetPackageID   string                             `json:"NuGetPackageId,omitempty"`
	PackageID        string                             `json:"PackageId,omitempty"`
	BuildInformation *buildinformation.BuildInformation `json:"PackageVersionBuildInformation,omitempty"`
	Published        time.Time                          `json:"ReleaseNotes,omitempty"`
	Summary          string                             `json:"Summary,omitempty"`
	Title            string                             `json:"Title,omitempty"`
	Version          string                             `json:"Version,omitempty"`

	resources.Resource
}

func NewPackage

func NewPackage() *Package

type PackageDeltaSignatureQuery

type PackageDeltaSignatureQuery struct {
	PackageID string `uri:"packageId,omitempty" url:"packageId,omitempty"`
	Version   string `uri:"version,omitempty" url:"version,omitempty"`
}

type PackageDeltaUploadQuery

type PackageDeltaUploadQuery struct {
	BaseVersion   string `uri:"baseVersion,omitempty" url:"baseVersion,omitempty"`
	OverwriteMode string `uri:"overwriteMode,omitempty" url:"overwriteMode,omitempty"`
	PackageID     string `uri:"packageId,omitempty" url:"packageId,omitempty"`
	Replace       bool   `uri:"replace,omitempty" url:"replace,omitempty"`
}

type PackageDescription

type PackageDescription struct {
	Description   string `json:"Description,omitempty"`
	LatestVersion string `json:"LatestVersion,omitempty"`
	Name          string `json:"Name,omitempty"`

	resources.Resource
}

type PackageMetadataQuery

type PackageMetadataQuery struct {
	Filter        string `uri:"filter,omitempty" url:"filter,omitempty"`
	Latest        string `uri:"latest,omitempty" url:"latest,omitempty"`
	OverwriteMode string `uri:"overwriteMode,omitempty" url:"overwriteMode,omitempty"`
	Replace       bool   `uri:"replace,omitempty" url:"replace,omitempty"`
	Skip          int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take          int    `uri:"take,omitempty" url:"take,omitempty"`
}

type PackageMetadataService

type PackageMetadataService struct {
	services.Service
}

func NewPackageMetadataService

func NewPackageMetadataService(sling *sling.Sling, uriTemplate string) *PackageMetadataService

type PackageNote

type PackageNote struct {
	FeedID    string              `json:"FeedId,omitempty"`
	Notes     *PackageNotesResult `json:"Notes,omitempty"`
	PackageID string              `json:"PackageId,omitempty"`
	Version   string              `json:"Version,omitempty"`
}

func NewPackageNote

func NewPackageNote() *PackageNote

type PackageNotesListQuery

type PackageNotesListQuery struct {
	PackageIDs []string `uri:"packageIds,omitempty" url:"packageIds,omitempty"`
}

type PackageNotesResult

type PackageNotesResult struct {
	DisplayMessage string `json:"DisplayMessage,omitempty"`
	FailureReason  string `json:"FailureReason,omitempty"`
	Notes          string `json:"Notes,omitempty"`
	Succeeded      bool   `json:"Succeeded,omitempty"`
}

func NewPackageNotesResult

func NewPackageNotesResult() *PackageNotesResult

type PackageReference

type PackageReference struct {
	AcquisitionLocation string            `json:"AcquisitionLocation"` // This can be an expression
	FeedID              string            `json:"FeedId"`
	ID                  string            `json:"Id,omitempty"`
	Name                string            `json:"Name,omitempty"`
	PackageID           string            `json:"PackageId,omitempty"`
	Properties          map[string]string `json:"Properties"`
}

type PackageService

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

func NewPackageService

func NewPackageService(sling *sling.Sling, uriTemplate string, deltaSignaturePath string, deltaUploadPath string, notesListPath string, bulkPath string, uploadPath string) *PackageService

func (*PackageService) GetAll

func (s *PackageService) GetAll() ([]*Package, error)

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

func (*PackageService) GetByID

func (s *PackageService) GetByID(id string) (*Package, error)

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

func (*PackageService) Update

func (s *PackageService) Update(octopusPackage *Package) (*Package, error)

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

type PackageUploadQuery

type PackageUploadQuery struct {
	Replace       bool   `uri:"replace,omitempty" url:"replace,omitempty"`
	OverwriteMode string `uri:"overwriteMode,omitempty" url:"overwriteMode,omitempty"`
}

type PackageVersion

type PackageVersion struct {
	FeedID       string    `json:"FeedId,omitempty"`
	PackageID    string    `json:"PackageId,omitempty"`
	Published    time.Time `json:"Published,omitempty"`
	ReleaseNotes string    `json:"ReleaseNotes,omitempty"`
	SizeBytes    int64     `json:"SizeBytes,omitempty"`
	Title        string    `json:"Title,omitempty"`
	Version      string    `json:"Version,omitempty"`

	resources.Resource
}

func NewPackageVersion

func NewPackageVersion() *PackageVersion

type PackagesBulkQuery

type PackagesBulkQuery struct {
	IDs []string `uri:"ids,omitempty" url:"ids,omitempty"`
}

type PackagesQuery

type PackagesQuery struct {
	Filter         string `uri:"filter,omitempty" url:"filter,omitempty"`
	IncludeNotes   bool   `uri:"includeNotes,omitempty" url:"includeNotes,omitempty"`
	Latest         string `uri:"latest,omitempty" url:"latest,omitempty"`
	NuGetPackageID string `uri:"nuGetPackageId,omitempty" url:"nuGetPackageId,omitempty"`
	Skip           int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take           int    `uri:"take,omitempty" url:"take,omitempty"`
}

type SelectedPackage

type SelectedPackage struct {
	ActionName           string `json:"ActionName,omitempty"`
	PackageReferenceName string `json:"PackageReferenceName,omitempty"`
	StepName             string `json:"StepName,omitempty"`
	Version              string `json:"Version,omitempty"`
}