Documentation
¶
Index ¶
- Constants
- func DeleteByID(client newclient.Client, spaceId string, id string) error
- func DeleteByIDs(client newclient.Client, spaceId string, ids []string) error
- func Get(client newclient.Client, spaceId string, ...) (*resources.Resources[*BuildInformation], error)
- func IsNil(i interface{}) bool
- type BuildInformation
- func Add(client newclient.Client, command *CreateBuildInformationCommand) (*BuildInformation, error)
- func GetAll(client newclient.Client, spaceId string) ([]*BuildInformation, error)
- func GetById(client newclient.Client, spaceId string, id string) (*BuildInformation, error)
- func NewBuildInformation() *BuildInformation
- type BuildInformationBulkQuery
- type BuildInformationQuery
- type BuildInformationService
- type Commit
- type CreateBuildInformationCommand
- type OctopusBuildInformation
- type OverwriteMode
Constants ¶
View Source
const ( OverwriteModeFailIfExists = OverwriteMode("FailIfExists") OverwriteModeIgnoreIfExists = OverwriteMode("IgnoreIfExists") OverwriteModeOverwriteExisting = OverwriteMode("OverwriteExisting") )
Variables ¶
This section is empty.
Functions ¶
func DeleteByID ¶ added in v2.46.0
DeleteById deletes the build information based on the ID provided as input.
func DeleteByIDs ¶ added in v2.46.0
DeleteByIds deletes all build information based on the IDs provided as input.
func Get ¶ added in v2.46.0
func Get(client newclient.Client, spaceId string, buildInformationQuery BuildInformationQuery) (*resources.Resources[*BuildInformation], error)
Get returns a collection of build information based on the criteria defined by its input query parameters. If an error occurs, an empty collection is returned along with the associated error
Types ¶
type BuildInformation ¶
type BuildInformation struct {
Branch string `json:"Branch,omitempty"`
BuildEnvironment string `json:"BuildEnvironment,omitempty"`
BuildNumber string `json:"BuildNumber,omitempty"`
BuildURL string `json:"BuildUrl,omitempty"`
Commits []*issuetrackers.CommitDetails `json:"Commits"`
Created time.Time `json:"Created,omitempty"`
IncompleteDataWarning string `json:"IncompleteDataWarning,omitempty"`
IssueTrackerName string `json:"IssueTrackerName,omitempty"`
PackageID string `json:"PackageId,omitempty"`
VcsCommitNumber string `json:"VcsCommitNumber,omitempty"`
VcsCommitURL string `json:"VcsCommitUrl,omitempty"`
VcsRoot string `json:"VcsRoot,omitempty"`
VcsType string `json:"VcsType,omitempty"`
Version string `json:"Version,omitempty"`
WorkItems []*core.WorkItemLink `json:"WorkItems"`
resources.Resource
}
func Add ¶ added in v2.46.0
func Add(client newclient.Client, command *CreateBuildInformationCommand) (*BuildInformation, error)
Add creates a new build information package
func GetAll ¶ added in v2.46.0
func GetAll(client newclient.Client, spaceId string) ([]*BuildInformation, error)
GetAll returns all build information. If none can be found or an error occurs, it returns an empty collection.
func GetById ¶ added in v2.46.0
GetById returns the build information that matches the input ID. If one cannot be found, it return nil and an error
func NewBuildInformation ¶
func NewBuildInformation() *BuildInformation
type BuildInformationBulkQuery ¶
type BuildInformationBulkQuery struct {
IDs []string `uri:"ids,omitempty" url:"ids,omitempty"`
}
type BuildInformationQuery ¶
type BuildInformationQuery struct {
Filter string `uri:"filter,omitempty" url:"filter,omitempty"`
Latest bool `uri:"latest,omitempty" url:"latest,omitempty"`
OverwriteMode string `uri:"overwriteMode,omitempty" url:"overwriteMode,omitempty"`
PackageID string `uri:"packageId,omitempty" url:"packageId,omitempty"`
IncludeWorkItems bool `uri:"includeWorkItems,omitempty" url:"includeWorkItems,omitempty"`
Skip int `uri:"skip,omitempty" url:"skip,omitempty"`
Take int `uri:"take,omitempty" url:"take,omitempty"`
}
type BuildInformationService ¶
type BuildInformationService struct {
services.CanDeleteService
// contains filtered or unexported fields
}
func NewBuildInformationService ¶
func NewBuildInformationService(sling *sling.Sling, uriTemplate string, bulkPath string) *BuildInformationService
type CreateBuildInformationCommand ¶ added in v2.46.0
type CreateBuildInformationCommand struct {
SpaceId string `json:"SpaceId,omitempty"`
PackageId string `json:"PackageId,omitempty"`
Version string `json:"Version,omitempty"`
OctopusBuildInformation *OctopusBuildInformation `json:"OctopusBuildInformation,omitempty"`
OverwriteMode OverwriteMode `json:"OverwriteMode,omitempty"`
}
func NewCreateBuildInformationCommand ¶ added in v2.46.0
func NewCreateBuildInformationCommand(spaceId string, packageId string, version string, buildInformation OctopusBuildInformation) *CreateBuildInformationCommand
type OctopusBuildInformation ¶ added in v2.46.0
type OctopusBuildInformation struct {
BuildEnvironment string `json:"BuildEnvironment,omitempty"`
BuildNumber string `json:"BuildNumber,omitempty"`
BuildUrl string `json:"BuildUrl,omitempty"`
Branch string `json:"Branch,omitempty"`
VcsType string `json:"VcsType,omitempty"`
VcsRoot string `json:"VcsRoot,omitempty"`
VcsCommitNumber string `json:"VcsCommitNumber,omitempty"`
Commits []*Commit `json:"Commits"`
}
type OverwriteMode ¶ added in v2.46.0
type OverwriteMode string
Click to show internal directories.
Click to hide internal directories.