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

core

package
v2.112.0 Latest Latest
Warning

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

 Go to latest Published: Jul 9, 2026 License: Apache-2.0 Imports: 3 Imported by: 19

Documentation

Index

Constants

View Source 
const (
	TenantedDeploymentModeTenanted             = TenantedDeploymentMode("Tenanted")
	TenantedDeploymentModeTenantedOrUntenanted = TenantedDeploymentMode("TenantedOrUntenanted")
	TenantedDeploymentModeUntenanted           = TenantedDeploymentMode("Untenanted")
)
View Source 
const (
	GuidedFailureModeEnvironmentDefault = GuidedFailureMode("EnvironmentDefault")
	GuidedFailureModeOff                = GuidedFailureMode("Off")
	GuidedFailureModeOn                 = GuidedFailureMode("On")
)
View Source 
const (
	RetentionStrategyDefault string = "Default"
	RetentionStrategyForever string = "Forever"
	RetentionStrategyCount   string = "Count"
)
View Source 
const (
	RetentionUnitDays  string = "Days"
	RetentionUnitItems string = "Items"
)
View Source 
const (
	SkipMachineBehaviorNone                    = SkipMachineBehavior("None")
	SkipMachineBehaviorSkipUnavailableMachines = SkipMachineBehavior("SkipUnavailableMachines")
)

Variables

This section is empty.

Functions

func APIErrorChecker 

func APIErrorChecker(urlPath string, resp *http.Response, wantedResponseCode int, slingError error, octopusDeployError *APIError) error

APIErrorChecker is a generic error handler for the OctopusDeploy API.

Types

type APIError 

type APIError struct {
	ErrorMessage    string   `json:"ErrorMessage,omitempty"`
	Errors          []string `json:"Errors,omitempty"`
	FullException   string   `json:"FullException,omitempty"`
	HelpLink        string   `json:"HelpLink,omitempty"`
	HelpText        string   `json:"HelpText,omitempty"`
	ParsedHelpLinks []string `json:"ParsedHelpLinks,omitempty"`
	StatusCode      int
}

APIError is a generic structure for containing errors for API operations.

func (APIError) Error 

func (e APIError) Error() string

Error creates a predefined error for Octopus API responses.

type ConnectivityCheck 

type ConnectivityCheck struct {
	DependsOnPropertyNames []string `json:"DependsOnPropertyNames"`
	Title                  string   `json:"Title,omitempty"`
	URL                    string   `json:"Url,omitempty"`
}

func NewConnectivityCheck 

func NewConnectivityCheck() *ConnectivityCheck

type ConnectivityPolicy 

type ConnectivityPolicy struct {
	AllowDeploymentsToNoTargets bool                `json:"AllowDeploymentsToNoTargets"`
	ExcludeUnhealthyTargets     bool                `json:"ExcludeUnhealthyTargets"`
	SkipMachineBehavior         SkipMachineBehavior `json:"SkipMachineBehavior,omitempty"`
	TargetRoles                 []string            `json:"TargetRoles,omitempty"`
}

func NewConnectivityPolicy 

func NewConnectivityPolicy() *ConnectivityPolicy

type GuidedFailureMode added in v2.4.0 

type GuidedFailureMode string

type NamedReferenceItem 

type NamedReferenceItem struct {
	DisplayIDAndName bool   `json:"DisplayIdAndName"`
	DisplayName      string `json:"DisplayName,omitempty"`
	ID               string `json:"Id,omitempty"`
}

func NewNamedReferenceItem 

func NewNamedReferenceItem() *NamedReferenceItem

type PropertyValue 

type PropertyValue struct {
	IsSensitive    bool            `json:"IsSensitive"`
	SensitiveValue *SensitiveValue `json:"SensitiveValue,omitempty"`
	Value          string          `json:"Value,omitempty"`
}

func NewPropertyValue 

func NewPropertyValue(value string, isSensitive bool) PropertyValue

func (PropertyValue) MarshalJSON 

func (p PropertyValue) MarshalJSON() ([]byte, error)

func (*PropertyValue) UnmarshalJSON 

func (d *PropertyValue) UnmarshalJSON(data []byte) error

UnmarshalJSON sets this property value to its representation in JSON.

type RetentionPeriod 

type RetentionPeriod struct {
	QuantityToKeep    int32  `json:"QuantityToKeep"`
	ShouldKeepForever bool   `json:"ShouldKeepForever"`
	Unit              string `json:"Unit"`
	Strategy          string `json:"Strategy,omitempty"`
}

func CountBasedRetentionPeriod added in v2.80.0 

func CountBasedRetentionPeriod(quantityToKeep int32, unit string) *RetentionPeriod

func KeepForeverRetentionPeriod added in v2.80.0 

func KeepForeverRetentionPeriod() *RetentionPeriod

func NewRetentionPeriod 

func NewRetentionPeriod(quantityToKeep int32, unit string, shouldKeepForever bool) *RetentionPeriod

func SpaceDefaultRetentionPeriod added in v2.80.0 

func SpaceDefaultRetentionPeriod() *RetentionPeriod

func (*RetentionPeriod) UnmarshalJSON added in v2.80.0 

func (r *RetentionPeriod) UnmarshalJSON(data []byte) error

UnmarshalJSON sets a retention period to its representation in JSON.

type SensitiveValue 

type SensitiveValue struct {
	HasValue bool
	Hint     *string
	NewValue *string
}

func NewSensitiveValue 

func NewSensitiveValue(newValue string) *SensitiveValue

NewSensitiveValue creates and initializes a sensitive value.

type SkipMachineBehavior 

type SkipMachineBehavior string

type SkipTakeQuery 

type SkipTakeQuery struct {
	Skip int `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int `uri:"take,omitempty" url:"take,omitempty"`
}

type TenantedDeploymentMode 

type TenantedDeploymentMode string
type WorkItemLink struct {
	Description string `json:"Description,omitempty"`
	ID          string `json:"Id,omitempty"`
	LinkURL     string `json:"LinkUrl,omitempty"`
	Source      string `json:"Source,omitempty"`
}
func NewWorkItemLink() *WorkItemLink

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.