octopusdeploy

package
v1.7.29 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2021 License: Apache-2.0 Imports: 21 Imported by: 4

Documentation ¶

Index ¶

Constants ¶

View Source 
const (
	AccountTypeNone                     = AccountType("None")
	AccountTypeAmazonWebServicesAccount = AccountType("AmazonWebServicesAccount")
	AccountTypeAzureServicePrincipal    = AccountType("AzureServicePrincipal")
	AccountTypeAzureSubscription        = AccountType("AzureSubscription")
	AccountTypeSSHKeyPair               = AccountType("SshKeyPair")
	AccountTypeToken                    = AccountType("Token")
	AccountTypeUsernamePassword         = AccountType("UsernamePassword")
)
View Source 
const (
	ActionTypeAWSApplyCloudFormationChangeset string = "Octopus.AwsApplyCloudFormationChangeSet"
	ActionTypeAWSDeleteCloudFormation         string = "Octopus.AwsDeleteCloudFormation"
	ActionTypeAWSRunCloudFormation            string = "Octopus.AwsRunCloudFormation"
	ActionTypeAWSRunScript                    string = "Octopus.AwsRunScript"
	ActionTypeAWSUploadS3                     string = "Octopus.AwsUploadS3"
	ActionTypeOctopusScript                   string = "Octopus.Script"
	ActionTypeOctopusActionScriptBody         string = "Octopus.Action.Script.ScriptBody"
)
View Source 
const (
	OperationAdd                     string = "Add"
	OperationAPIAdd                  string = "apiAdd"
	OperationAPIDelete               string = "apiDelete"
	OperationAPIGet                  string = "apiGet"
	OperationAPIPost                 string = "apiPost"
	OperationAPIUpdate               string = "apiUpdate"
	OperationDelete                  string = "Delete"
	OperationDeleteByID              string = "DeleteByID"
	OperationGet                     string = "Get"
	OperationGetAPIKeyByID           string = "GetAPIKeyByID"
	OperationGetAPIKeys              string = "GetAPIKeys"
	OperationGetAuthentication       string = "GetAuthentication"
	OperationGetAuthenticationByUser string = "GetAuthenticationByUser"
	OperationGetByID                 string = "GetByID"
	OperationGetByIDs                string = "GetByIDs"
	OperationGetByName               string = "GetByName"
	OperationGetByPartialName        string = "GetByPartialName"
	OperationGetByProjectID          string = "GetByProjectID"
	OperationGetByUserID             string = "GetByUserID"
	OperationGetChannels             string = "GetChannels"
	OperationGetDeployments          string = "GetDeployments"
	OperationGetProject              string = "GetProject"
	OperationGetReleases             string = "GetReleases"
	OperationGetSummary              string = "GetSummary"
	OperationInstall                 string = "Install"
	OperationReplace                 string = "Replace"
	OperationSearchPackages          string = "SearchPackages"
	OperationUpdate                  string = "Update"
)
View Source 
const (
	ParameterAccessKey              string = "accessKey"
	ParameterAccount                string = "account"
	ParameterAccountResource        string = "accountResource"
	ParameterAccountType            string = "accountType"
	ParameterActionTemplate         string = "actionTemplate"
	ParameterApplicationPassword    string = "applicationPassword"
	ParameterArtifact               string = "artifact"
	ParameterAPIKey                 string = "apiKey"
	ParameterAPIKeyID               string = "apiKeyID"
	ParameterCertificate            string = "certificate"
	ParameterCertificateID          string = "certificateID"
	ParameterChannel                string = "channel"
	ParameterEnvironment            string = "environment"
	ParameterFeed                   string = "feed"
	ParameterID                     string = "id"
	ParameterIDs                    string = "ids"
	ParameterLibraryVariableSet     string = "libraryVariableSet"
	ParameterMachinePolicy          string = "machinePolicy"
	ParameterName                   string = "name"
	ParameterOctopusURL             string = "octopusURL"
	ParameterPackage                string = "package"
	ParameterPartialName            string = "partialName"
	ParameterPath                   string = "path"
	ParameterPrivateKeyFile         string = "privateKeyFile"
	ParameterProjectID              string = "projectID"
	ParameterProject                string = "project"
	ParameterRelease                string = "release"
	ParameterReplacementCertificate string = "replacementCertificate"
	ParameterResource               string = "resource"
	ParameterRunbook                string = "runbook"
	ParameterScopedUserRole         string = "scopedUserRole"
	ParameterSecretKey              string = "secretKey"
	ParameterSling                  string = "sling"
	ParameterTagSet                 string = "tagSet"
	ParameterTeam                   string = "team"
	ParameterToken                  string = "token"
	ParameterUser                   string = "user"
	ParameterUserID                 string = "userID"
	ParameterUserRole               string = "userRole"
	ParameterUsername               string = "username"
	ParameterWorker                 string = "worker"
	ParameterWorkerPool             string = "workerPool"
	ParameterWorkerPoolResource     string = "workerPoolResource"
	ParameterWorkerType             string = "workerType"
)
View Source 
const (
	ServiceAccountService                       string = "AccountService"
	ServiceActionTemplateService                string = "ActionTemplateService"
	ServiceAPIKeyService                        string = "APIKeyService"
	ServiceArtifactService                      string = "ArtifactService"
	ServiceAuthenticationService                string = "AuthenticationService"
	ServiceAzureEnvironmentService              string = "AzureEnvironmentService"
	ServiceAzureDevOpsConnectivityCheckService  string = "AzureDevOpsConnectivityCheckService"
	ServiceBuildInformationService              string = "BuildInformationService"
	ServiceCertificateService                   string = "CertificateService"
	ServiceCertificateConfigurationService      string = "CertificateConfigurationService"
	ServiceChannelService                       string = "ChannelService"
	ServiceCloudTemplateService                 string = "CloudTemplateService"
	ServiceCommunityActionTemplateService       string = "CommunityActionTemplateService"
	ServiceConfigurationService                 string = "ConfigurationService"
	ServiceDashboardConfigurationService        string = "DashboardConfigurationService"
	ServiceDashboardService                     string = "DashboardService"
	ServiceDeploymentService                    string = "DeploymentService"
	ServiceDeploymentProcessesService           string = "DeploymentProcessesService"
	ServiceDynamicExtensionService              string = "DynamicExtensionService"
	ServiceEnvironmentService                   string = "EnvironmentService"
	ServiceEventService                         string = "EventService"
	ServiceExternalSecurityGroupProviderService string = "ExternalSecurityGroupProviderService"
	ServiceFeaturesConfigurationService         string = "FeaturesConfigurationService"
	ServiceFeedService                          string = "FeedService"
	ServiceHomeService                          string = "HomeService"
	ServiceIssueTrackerService                  string = "IssueTrackerService"
	ServiceInterruptionService                  string = "InterruptionService"
	ServiceInvitationService                    string = "InvitationService"
	ServiceJiraIntegrationService               string = "JiraIntegrationService"
	ServiceLetsEncryptConfigurationService      string = "LetsEncryptConfigurationService"
	ServiceLibraryVariableSetService            string = "LibraryVariableSetService"
	ServiceLicenseService                       string = "LicenseService"
	ServiceLifecycleService                     string = "LifecycleService"
	ServiceMachinePolicyService                 string = "MachinePolicyService"
	ServiceMachineRoleService                   string = "MachineRoleService"
	ServiceMachineService                       string = "MachineService"
	ServiceMaintenanceConfigurationService      string = "MaintenanceConfigurationService"
	ServiceMigrationService                     string = "MigrationService"
	ServiceNuGetService                         string = "NuGetService"
	ServiceOctopusPackageMetadataService        string = "OctopusPackageMetadataService"
	ServiceOctopusServerNodeService             string = "OctopusServerNodeService"
	ServicePackageService                       string = "PackageService"
	ServicePackageMetadataService               string = "PackageMetadataService"
	ServicePerformanceConfigurationService      string = "PerformanceConfigurationService"
	ServicePermissionService                    string = "PermissionService"
	ServiceProjectGroupService                  string = "ProjectGroupService"
	ServiceProjectService                       string = "ProjectService"
	ServiceProjectTriggerService                string = "ProjectTriggerService"
	ServiceProxyService                         string = "ProxyService"
	ServiceReleaseService                       string = "ReleaseService"
	ServiceReportingService                     string = "ReportingService"
	ServiceRootService                          string = "RootService"
	ServiceRunbookProcessService                string = "RunbookProcessService"
	ServiceRunbookRunService                    string = "RunbookRunService"
	ServiceRunbookSnapshotService               string = "RunbookSnapshotService"
	ServiceRunbookService                       string = "RunbookService"
	ServiceScheduledProjectTriggerService       string = "ScheduledProjectTriggerService"
	ServiceSchedulerService                     string = "SchedulerService"
	ServiceScopedUserRoleService                string = "ScopedUserRoleService"
	ServiceServerConfigurationService           string = "ServerConfigurationService"
	ServiceServerStatusService                  string = "ServerStatusService"
	ServiceSpaceService                         string = "SpaceService"
	ServiceSMTPConfigurationService             string = "SMTPConfigurationService"
	ServiceSubscriptionService                  string = "SubscriptionService"
	ServiceTagSetService                        string = "TagSetService"
	ServiceTaskService                          string = "TaskService"
	ServiceTeamMembershipService                string = "TeamMembershipService"
	ServiceTeamService                          string = "TeamService"
	ServiceTenantService                        string = "TenantService"
	ServiceTenantVariableService                string = "TenantVariableService"
	ServiceUpgradeConfigurationService          string = "UpgradeConfigurationService"
	ServiceUserOnboardingService                string = "UserOnboardingService"
	ServiceUserService                          string = "UserService"
	ServiceUserRoleService                      string = "UserRoleService"
	ServiceVariableService                      string = "VariableService"
	ServiceWorkerPoolService                    string = "WorkerPoolService"
	ServiceWorkerService                        string = "WorkerService"
	ServiceWorkerToolsLatestImageService        string = "WorkerToolsLatestImageService"
)
View Source 
const (
	PackageAcquisitionLocationServer          = "Server"
	PackageAcquisitionLocationExecutionTarget = "ExecutionTarget"
	PackageAcquisitionLocationNotAcquired     = "NotAcquired"
)
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")
)
View Source 
const (
	RetentionUnitDays  string = "Days"
	RetentionUnitItems string = "Items"
)
View Source 
const (
	SkipMachineBehaviorNone                    = SkipMachineBehavior("None")
	SkipMachineBehaviorSkipUnavailableMachines = SkipMachineBehavior("SkipUnavailableMachines")
)
View Source 
const (
	TenantedDeploymentModeTenanted             = TenantedDeploymentMode("Tenanted")
	TenantedDeploymentModeTenantedOrUntenanted = TenantedDeploymentMode("TenantedOrUntenanted")
	TenantedDeploymentModeUntenanted           = TenantedDeploymentMode("Untenanted")
)
View Source 
const ManualInterventionDecline = "Abort"
View Source 
const ManualInterverventionApprove = "Proceed"

Variables ¶

View Source 
var ErrItemNotFound = errors.New("cannot find the item")

ErrItemNotFound is an OctopusDeploy error returned an item cannot be found.

View Source 
var ValidMachineStatuses = []string{
	"Online", "Offline", "Unknown", "NeedsUpgrade", "CalamariNeedsUpgrade", "Disabled",
}

ValidMachineStatuses provides options for valid machine status

View Source 
var ValidProjectConnectivityPolicySkipMachineBehaviors = []SkipMachineBehavior{
	SkipMachineBehaviorNone,
	SkipMachineBehaviorSkipUnavailableMachines,
}

ValidProjectConnectivityPolicySkipMachineBehaviors provides options for "Skip Deployment Targets" - https://octopus.com/docs/deployment-patterns/elastic-and-transient-environments/deploying-to-transient-targets

View Source 
var ValidProjectDefaultGuidedFailureModes = []string{
	"EnvironmentDefault", "Off", "On",
}

ValidProjectDefaultGuidedFailureModes provides options for "Default failure mode" - https://octopus.com/docs/deployment-process/releases/guided-failures

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.

func Bool ¶ added in v1.7.0 

func Bool(v bool) *bool

func FromTimeSpan ¶ added in v1.7.0 

func FromTimeSpan(timeSpan string) time.Duration

func Int ¶ added in v1.7.0 

func Int(v int) *int

func Int64 ¶ added in v1.7.0 

func Int64(v int64) *int64

func LoadNextPage ¶ 

func LoadNextPage(pagedResults PagedResults) (string, bool)

LoadNextPage checks if the next page should be loaded from the API. Returns the new path and a bool if the next page should be checked.

func NotAll ¶ added in v1.7.0 

func NotAll(fl validator.FieldLevel) bool

NotAll is the validation function for validating if the current field has a value of "all".

func PrettyJSON ¶ added in v1.7.0 

func PrettyJSON(data interface{}) string

func String ¶ added in v1.7.0 

func String(v string) *string

func ToTimeSpan ¶ added in v1.7.0 

func ToTimeSpan(duration time.Duration) string

func ValidateLibraryVariableSetValues ¶ 

func ValidateLibraryVariableSetValues(LibraryVariableSet *LibraryVariableSet) error

ValidateLibraryVariableSetValues checks the values of a library variable set to see if they are suitable for sending to Octopus Deploy. Used when adding or updating library variable sets.

func ValidateMultipleProperties ¶ 

func ValidateMultipleProperties(validatePropertyErrors []error) error

ValidateMultipleProperties returns the first error in a list of property validations

func ValidatePropertiesMatch ¶ 

func ValidatePropertiesMatch(firstProperty, firstPropertyName, secondProperty, secondPropertyName string) error

ValidatePropertiesMatch checks two values against each other

func ValidatePropertyValues ¶ 

func ValidatePropertyValues(propertyName string, propertyValue string, validValues []string) error

ValidatePropertyValues returns an error if the given string is not in a slice of strings

func ValidateRequiredPropertyValue ¶ 

func ValidateRequiredPropertyValue(propertyName string, propertyValue string) error

ValidateRequiredPropertyValue returns an error if the property value is empty

func ValidateRequiredSensitiveValue ¶ added in v1.7.0 

func ValidateRequiredSensitiveValue(propertyName string, sensitiveValue *SensitiveValue) error

func ValidateRequiredUUID ¶ added in v1.7.0 

func ValidateRequiredUUID(propertyName string, id *uuid.UUID) error

func ValidateSemanticVersion ¶ added in v1.7.0 

func ValidateSemanticVersion(propertyName string, version string) error

func ValidateStringInSlice ¶ 

func ValidateStringInSlice(str string, list []string) bool

ValidateStringInSlice checks if a string is in the given slice

Types ¶

type APIError ¶ 

type APIError struct {
	Details         string   `json:"Details,omitempty"`
	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 APIKey ¶ added in v1.7.0 

type APIKey struct {
	APIKey  string     `json:"ApiKey,omitempty"`
	Created *time.Time `json:"Created,omitempty"`
	Purpose string     `json:"Purpose,omitempty"`
	UserID  string     `json:"UserId,omitempty"`
	// contains filtered or unexported fields
}

APIKey represents an API key.

func NewAPIKey ¶ added in v1.7.0 

func NewAPIKey(purpose string, userID string) *APIKey

NewAPIKey initializes an API key with a purpose.

func (*APIKey) GetID ¶ added in v1.7.0 

func (r *APIKey) GetID() string

GetID returns the ID value of the resource. 

func (r *APIKey) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*APIKey) GetModifiedBy ¶ added in v1.7.0 

func (r *APIKey) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*APIKey) GetModifiedOn ¶ added in v1.7.0 

func (r *APIKey) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*APIKey) Validate ¶ added in v1.7.0 

func (r *APIKey) Validate() error

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

type APIKeys ¶ added in v1.7.0 

type APIKeys struct {
	Items []*APIKey `json:"Items"`
	PagedResults
}

APIKeys defines a collection of API keys with built-in support for paged results.

type APIQuery ¶ added in v1.7.0 

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

type AccountResource ¶ added in v1.7.0 

type AccountResource struct {
	AccessKey               string                 `json:"AccessKey,omitempty"`
	AccountType             AccountType            `json:"AccountType"`
	ApplicationID           *uuid.UUID             `json:"ClientId,omitempty"`
	ApplicationPassword     *SensitiveValue        `json:"Password,omitempty"`
	AuthenticationEndpoint  string                 `json:"ActiveDirectoryEndpointBaseUri,omitempty"`
	AzureEnvironment        string                 `json:"AzureEnvironment,omitempty"`
	CertificateBytes        *SensitiveValue        `json:"CertificateBytes,omitempty"`
	CertificateThumbprint   string                 `json:"CertificateThumbprint,omitempty"`
	Description             string                 `json:"Description,omitempty"`
	EnvironmentIDs          []string               `json:"EnvironmentIds,omitempty"`
	ManagementEndpoint      string                 `json:"ServiceManagementEndpointBaseUri,omitempty"`
	Name                    string                 `json:"Name" validate:"required,notall"`
	PrivateKeyFile          *SensitiveValue        `json:"PrivateKeyFile,omitempty"`
	PrivateKeyPassphrase    *SensitiveValue        `json:"PrivateKeyPassphrase,omitempty"`
	ResourceManagerEndpoint string                 `json:"ResourceManagementEndpointBaseUri,omitempty"`
	SecretKey               *SensitiveValue        `json:"SecretKey,omitempty"`
	StorageEndpointSuffix   string                 `json:"ServiceManagementEndpointSuffix,omitempty"`
	SpaceID                 string                 `json:"SpaceId,omitempty"`
	SubscriptionID          *uuid.UUID             `json:"SubscriptionNumber,omitempty"`
	TenantedDeploymentMode  TenantedDeploymentMode `json:"TenantedDeploymentParticipation"`
	TenantID                *uuid.UUID             `json:"TenantId,omitempty"`
	TenantIDs               []string               `json:"TenantIds,omitempty"`
	TenantTags              []string               `json:"TenantTags,omitempty"`
	Token                   *SensitiveValue        `json:"Token,omitempty"`
	Username                string                 `json:"Username,omitempty"`
	// contains filtered or unexported fields
}

AccountResource represents account details used for deployments, including username/password, tokens, Azure and AWS credentials, and SSH key pairs.

func NewAccountResource ¶ added in v1.7.0 

func NewAccountResource(name string, accountType AccountType) *AccountResource

NewAccount creates and initializes an account resource with a name and type.

func ToAccountResource ¶ added in v1.7.0 

func ToAccountResource(account IAccount) (*AccountResource, error)

func (*AccountResource) GetAccountType ¶ added in v1.7.0 

func (a *AccountResource) GetAccountType() AccountType

GetAccountType returns the type of this account resource.

func (*AccountResource) GetDescription ¶ added in v1.7.0 

func (a *AccountResource) GetDescription() string

GetDescription returns the description of this account resource.

func (*AccountResource) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *AccountResource) GetEnvironmentIDs() []string

func (*AccountResource) GetID ¶ added in v1.7.0 

func (r *AccountResource) GetID() string

GetID returns the ID value of the resource. 

func (r *AccountResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*AccountResource) GetModifiedBy ¶ added in v1.7.0 

func (r *AccountResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*AccountResource) GetModifiedOn ¶ added in v1.7.0 

func (r *AccountResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*AccountResource) GetName ¶ added in v1.7.0 

func (a *AccountResource) GetName() string

GetName returns the name of this account resource.

func (*AccountResource) GetSpaceID ¶ added in v1.7.0 

func (a *AccountResource) GetSpaceID() string

GetSpaceID returns the space ID of this account resource.

func (*AccountResource) GetTenantIDs ¶ added in v1.7.0 

func (a *AccountResource) GetTenantIDs() []string

func (*AccountResource) GetTenantTags ¶ added in v1.7.0 

func (a *AccountResource) GetTenantTags() []string

func (*AccountResource) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *AccountResource) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*AccountResource) SetDescription ¶ added in v1.7.0 

func (a *AccountResource) SetDescription(description string)

SetDescription sets the description of the account resource.

func (*AccountResource) SetName ¶ added in v1.7.0 

func (a *AccountResource) SetName(name string)

SetName sets the name of this account resource.

func (*AccountResource) SetSpaceID ¶ added in v1.7.0 

func (a *AccountResource) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account resource.

func (*AccountResource) Validate ¶ added in v1.7.0 

func (a *AccountResource) Validate() error

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

type AccountResources ¶ added in v1.7.0 

type AccountResources struct {
	Items []*AccountResource `json:"Items"`
	PagedResults
}

AccountResources defines a collection of account resources with built-in support for paged results.

type AccountType ¶ added in v1.6.0 

type AccountType string

type AccountUsage ¶ added in v1.7.0 

type AccountUsage struct {
	DeploymentProcesses []*StepUsage                    `json:"DeploymentProcesses,omitempty"`
	LibraryVariableSets []*LibraryVariableSetUsageEntry `json:"LibraryVariableSets,omitempty"`
	ProjectVariableSets []*ProjectVariableSetUsage      `json:"ProjectVariableSets,omitempty"`
	Releases            []*ReleaseUsage                 `json:"Releases,omitempty"`
	RunbookProcesses    []*RunbookStepUsage             `json:"RunbookProcesses,omitempty"`
	RunbookSnapshots    []*RunbookSnapshotUsage         `json:"RunbookSnapshots,omitempty"`
	Targets             []*TargetUsageEntry             `json:"Targets,omitempty"`
	// contains filtered or unexported fields
}

AccountUsage contains the projects and deployments which are using an account.

func NewAccountUsage ¶ added in v1.7.0 

func NewAccountUsage() *AccountUsage

NewAccountUsage initializes an AccountUsage.

func (*AccountUsage) GetID ¶ added in v1.7.0 

func (r *AccountUsage) GetID() string

GetID returns the ID value of the resource. 

func (r *AccountUsage) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*AccountUsage) GetModifiedBy ¶ added in v1.7.0 

func (r *AccountUsage) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*AccountUsage) GetModifiedOn ¶ added in v1.7.0 

func (r *AccountUsage) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*AccountUsage) Validate ¶ added in v1.7.0 

func (r *AccountUsage) Validate() error

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

type Accounts ¶ 

type Accounts struct {
	Items []IAccount `json:"Items"`
	PagedResults
}

Accounts defines a collection of accounts with built-in support for paged results.

func ToAccounts ¶ added in v1.7.0 

func ToAccounts(accountResources *AccountResources) *Accounts

func (*Accounts) MarshalJSON ¶ added in v1.7.0 

func (a *Accounts) MarshalJSON() ([]byte, error)

MarshalJSON returns an Accounts struct as its JSON encoding.

func (*Accounts) UnmarshalJSON ¶ added in v1.7.0 

func (a *Accounts) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this Accounts struct to its representation in JSON.

type AccountsQuery ¶ added in v1.7.0 

type AccountsQuery struct {
	AccountType AccountType `uri:"accountType,omitempty" url:"accountType,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"`
}

AccountsQuery represents parameters to query the Accounts service.

type ActionTemplate ¶ added in v1.7.0 

type ActionTemplate struct {
	ActionType                string                    `json:"ActionType" validate:"required,notblank"`
	CommunityActionTemplateID string                    `json:"CommunityActionTemplateId,omitempty"`
	Description               string                    `json:"Description,omitempty"`
	Name                      string                    `json:"Name" validate:"required"`
	Packages                  []PackageReference        `json:"Packages,omitempty"`
	Parameters                []ActionTemplateParameter `json:"Parameters,omitempty"`
	Properties                map[string]PropertyValue  `json:"Properties,omitempty"`
	SpaceID                   string                    `json:"SpaceId,omitempty"`
	Version                   int32                     `json:"Version,omitempty"`
	// contains filtered or unexported fields
}

ActionTemplate represents an action template in Octopus Deploy.

func NewActionTemplate ¶ added in v1.7.0 

func NewActionTemplate(name string, actionType string) *ActionTemplate

NewActionTemplate creates and initializes an action template.

func (*ActionTemplate) GetID ¶ added in v1.7.0 

func (r *ActionTemplate) GetID() string

GetID returns the ID value of the resource. 

func (r *ActionTemplate) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ActionTemplate) GetModifiedBy ¶ added in v1.7.0 

func (r *ActionTemplate) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ActionTemplate) GetModifiedOn ¶ added in v1.7.0 

func (r *ActionTemplate) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ActionTemplate) Validate ¶ added in v1.7.0 

func (a *ActionTemplate) Validate() error

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

type ActionTemplateCategory ¶ added in v1.7.0 

type ActionTemplateCategory struct {
	DisplayOrder int32             `json:"DisplayOrder,omitempty"`
	ID           string            `json:"Id,omitempty"`
	Links        map[string]string `json:"Links,omitempty"`
	Name         string            `json:"Name,omitempty"`
}

ActionTemplateCategory represents an action template category.

type ActionTemplateLogoQuery ¶ added in v1.7.0 

type ActionTemplateLogoQuery struct {
	CB       string `uri:"cb,omitempty" url:"cb,omitempty"`
	TypeOrID string `uri:"typeOrId,omitempty" url:"typeOrId,omitempty"`
}

type ActionTemplateParameter ¶ 

type ActionTemplateParameter struct {
	DefaultValue    *PropertyValue    `json:"DefaultValue,omitempty"`
	DisplaySettings map[string]string `json:"DisplaySettings,omitempty"`
	HelpText        string            `json:"HelpText,omitempty"`
	Label           string            `json:"Label,omitempty"`
	Name            string            `json:"Name,omitempty"`
	// contains filtered or unexported fields
}

ActionTemplateParameter represents an action template parameter.

func NewActionTemplateParameter ¶ added in v1.7.0 

func NewActionTemplateParameter() *ActionTemplateParameter

func (*ActionTemplateParameter) GetID ¶ added in v1.7.0 

func (r *ActionTemplateParameter) GetID() string

GetID returns the ID value of the resource. 

func (r *ActionTemplateParameter) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ActionTemplateParameter) GetModifiedBy ¶ added in v1.7.0 

func (r *ActionTemplateParameter) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ActionTemplateParameter) GetModifiedOn ¶ added in v1.7.0 

func (r *ActionTemplateParameter) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ActionTemplateParameter) Validate ¶ added in v1.7.0 

func (r *ActionTemplateParameter) Validate() error

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

type ActionTemplateSearch ¶ added in v1.7.0 

type ActionTemplateSearch struct {
	Author                    string            `json:"Author,omitempty"`
	Categories                []string          `json:"Categories"`
	Category                  string            `json:"Category,omitempty"`
	CommunityActionTemplateID string            `json:"CommunityActionTemplateId,omitempty"`
	Description               string            `json:"Description,omitempty"`
	HasUpdate                 bool              `json:"HasUpdate,omitempty"`
	ID                        string            `json:"Id,omitempty"`
	IsBuiltIn                 bool              `json:"IsBuiltIn,omitempty"`
	IsInstalled               bool              `json:"IsInstalled,omitempty"`
	Keywords                  string            `json:"Keywords,omitempty"`
	Links                     map[string]string `json:"Links,omitempty"`
	Name                      string            `json:"Name,omitempty"`
	Type                      string            `json:"Type,omitempty"`
	Website                   string            `json:"Website,omitempty"`
}

ActionTemplateSearch represents an action template search.

type ActionTemplateVersionedLogoQuery ¶ added in v1.7.0 

type ActionTemplateVersionedLogoQuery struct {
	CB       string `uri:"cb,omitempty" url:"cb,omitempty"`
	TypeOrID string `uri:"typeOrId,omitempty" url:"typeOrId,omitempty"`
	Version  string `uri:"version,omitempty" url:"version,omitempty"`
}

type ActionTemplates ¶ added in v1.7.0 

type ActionTemplates struct {
	Items []*ActionTemplate `json:"Items"`
	PagedResults
}

ActionTemplates defines a collection of action templates with built-in support for paged results.

type ActionTemplatesQuery ¶ added in v1.7.0 

type ActionTemplatesQuery struct {
	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"`
}

ActionTemplatesQuery represents parameters to query the ActionTemplates service.

type ActivityLogElement ¶ added in v1.7.0 

type ActivityLogElement struct {
	Category    string    `json:"Category,omitempty"`
	Detail      string    `json:"Detail,omitempty"`
	MessageText string    `json:"MessageText,omitempty"`
	OccurredAt  time.Time `json:"OccurredAt,omitempty"`
}

ActivityLogElement represents an activity log element.

type ActivityLogEntry ¶ added in v1.7.0 

type ActivityLogEntry struct {
	Category    string    `` /* 150-byte string literal not displayed */
	Detail      string    `json:"Detail,omitempty"`
	MessageText string    `json:"MessageText,omitempty"`
	OccurredAt  time.Time `json:"OccurredAt,omitempty"`
}

ActivityLogEntry represents an activity log entry.

type AmazonWebServicesAccount ¶ added in v1.6.0 

type AmazonWebServicesAccount struct {
	AccessKey string          `validate:"required"`
	SecretKey *SensitiveValue `validate:"required"`
	// contains filtered or unexported fields
}

AmazonWebServicesAccount represents an Amazon Web Services (AWS) account.

func NewAmazonWebServicesAccount ¶ added in v1.7.0 

func NewAmazonWebServicesAccount(name string, accessKey string, secretKey *SensitiveValue, options ...func(*AmazonWebServicesAccount)) (*AmazonWebServicesAccount, error)

NewAmazonWebServicesAccount initializes and returns an AWS account with a name, access key, and secret key.

func (*AmazonWebServicesAccount) GetAccountType ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*AmazonWebServicesAccount) GetDescription ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetDescription() string

GetDescription returns the description of the account.

func (*AmazonWebServicesAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetEnvironmentIDs() []string

func (*AmazonWebServicesAccount) GetName ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetName() string

GetName returns the name of the account.

func (*AmazonWebServicesAccount) GetSpaceID ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*AmazonWebServicesAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetTenantIDs() []string

func (*AmazonWebServicesAccount) GetTenantTags ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetTenantTags() []string

func (*AmazonWebServicesAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*AmazonWebServicesAccount) SetDescription ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*AmazonWebServicesAccount) SetName ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) SetName(name string)

SetName sets the name of the account.

func (*AmazonWebServicesAccount) SetSpaceID ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*AmazonWebServicesAccount) Validate ¶ added in v1.7.0 

func (a *AmazonWebServicesAccount) Validate() error

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

type Artifact ¶ added in v1.7.0 

type Artifact struct {
	Created          *time.Time `json:"Created,omitempty"`
	Filename         string     `json:"Filename" validate:"required"`
	LogCorrelationID string     `json:"LogCorrelationId,omitempty"`
	ServerTaskID     string     `json:"ServerTaskId,omitempty"`
	Source           string     `json:"Source,omitempty"`
	SpaceID          string     `json:"SpaceId,omitempty"`
	// contains filtered or unexported fields
}

Artifact represents an artifact.

func NewArtifact ¶ added in v1.7.0 

func NewArtifact(filename string) *Artifact

NewArtifact creates and initializes an artifact.

func (*Artifact) GetID ¶ added in v1.7.0 

func (r *Artifact) GetID() string

GetID returns the ID value of the resource. 

func (r *Artifact) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Artifact) GetModifiedBy ¶ added in v1.7.0 

func (r *Artifact) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Artifact) GetModifiedOn ¶ added in v1.7.0 

func (r *Artifact) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Artifact) Validate ¶ added in v1.7.0 

func (r *Artifact) Validate() error

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

type Artifacts ¶ added in v1.7.0 

type Artifacts struct {
	Items []*Artifact `json:"Items"`
	PagedResults
}

Artifacts defines a collection of artifacts with built-in support for paged results from the API.

type ArtifactsQuery ¶ added in v1.7.0 

type ArtifactsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Order       string   `uri:"order" url:"order,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Regarding   string   `uri:"regarding,omitempty" url:"regarding,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type Authentication ¶ added in v1.7.0 

type Authentication struct {
	AnyAuthenticationProvidersSupportPasswordManagement bool                             `json:"AnyAuthenticationProvidersSupportPasswordManagement"`
	AuthenticationProviders                             []*AuthenticationProviderElement `json:"AuthenticationProviders"`
	AutoLoginEnabled                                    bool                             `json:"AutoLoginEnabled"`
	// contains filtered or unexported fields
}

Authentication represents enabled authentication providers.

func NewAuthentication ¶ added in v1.7.0 

func NewAuthentication() *Authentication

func (*Authentication) GetID ¶ added in v1.7.0 

func (r *Authentication) GetID() string

GetID returns the ID value of the resource. 

func (r *Authentication) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Authentication) GetModifiedBy ¶ added in v1.7.0 

func (r *Authentication) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Authentication) GetModifiedOn ¶ added in v1.7.0 

func (r *Authentication) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Authentication) Validate ¶ added in v1.7.0 

func (r *Authentication) Validate() error

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

type AuthenticationProviderElement ¶ added in v1.7.0 

type AuthenticationProviderElement struct {
	CSSLinks          []string          `json:"CSSLinks"`
	FormsLoginEnabled bool              `json:"FormsLoginEnabled"`
	IdentityType      string            `json:"IdentityType,omitempty"`
	JavascriptLinks   []string          `json:"JavascriptLinks"`
	Links             map[string]string `json:"Links,omitempty"`
	Name              string            `json:"Name,omitempty"`
}

AuthenticationProviderElement represents an authentication provider element.

type AutoDeployReleaseOverride ¶ 

type AutoDeployReleaseOverride struct {
	EnvironmentID string `json:"EnvironmentId,omitempty"`
	ReleaseID     string `json:"ReleaseId,omitempty"`
	TenantID      string `json:"TenantId,omitempty"`
}

AutoDeployReleaseOverride represents an auto-deploy release override.

type AwsElasticContainerRegistry ¶ added in v1.7.0 

type AwsElasticContainerRegistry struct {
	AccessKey string          `json:"AccessKey,omitempty"`
	Region    string          `json:"Region"`
	SecretKey *SensitiveValue `json:"SecretKey,omitempty"`

	Feed
}

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

func NewAwsElasticContainerRegistry ¶ added in v1.7.0 

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

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

func (*AwsElasticContainerRegistry) GetID ¶ added in v1.7.0 

func (r *AwsElasticContainerRegistry) GetID() string

GetID returns the ID value of the resource. 

func (r *AwsElasticContainerRegistry) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*AwsElasticContainerRegistry) GetModifiedBy ¶ added in v1.7.0 

func (r *AwsElasticContainerRegistry) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*AwsElasticContainerRegistry) GetModifiedOn ¶ added in v1.7.0 

func (r *AwsElasticContainerRegistry) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*AwsElasticContainerRegistry) Validate ¶ added in v1.7.0 

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 AzureCloudServiceEndpoint ¶ added in v1.7.0 

type AzureCloudServiceEndpoint struct {
	AccountID               string `json:"AccountId"`
	CloudServiceName        string `json:"CloudServiceName"`
	DefaultWorkerPoolID     string `json:"DefaultWorkerPoolId"`
	Slot                    string `json:"Slot"`
	StorageAccountName      string `json:"StorageAccountName"`
	SwapIfPossible          bool   `json:"SwapIfPossible"`
	UseCurrentInstanceCount bool   `json:"UseCurrentInstanceCount"`
	// contains filtered or unexported fields
}

AzureCloudServiceEndpoint represents an Azure cloud service endpoint.

func NewAzureCloudServiceEndpoint ¶ added in v1.7.0 

func NewAzureCloudServiceEndpoint() *AzureCloudServiceEndpoint

NewAzureCloudServiceEndpoint creates and initializes a new Azure cloud service endpoint.

func (AzureCloudServiceEndpoint) GetAccountID ¶ added in v1.7.0 

func (a AzureCloudServiceEndpoint) GetAccountID() string

GetAccountID returns the account ID associated with this Azure cloud service endpoint.

func (AzureCloudServiceEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (e AzureCloudServiceEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (AzureCloudServiceEndpoint) GetDefaultWorkerPoolID ¶ added in v1.7.0 

func (a AzureCloudServiceEndpoint) GetDefaultWorkerPoolID() string

GetDefaultWorkerPoolID returns the default worker pool ID of this Azure cloud service endpoint.

func (AzureCloudServiceEndpoint) SetDefaultWorkerPoolID ¶ added in v1.7.0 

func (a AzureCloudServiceEndpoint) SetDefaultWorkerPoolID(defaultWorkerPoolID string)

SetDefaultWorkerPoolID sets the default worker pool ID of this Azure cloud service endpoint.

func (AzureCloudServiceEndpoint) Validate ¶ added in v1.7.0 

func (e AzureCloudServiceEndpoint) Validate() error

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

type AzureServiceFabricEndpoint ¶ added in v1.7.0 

type AzureServiceFabricEndpoint struct {
	AadClientCredentialSecret   string          `json:"AadClientCredentialSecret,omitempty"`
	AadCredentialType           string          `json:"AadCredentialType,omitempty" validate:"omitempty,oneof=ClientCredential UserCredential"`
	AadUserCredentialPassword   *SensitiveValue `json:"AadUserCredentialPassword,omitempty"`
	AadUserCredentialUsername   string          `json:"AadUserCredentialUsername,omitempty"`
	CertificateStoreLocation    string          `json:"CertificateStoreLocation,omitempty"`
	CertificateStoreName        string          `json:"CertificateStoreName,omitempty"`
	ClientCertificateVariable   string          `json:"ClientCertVariable,omitempty"`
	ConnectionEndpoint          string          `json:"ConnectionEndpoint,omitempty"`
	SecurityMode                string          `json:"SecurityMode,omitempty" validate:"omitempty,oneof=Unsecure SecureClientCertificate SecureAzureAD"`
	ServerCertificateThumbprint string          `json:"ServerCertThumbprint,omitempty"`
	// contains filtered or unexported fields
}

func NewAzureServiceFabricEndpoint ¶ added in v1.7.0 

func NewAzureServiceFabricEndpoint() *AzureServiceFabricEndpoint

func (AzureServiceFabricEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (e AzureServiceFabricEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (*AzureServiceFabricEndpoint) Validate ¶ added in v1.7.0 

func (s *AzureServiceFabricEndpoint) Validate() error

Validate checks the state of the service fabric endpoint and returns an error if invalid.

type AzureServicePrincipalAccount ¶ added in v1.7.0 

type AzureServicePrincipalAccount struct {
	ApplicationID           *uuid.UUID      `validate:"required"`
	ApplicationPassword     *SensitiveValue `validate:"required"`
	AuthenticationEndpoint  string          `validate:"required_with=AzureEnvironment,omitempty,uri"`
	AzureEnvironment        string          `validate:"omitempty,oneof=AzureCloud AzureChinaCloud AzureGermanCloud AzureUSGovernment"`
	ResourceManagerEndpoint string          `validate:"required_with=AzureEnvironment,omitempty,uri"`
	SubscriptionID          *uuid.UUID      `validate:"required"`
	TenantID                *uuid.UUID      `validate:"required"`
	// contains filtered or unexported fields
}

AzureServicePrincipalAccount represents an Azure service principal account.

func NewAzureServicePrincipalAccount ¶ added in v1.7.0 

func NewAzureServicePrincipalAccount(name string, subscriptionID uuid.UUID, tenantID uuid.UUID, applicationID uuid.UUID, applicationPassword *SensitiveValue, options ...func(*AzureServicePrincipalAccount)) (*AzureServicePrincipalAccount, error)

NewAzureServicePrincipalAccount creates and initializes an Azure service principal account.

func (*AzureServicePrincipalAccount) GetAccountType ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*AzureServicePrincipalAccount) GetDescription ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetDescription() string

GetDescription returns the description of the account.

func (*AzureServicePrincipalAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetEnvironmentIDs() []string

func (*AzureServicePrincipalAccount) GetName ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetName() string

GetName returns the name of the account.

func (*AzureServicePrincipalAccount) GetSpaceID ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*AzureServicePrincipalAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetTenantIDs() []string

func (*AzureServicePrincipalAccount) GetTenantTags ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetTenantTags() []string

func (*AzureServicePrincipalAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*AzureServicePrincipalAccount) SetDescription ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*AzureServicePrincipalAccount) SetName ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) SetName(name string)

SetName sets the name of the account.

func (*AzureServicePrincipalAccount) SetSpaceID ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*AzureServicePrincipalAccount) Validate ¶ added in v1.7.0 

func (a *AzureServicePrincipalAccount) Validate() error

Validate checks the state of this Azure service principal account and returns an error if invalid.

type AzureSubscriptionAccount ¶ added in v1.7.0 

type AzureSubscriptionAccount struct {
	AzureEnvironment      string `validate:"omitempty,oneof=AzureCloud AzureChinaCloud AzureGermanCloud AzureUSGovernment"`
	CertificateBytes      *SensitiveValue
	CertificateThumbprint string
	ManagementEndpoint    string     `validate:"omitempty,uri"`
	StorageEndpointSuffix string     `validate:"omitempty,hostname"`
	SubscriptionID        *uuid.UUID `validate:"required"`
	// contains filtered or unexported fields
}

AzureSubscriptionAccount represents an Azure subscription account.

func NewAzureSubscriptionAccount ¶ added in v1.7.0 

func NewAzureSubscriptionAccount(name string, subscriptionID uuid.UUID, options ...func(*AzureSubscriptionAccount)) (*AzureSubscriptionAccount, error)

NewAzureSubscriptionAccount creates and initializes an Azure subscription account with a name.

func (*AzureSubscriptionAccount) GetAccountType ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*AzureSubscriptionAccount) GetDescription ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetDescription() string

GetDescription returns the description of the account.

func (*AzureSubscriptionAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetEnvironmentIDs() []string

func (*AzureSubscriptionAccount) GetName ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetName() string

GetName returns the name of the account.

func (*AzureSubscriptionAccount) GetSpaceID ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*AzureSubscriptionAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetTenantIDs() []string

func (*AzureSubscriptionAccount) GetTenantTags ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetTenantTags() []string

func (*AzureSubscriptionAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*AzureSubscriptionAccount) SetDescription ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*AzureSubscriptionAccount) SetName ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) SetName(name string)

SetName sets the name of the account.

func (*AzureSubscriptionAccount) SetSpaceID ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*AzureSubscriptionAccount) Validate ¶ added in v1.7.0 

func (a *AzureSubscriptionAccount) Validate() error

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

type AzureWebAppEndpoint ¶ added in v1.7.0 

type AzureWebAppEndpoint struct {
	AccountID         string `json:"AccountId"`
	ResourceGroupName string `json:"ResourceGroupName,omitempty"`
	WebAppName        string `json:"WebAppName,omitempty"`
	WebAppSlotName    string `json:"WebAppSlotName"`
	// contains filtered or unexported fields
}

AzureWebAppEndpoint represents the an Azure web app-based endpoint.

func NewAzureWebAppEndpoint ¶ added in v1.7.0 

func NewAzureWebAppEndpoint() *AzureWebAppEndpoint

NewAzureWebAppEndpoint creates a new endpoint for Azure web apps.

func (AzureWebAppEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (e AzureWebAppEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (AzureWebAppEndpoint) Validate ¶ added in v1.7.0 

func (e AzureWebAppEndpoint) Validate() error

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

type BuildInformation ¶ added in v1.7.0 

type BuildInformation struct {
	Branch                string           `json:"Branch,omitempty"`
	BuildEnvironment      string           `json:"BuildEnvironment,omitempty"`
	BuildNumber           string           `json:"BuildNumber,omitempty"`
	BuildURL              string           `json:"BuildUrl,omitempty"`
	Commits               []*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             []*WorkItemLink  `json:"WorkItems"`
	// contains filtered or unexported fields
}

func NewBuildInformation ¶ added in v1.7.0 

func NewBuildInformation() *BuildInformation

func (*BuildInformation) GetID ¶ added in v1.7.0 

func (r *BuildInformation) GetID() string

GetID returns the ID value of the resource. 

func (r *BuildInformation) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*BuildInformation) GetModifiedBy ¶ added in v1.7.0 

func (r *BuildInformation) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*BuildInformation) GetModifiedOn ¶ added in v1.7.0 

func (r *BuildInformation) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*BuildInformation) Validate ¶ added in v1.7.0 

func (r *BuildInformation) Validate() error

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

type BuildInformationBulkQuery ¶ added in v1.7.0 

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

type BuildInformationQuery ¶ added in v1.7.0 

type BuildInformationQuery 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"`
	PackageID     string `uri:"packageId,omitempty" url:"packageId,omitempty"`
	Skip          int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take          int    `uri:"take,omitempty" url:"take,omitempty"`
}

type BuiltInFeed ¶ added in v1.7.0 

type BuiltInFeed struct {
	DeleteUnreleasedPackagesAfterDays *int `json:"DeleteUnreleasedPackagesAfterDays,omitempty"`
	DownloadAttempts                  int  `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds       int  `json:"DownloadRetryBackoffSeconds"`
	IsBuiltInRepoSyncEnabled          bool `json:"IsBuiltInRepoSyncEnabled"`

	Feed
}

BuiltInFeed represents a built-in feed.

func NewBuiltInFeed ¶ added in v1.7.0 

func NewBuiltInFeed(name string, feedURI string) *BuiltInFeed

NewBuiltInFeed creates and initializes a built-in feed.

func (*BuiltInFeed) GetID ¶ added in v1.7.0 

func (r *BuiltInFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *BuiltInFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*BuiltInFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *BuiltInFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*BuiltInFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *BuiltInFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*BuiltInFeed) Validate ¶ added in v1.7.0 

func (b *BuiltInFeed) Validate() error

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

type BuiltInFeedStatistics ¶ added in v1.7.0 

type BuiltInFeedStatistics struct {
	TotalPackages int32 `json:"TotalPackages,omitempty"`
	// contains filtered or unexported fields
}

func (*BuiltInFeedStatistics) GetID ¶ added in v1.7.0 

func (r *BuiltInFeedStatistics) GetID() string

GetID returns the ID value of the resource. 

func (r *BuiltInFeedStatistics) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*BuiltInFeedStatistics) GetModifiedBy ¶ added in v1.7.0 

func (r *BuiltInFeedStatistics) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*BuiltInFeedStatistics) GetModifiedOn ¶ added in v1.7.0 

func (r *BuiltInFeedStatistics) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*BuiltInFeedStatistics) Validate ¶ added in v1.7.0 

func (r *BuiltInFeedStatistics) Validate() error

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

type CertificateConfigurationQuery ¶ added in v1.7.0 

type CertificateConfigurationQuery struct {
	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 CertificateResource ¶ added in v1.7.0 

type CertificateResource struct {
	Archived                 string                 `json:"Archived,omitempty"`
	CertificateData          *SensitiveValue        `json:"CertificateData,omitempty" validate:"required"`
	CertificateDataFormat    string                 `json:"CertificateDataFormat,omitempty"`
	EnvironmentIDs           []string               `json:"EnvironmentIds,omitempty"`
	HasPrivateKey            bool                   `json:"HasPrivateKey,omitempty"`
	IsExpired                bool                   `json:"IsExpired,omitempty"`
	IssuerCommonName         string                 `json:"IssuerCommonName,omitempty"`
	IssuerDistinguishedName  string                 `json:"IssuerDistinguishedName,omitempty"`
	IssuerOrganization       string                 `json:"IssuerOrganization,omitempty"`
	Name                     string                 `json:"Name,omitempty" validate:"required"`
	NotAfter                 string                 `json:"NotAfter,omitempty"`
	NotBefore                string                 `json:"NotBefore,omitempty"`
	Notes                    string                 `json:"Notes,omitempty"`
	Password                 *SensitiveValue        `json:"Password,omitempty"`
	ReplacedBy               string                 `json:"ReplacedBy,omitempty"`
	SelfSigned               bool                   `json:"SelfSigned,omitempty"`
	SerialNumber             string                 `json:"SerialNumber,omitempty"`
	SignatureAlgorithmName   string                 `json:"SignatureAlgorithmName,omitempty"`
	SubjectAlternativeNames  []string               `json:"SubjectAlternativeNames,omitempty"`
	SubjectCommonName        string                 `json:"SubjectCommonName,omitempty"`
	SubjectDistinguishedName string                 `json:"SubjectDistinguishedName,omitempty"`
	SubjectOrganization      string                 `json:"SubjectOrganization,omitempty"`
	TenantedDeploymentMode   TenantedDeploymentMode `json:"TenantedDeploymentParticipation"`
	TenantIDs                []string               `json:"TenantIds,omitempty"`
	TenantTags               []string               `json:"TenantTags,omitempty"`
	Thumbprint               string                 `json:"Thumbprint,omitempty"`
	Version                  int                    `json:"Version,omitempty"`
	// contains filtered or unexported fields
}

func NewCertificateResource ¶ added in v1.7.0 

func NewCertificateResource(name string, certificateData *SensitiveValue, password *SensitiveValue) *CertificateResource

NewCertificateResource initializes a certificate resource with a name and credentials.

func (*CertificateResource) GetID ¶ added in v1.7.0 

func (r *CertificateResource) GetID() string

GetID returns the ID value of the resource. 

func (r *CertificateResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*CertificateResource) GetModifiedBy ¶ added in v1.7.0 

func (r *CertificateResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*CertificateResource) GetModifiedOn ¶ added in v1.7.0 

func (r *CertificateResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (CertificateResource) Validate ¶ added in v1.7.0 

func (c CertificateResource) Validate() error

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

type CertificateResources ¶ added in v1.7.0 

type CertificateResources struct {
	Items []*CertificateResource `json:"Items"`
	PagedResults
}

type CertificatesQuery ¶ added in v1.7.0 

type CertificatesQuery struct {
	Archived    string   `uri:"archived,omitempty" url:"archived,omitempty"`
	FirstResult string   `uri:"firstResult,omitempty" url:"firstResult,omitempty"`
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	OrderBy     string   `uri:"orderBy,omitempty" url:"orderBy,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Search      string   `uri:"search,omitempty" url:"search,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
	Tenant      string   `uri:"tenant,omitempty" url:"tenant,omitempty"`
}

type Channel ¶ added in v1.4.0 

type Channel struct {
	Description string        `json:"Description,omitempty"`
	IsDefault   bool          `json:"IsDefault"`
	LifecycleID string        `json:"LifecycleId,omitempty"`
	Name        string        `json:"Name" validate:"required,notblank,notall"`
	ProjectID   string        `json:"ProjectId" validate:"required,notblank"`
	Rules       []ChannelRule `json:"Rules,omitempty"`
	SpaceID     string        `json:"SpaceId,omitempty"`
	TenantTags  []string      `json:"TenantTags,omitempty"`
	// contains filtered or unexported fields
}

func NewChannel ¶ added in v1.4.0 

func NewChannel(name string, projectID string) *Channel

func (*Channel) GetID ¶ added in v1.7.0 

func (r *Channel) GetID() string

GetID returns the ID value of the resource. 

func (r *Channel) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Channel) GetModifiedBy ¶ added in v1.7.0 

func (r *Channel) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Channel) GetModifiedOn ¶ added in v1.7.0 

func (r *Channel) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (Channel) Validate ¶ added in v1.7.0 

func (c Channel) Validate() error

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

type ChannelRule ¶ added in v1.4.0 

type ChannelRule struct {
	ActionPackages []DeploymentActionPackage `json:"ActionPackages,omitempty"`
	ID             string                    `json:"Id,omitempty"`
	Tag            string                    `json:"Tag,omitempty"`

	//Use the NuGet or Maven versioning syntax (depending on the feed type)
	//to specify the range of versions to include
	VersionRange string `json:"VersionRange,omitempty"`
	// contains filtered or unexported fields
}

func (*ChannelRule) GetID ¶ added in v1.7.16 

func (r *ChannelRule) GetID() string

GetID returns the ID value of the resource. 

func (r *ChannelRule) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ChannelRule) GetModifiedBy ¶ added in v1.7.16 

func (r *ChannelRule) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ChannelRule) GetModifiedOn ¶ added in v1.7.16 

func (r *ChannelRule) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ChannelRule) Validate ¶ added in v1.7.16 

func (r *ChannelRule) Validate() error

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

type Channels ¶ added in v1.4.0 

type Channels struct {
	Items []*Channel `json:"Items"`
	PagedResults
}

Channels defines a collection of channels with built-in support for paged results.

type ChannelsQuery ¶ added in v1.7.0 

type ChannelsQuery struct {
	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 Client ¶ 

type Client struct {
	Accounts                       *accountService
	ActionTemplates                *actionTemplateService
	APIKeys                        *apiKeyService
	Artifacts                      *artifactService
	Authentication                 *authenticationService
	AzureDevOpsConnectivityCheck   *azureDevOpsConnectivityCheckService
	AzureEnvironments              *azureEnvironmentService
	BuildInformation               *buildInformationService
	CertificateConfiguration       *certificateConfigurationService
	Certificates                   *certificateService
	Channels                       *channelService
	CloudTemplate                  *cloudTemplateService
	CommunityActionTemplates       *communityActionTemplateService
	Configuration                  *configurationService
	DashboardConfigurations        *dashboardConfigurationService
	Dashboards                     *dashboardService
	DeploymentProcesses            *deploymentProcessService
	Deployments                    *deploymentService
	DynamicExtensions              *dynamicExtensionService
	Environments                   *environmentService
	Events                         *eventService
	ExternalSecurityGroupProviders *externalSecurityGroupProviderService
	FeaturesConfiguration          *featuresConfigurationService
	Feeds                          *feedService
	Interruptions                  *interruptionService
	Invitations                    *invitationService
	IssueTrackers                  *issueTrackerService
	JiraIntegration                *jiraIntegrationService
	LetsEncryptConfiguration       *letsEncryptConfigurationService
	LibraryVariableSets            *libraryVariableSetService
	Licenses                       *licenseService
	Lifecycles                     *lifecycleService
	MachinePolicies                *machinePolicyService
	MachineRoles                   *machineRoleService
	Machines                       *machineService
	MaintenanceConfiguration       *maintenanceConfigurationService
	Migrations                     *migrationService
	OctopusPackageMetadata         *octopusPackageMetadataService
	OctopusServerNodes             *octopusServerNodeService
	Packages                       *packageService
	PackageMetadata                *packageMetadataService
	PerformanceConfiguration       *performanceConfigurationService
	Permissions                    *permissionService
	ProjectGroups                  *projectGroupService
	Projects                       *projectService
	ProjectTriggers                *projectTriggerService
	Proxies                        *proxyService
	Releases                       *releaseService
	Reporting                      *reportingService
	RunbookProcesses               *runbookProcessService
	RunbookRuns                    *runbookRunService
	Runbooks                       *runbookService
	RunbookSnapshots               *runbookSnapshotService
	Root                           *rootService
	ScheduledProjectTriggers       *scheduledProjectTriggerService
	Scheduler                      *schedulerService
	ScopedUserRoles                *scopedUserRoleService
	ServerConfiguration            *serverConfigurationService
	ServerStatus                   *serverStatusService
	SMTPConfiguration              *smtpConfigurationService
	Spaces                         *spaceService
	Subscriptions                  *subscriptionService
	TagSets                        *tagSetService
	Tasks                          *taskService
	TeamMembership                 *teamMembershipService
	Teams                          *teamService
	Tenants                        *tenantService
	TenantVariables                *tenantVariableService
	UpgradeConfiguration           *upgradeConfigurationService
	UserOnboarding                 *userOnboardingService
	UserRoles                      *userRoleService
	Users                          *userService
	Variables                      *variableService
	WorkerPools                    *workerPoolService
	Workers                        *workerService
	WorkerToolsLatestImages        *workerToolsLatestImageService
	// contains filtered or unexported fields
}

Client is an OctopusDeploy for making Octopus API requests.

func GetFakeOctopusClient ¶ added in v1.7.0 

func GetFakeOctopusClient(t *testing.T, apiPath string, statusCode int, responseBody string) (*Client, error)

GetFakeOctopusClient -

func NewClient ¶ 

func NewClient(httpClient *http.Client, apiURL *url.URL, apiKey string, spaceID string) (*Client, error)

NewClient returns a new Octopus API client. If a nil client is provided, a new http.Client will be used.

type CloudRegionEndpoint ¶ added in v1.7.0 

type CloudRegionEndpoint struct {
	DefaultWorkerPoolID string `json:"DefaultWorkerPoolId"`
	// contains filtered or unexported fields
}

CloudRegionEndpoint represents a cloud service endpoint.

func NewCloudRegionEndpoint ¶ added in v1.7.0 

func NewCloudRegionEndpoint() *CloudRegionEndpoint

NewCloudRegionEndpoint creates and initializes a new cloud service endpoint.

func (CloudRegionEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (e CloudRegionEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (CloudRegionEndpoint) GetDefaultWorkerPoolID ¶ added in v1.7.0 

func (e CloudRegionEndpoint) GetDefaultWorkerPoolID() string

GetDefaultWorkerPoolID returns the default worker pool ID of this endpoint.

func (CloudRegionEndpoint) SetDefaultWorkerPoolID ¶ added in v1.7.0 

func (e CloudRegionEndpoint) SetDefaultWorkerPoolID(defaultWorkerPoolID string)

SetDefaultWorkerPoolID sets the default worker pool ID of this endpoint.

func (CloudRegionEndpoint) Validate ¶ added in v1.7.0 

func (e CloudRegionEndpoint) Validate() error

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

type CloudServiceEndpoint ¶ added in v1.7.0 

type CloudServiceEndpoint struct {
	CloudServiceName        string `json:"CloudServiceName,omitempty"`
	Slot                    string `json:"Slot,omitempty"`
	StorageAccountName      string `json:"StorageAccountName,omitempty"`
	SwapIfPossible          bool   `json:"SwapIfPossible"`
	UseCurrentInstanceCount bool   `json:"UseCurrentInstanceCount"`
	// contains filtered or unexported fields
}

func NewCloudServiceEndpoint ¶ added in v1.7.0 

func NewCloudServiceEndpoint() *CloudServiceEndpoint

func (CloudServiceEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (e CloudServiceEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (CloudServiceEndpoint) Validate ¶ added in v1.7.0 

func (e CloudServiceEndpoint) Validate() error

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

type CloudTemplateQuery ¶ added in v1.7.0 

type CloudTemplateQuery struct {
	FeedID    string `uri:"feedId,omitempty" url:"feedId,omitempty"`
	PackageID string `uri:"packageId,omitempty" url:"packageId,omitempty"`
}

type CommitDetails ¶ added in v1.7.0 

type CommitDetails struct {
	Comment string `json:"Comment,omitempty"`
	ID      string `json:"Id,omitempty"`
	LinkURL string `json:"LinkUrl,omitempty"`
}

func NewCommitDetails ¶ added in v1.7.0 

func NewCommitDetails() *CommitDetails

type CommunityActionTemplate ¶ added in v1.7.0 

type CommunityActionTemplate struct {
	ActionType  string                    `json:"ActionType" validate:"required,notblank"`
	Author      string                    `json:"Author,omitempty"`
	Category    string                    `json:"Category,omitempty"`
	Description string                    `json:"Description,omitempty"`
	ExternalId  *uuid.UUID                `json:"ExternalId,omitempty"`
	HistoryURL  string                    `json:"HistoryUrl,omitempty"`
	Name        string                    `json:"Name" validate:"required"`
	Packages    []PackageReference        `json:"Packages,omitempty"`
	Parameters  []ActionTemplateParameter `json:"Parameters"`
	Properties  map[string]PropertyValue  `json:"Properties,omitempty"`
	Type        string                    `json:"Type,omitempty"`
	Version     int32                     `json:"Version,omitempty"`
	Website     string                    `json:"Website,omitempty"`
	// contains filtered or unexported fields
}

CommunityActionTemplate represents a community action template in Octopus Deploy.

func NewCommunityActionTemplate ¶ added in v1.7.0 

func NewCommunityActionTemplate(name string, actionType string) *CommunityActionTemplate

NewCommunityActionTemplate initializes a community action template.

func (*CommunityActionTemplate) GetID ¶ added in v1.7.0 

func (r *CommunityActionTemplate) GetID() string

GetID returns the ID value of the resource. 

func (r *CommunityActionTemplate) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*CommunityActionTemplate) GetModifiedBy ¶ added in v1.7.0 

func (r *CommunityActionTemplate) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*CommunityActionTemplate) GetModifiedOn ¶ added in v1.7.0 

func (r *CommunityActionTemplate) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*CommunityActionTemplate) Validate ¶ added in v1.7.0 

func (c *CommunityActionTemplate) Validate() error

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

type CommunityActionTemplates ¶ added in v1.7.0 

type CommunityActionTemplates struct {
	Items []*CommunityActionTemplate `json:"Items"`
	PagedResults
}

CommunityActionTemplates defines a collection of community action templates with built-in support for paged results.

type CommunityActionTemplatesQuery ¶ added in v1.7.0 

type CommunityActionTemplatesQuery struct {
	IDs  []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Skip int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int      `uri:"take,omitempty" url:"take,omitempty"`
}

type ConfigurationSection ¶ added in v1.7.0 

type ConfigurationSection struct {
	Description string `json:"Description,omitempty"`
	Name        string `json:"Name,omitempty"`
	// contains filtered or unexported fields
}

func NewConfigurationSection ¶ added in v1.7.0 

func NewConfigurationSection() *ConfigurationSection

func (*ConfigurationSection) GetID ¶ added in v1.7.0 

func (r *ConfigurationSection) GetID() string

GetID returns the ID value of the resource. 

func (r *ConfigurationSection) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ConfigurationSection) GetModifiedBy ¶ added in v1.7.0 

func (r *ConfigurationSection) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ConfigurationSection) GetModifiedOn ¶ added in v1.7.0 

func (r *ConfigurationSection) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ConfigurationSection) Validate ¶ added in v1.7.0 

func (r *ConfigurationSection) Validate() error

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

type ConfigurationSections ¶ added in v1.7.0 

type ConfigurationSections struct {
	Items []*ConfigurationSection `json:"Items"`
	PagedResults
}

type ConnectivityCheck ¶ added in v1.7.0 

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

func NewConnectivityCheck ¶ added in v1.7.0 

func NewConnectivityCheck() *ConnectivityCheck

type ConnectivityPolicy ¶ added in v1.7.0 

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

type Control ¶ added in v1.7.0 

type Control interface{}

type DashboardDynamicQuery ¶ added in v1.7.0 

type DashboardDynamicQuery struct {
	Environments    []string `uri:"environments,omitempty" url:"environments,omitempty"`
	IncludePrevious bool     `uri:"includePrevious,omitempty" url:"includePrevious,omitempty"`
	Projects        []string `uri:"projects,omitempty" url:"projects,omitempty"`
}

type DashboardItem ¶ added in v1.7.0 

type DashboardItem struct {
	ChannelID               string     `json:"ChannelId,omitempty"`
	CompletedTime           *time.Time `json:"CompletedTime,omitempty"`
	Created                 *time.Time `json:"Created,omitempty"`
	DeploymentID            string     `json:"DeploymentId,omitempty"`
	Duration                string     `json:"Duration,omitempty"`
	EnvironmentID           string     `json:"EnvironmentId,omitempty"`
	ErrorMessage            string     `json:"ErrorMessage,omitempty"`
	HasPendingInterruptions bool       `json:"HasPendingInterruptions,omitempty"`
	HasWarningsOrErrors     bool       `json:"HasWarningsOrErrors,omitempty"`
	IsCompleted             bool       `json:"IsCompleted,omitempty"`
	IsCurrent               bool       `json:"IsCurrent,omitempty"`
	IsPrevious              bool       `json:"IsPrevious,omitempty"`
	ProjectID               string     `json:"ProjectId,omitempty"`
	QueueTime               *time.Time `json:"QueueTime,omitempty"`
	ReleaseID               string     `json:"ReleaseId,omitempty"`
	ReleaseVersion          string     `json:"ReleaseVersion,omitempty"`
	StartTime               *time.Time `json:"StartTime,omitempty"`

	// Enum: [Canceled Cancelling Executing Failed Queued Success TimedOut]
	State    string `json:"State,omitempty"`
	TaskID   string `json:"TaskId,omitempty"`
	TenantID string `json:"TenantId,omitempty"`
}

type DashboardQuery ¶ added in v1.7.0 

type DashboardQuery struct {
	IncludeLatest   bool     `url:"highestLatestVersionPerProjectAndEnvironment"`
	ProjectID       string   `uri:"projectId,omitempty" url:"projectId,omitempty"`
	SelectedTags    []string `uri:"selectedTags,omitempty" url:"selectedTags,omitempty"`
	SelectedTenants []string `uri:"selectedTenants,omitempty" url:"selectedTenants,omitempty"`
	ShowAll         bool     `uri:"showAll,omitempty" url:"showAll,omitempty"`
	ReleaseID       string   `uri:"releaseId,omitempty" url:"releaseId,omitempty"`
}

type Deployment ¶ added in v1.7.0 

type Deployment struct {
	Changes                  []*ReleaseChanges `json:"Changes"`
	ChangesMarkdown          string            `json:"ChangesMarkdown,omitempty"`
	ChannelID                string            `json:"ChannelId,omitempty"`
	Comments                 string            `json:"Comments,omitempty"`
	Created                  *time.Time        `json:"Created,omitempty"`
	DeployedBy               string            `json:"DeployedBy,omitempty"`
	DeployedByID             string            `json:"DeployedById,omitempty"`
	DeployedToMachineIDs     []string          `json:"DeployedToMachineIds"`
	DeploymentProcessID      string            `json:"DeploymentProcessId,omitempty"`
	EnvironmentID            string            `json:"EnvironmentId" validate:"required"`
	ExcludedMachineIDs       []string          `json:"ExcludedMachineIds"`
	FailureEncountered       bool              `json:"FailureEncountered,omitempty"`
	ForcePackageDownload     bool              `json:"ForcePackageDownload,omitempty"`
	ForcePackageRedeployment bool              `json:"ForcePackageRedeployment,omitempty"`
	FormValues               map[string]string `json:"FormValues,omitempty"`
	ManifestVariableSetID    string            `json:"ManifestVariableSetId,omitempty"`
	Name                     string            `json:"Name,omitempty"`
	ProjectID                string            `json:"ProjectId,omitempty"`
	QueueTime                *time.Time        `json:"QueueTime,omitempty"`
	QueueTimeExpiry          *time.Time        `json:"QueueTimeExpiry,omitempty"`
	ReleaseID                string            `json:"ReleaseId" validate:"required"`
	SkipActions              []string          `json:"SkipActions"`
	SpaceID                  string            `json:"SpaceId,omitempty"`
	SpecificMachineIDs       []string          `json:"SpecificMachineIds"`
	TaskID                   string            `json:"TaskId,omitempty"`
	TenantID                 string            `json:"TenantId,omitempty"`
	TentacleRetentionPeriod  *RetentionPeriod  `json:"TentacleRetentionPeriod,omitempty"`
	UseGuidedFailure         bool              `json:"UseGuidedFailure,omitempty"`
	// contains filtered or unexported fields
}

func NewDeployment ¶ added in v1.7.0 

func NewDeployment(environmentID string, releaseID string) *Deployment

NewDeployment initializes a deployment with a name, environment ID, and release ID.

func (*Deployment) GetID ¶ added in v1.7.0 

func (r *Deployment) GetID() string

GetID returns the ID value of the resource. 

func (r *Deployment) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Deployment) GetModifiedBy ¶ added in v1.7.0 

func (r *Deployment) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Deployment) GetModifiedOn ¶ added in v1.7.0 

func (r *Deployment) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Deployment) Validate ¶ added in v1.7.0 

func (d *Deployment) Validate() error

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

type DeploymentAction ¶ 

type DeploymentAction struct {
	ActionType                    string                    `json:"ActionType" validate:"required,notblank"`
	CanBeUsedForProjectVersioning bool                      `json:"CanBeUsedForProjectVersioning"`
	Channels                      []string                  `json:"Channels,omitempty"`
	Condition                     string                    `json:"Condition,omitempty"`
	Container                     DeploymentActionContainer `json:"Container"`
	Environments                  []string                  `json:"Environments,omitempty"`
	ExcludedEnvironments          []string                  `json:"ExcludedEnvironments,omitempty"`
	IsDisabled                    bool                      `json:"IsDisabled"`
	IsRequired                    bool                      `json:"IsRequired"`
	Name                          string                    `json:"Name" validate:"required,notblank"`
	Notes                         string                    `json:"Notes,omitempty"`
	Packages                      []PackageReference        `json:"Packages,omitempty"`
	Properties                    map[string]PropertyValue  `json:"Properties,omitempty"`
	TenantTags                    []string                  `json:"TenantTags,omitempty"`
	WorkerPoolID                  string                    `json:"WorkerPoolId,omitempty"`
	WorkerPoolVariable            string                    `json:"WorkerPoolVariable,omitempty"`
	// contains filtered or unexported fields
}

func NewDeploymentAction ¶ added in v1.7.0 

func NewDeploymentAction(name string, actionType string) *DeploymentAction

NewDeploymentAction initializes a DeploymentAction with a name.

func (*DeploymentAction) GetID ¶ added in v1.7.15 

func (r *DeploymentAction) GetID() string

GetID returns the ID value of the resource. 

func (r *DeploymentAction) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*DeploymentAction) GetModifiedBy ¶ added in v1.7.15 

func (r *DeploymentAction) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*DeploymentAction) GetModifiedOn ¶ added in v1.7.15 

func (r *DeploymentAction) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (DeploymentAction) Validate ¶ added in v1.7.15 

func (d DeploymentAction) Validate() error

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

type DeploymentActionContainer ¶ added in v1.7.0 

type DeploymentActionContainer struct {
	FeedID string `json:"FeedId,omitempty"`
	Image  string `json:"Image,omitempty"`
}

type DeploymentActionPackage ¶ added in v1.7.0 

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

type DeploymentProcess ¶ 

type DeploymentProcess struct {
	LastSnapshotID string           `json:"LastSnapshotId,omitempty"`
	ProjectID      string           `json:"ProjectId,omitempty"`
	SpaceID        string           `json:"SpaceId,omitempty"`
	Steps          []DeploymentStep `json:"Steps,omitempty"`
	Version        int32            `json:"Version"`
	// contains filtered or unexported fields
}

func NewDeploymentProcess ¶ added in v1.7.0 

func NewDeploymentProcess(projectID string) *DeploymentProcess

NewDeploymentProcess initializes a deployment process.

func (*DeploymentProcess) GetID ¶ added in v1.7.0 

func (r *DeploymentProcess) GetID() string

GetID returns the ID value of the resource. 

func (r *DeploymentProcess) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*DeploymentProcess) GetModifiedBy ¶ added in v1.7.0 

func (r *DeploymentProcess) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*DeploymentProcess) GetModifiedOn ¶ added in v1.7.0 

func (r *DeploymentProcess) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*DeploymentProcess) Validate ¶ 

func (r *DeploymentProcess) Validate() error

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

type DeploymentProcesses ¶ 

type DeploymentProcesses struct {
	Items []*DeploymentProcess `json:"Items"`
	PagedResults
}

type DeploymentProcessesQuery ¶ added in v1.7.0 

type DeploymentProcessesQuery struct {
	IDs  []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Skip int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int      `uri:"take,omitempty" url:"take,omitempty"`
}

type DeploymentQuery ¶ added in v1.7.0 

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

type DeploymentStep ¶ 

type DeploymentStep struct {
	Actions            []DeploymentAction               `json:"Actions,omitempty"`
	Condition          DeploymentStepConditionType      `json:"Condition,omitempty"` // variable option adds a Property "Octopus.Action.ConditionVariableExpression"
	Name               string                           `json:"Name"`
	PackageRequirement DeploymentStepPackageRequirement `json:"PackageRequirement,omitempty"`
	Properties         map[string]PropertyValue         `json:"Properties,omitempty"`
	StartTrigger       DeploymentStepStartTrigger       `json:"StartTrigger,omitempty" validate:"required,oneof=StartAfterPrevious StartWithPrevious"`
	// contains filtered or unexported fields
}

func NewDeploymentStep ¶ added in v1.7.0 

func NewDeploymentStep(name string) *DeploymentStep

NewDeploymentStep initializes a DeploymentStep with a name.

func (*DeploymentStep) GetID ¶ added in v1.7.0 

func (r *DeploymentStep) GetID() string

GetID returns the ID value of the resource. 

func (r *DeploymentStep) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*DeploymentStep) GetModifiedBy ¶ added in v1.7.0 

func (r *DeploymentStep) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*DeploymentStep) GetModifiedOn ¶ added in v1.7.0 

func (r *DeploymentStep) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (DeploymentStep) Validate ¶ added in v1.7.0 

func (d DeploymentStep) Validate() error

Validate checks the state of the deployment step and returns an error if invalid.

type DeploymentStepConditionType ¶ added in v1.7.0 

type DeploymentStepConditionType string
const (
	DeploymentStepConditionTypeSuccess  DeploymentStepConditionType = "Success"
	DeploymentStepConditionTypeFailure  DeploymentStepConditionType = "Failure"
	DeploymentStepConditionTypeAlways   DeploymentStepConditionType = "Always"
	DeploymentStepConditionTypeVariable DeploymentStepConditionType = "Variable"
)

type DeploymentStepPackageRequirement ¶ 

type DeploymentStepPackageRequirement string
const (
	DeploymentStepPackageRequirementLetOctopusDecide         DeploymentStepPackageRequirement = "LetOctopusDecide"
	DeploymentStepPackageRequirementBeforePackageAcquisition DeploymentStepPackageRequirement = "BeforePackageAcquisition"
	DeploymentStepPackageRequirementAfterPackageAcquisition  DeploymentStepPackageRequirement = "AfterPackageAcquisition"
)

type DeploymentStepStartTrigger ¶ 

type DeploymentStepStartTrigger string
const (
	DeploymentStepStartTriggerStartAfterPrevious DeploymentStepStartTrigger = "StartAfterPrevious"
	DeploymentStepStartTriggerStartWithPrevious  DeploymentStepStartTrigger = "StartWithPrevious"
)

type DeploymentTarget ¶ added in v1.7.0 

type DeploymentTarget struct {
	EnvironmentIDs         []string               `json:"EnvironmentIds"`
	Roles                  []string               `json:"Roles"`
	SpaceID                string                 `json:"SpaceId,omitempty"`
	TenantedDeploymentMode TenantedDeploymentMode `json:"TenantedDeploymentParticipation,omitempty"`
	TenantIDs              []string               `json:"TenantIds"`
	TenantTags             []string               `json:"TenantTags"`
	// contains filtered or unexported fields
}

func NewDeploymentTarget ¶ added in v1.7.0 

func NewDeploymentTarget(name string, endpoint IEndpoint, environmentIDs []string, roles []string) *DeploymentTarget

func (*DeploymentTarget) MarshalJSON ¶ added in v1.7.0 

func (d *DeploymentTarget) MarshalJSON() ([]byte, error)

MarshalJSON returns a deployment target as its JSON encoding.

func (*DeploymentTarget) UnmarshalJSON ¶ added in v1.7.0 

func (resource *DeploymentTarget) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this deployment target to its representation in JSON.

func (*DeploymentTarget) Validate ¶ added in v1.7.0 

func (d *DeploymentTarget) Validate() error

Validate checks the state of the deployment target and returns an error if invalid.

type DeploymentTargets ¶ added in v1.7.0 

type DeploymentTargets struct {
	Items []*DeploymentTarget `json:"Items"`
	PagedResults
}

DeploymentTargets defines a collection of deployment targets with built-in support for paged results from the API.

type Deployments ¶ added in v1.7.0 

type Deployments struct {
	Items []*Deployment `json:"Items"`
	PagedResults
}

Deployments defines a collection of deployment instances with built-in support for paged results.

type DeploymentsQuery ¶ added in v1.7.0 

type DeploymentsQuery struct {
	Channels     string   `uri:"channels,omitempty" url:"channels,omitempty"`
	Environments []string `uri:"environments,omitempty" url:"environments,omitempty"`
	IDs          []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName  string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Projects     []string `uri:"projects,omitempty" url:"projects,omitempty"`
	Skip         int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take         int      `uri:"take,omitempty" url:"take,omitempty"`
	TaskState    string   `uri:"taskState,omitempty" url:"taskState,omitempty"`
	Tenants      []string `uri:"tenants,omitempty" url:"tenants,omitempty"`
}

type DiscoverMachineQuery ¶ added in v1.7.0 

type DiscoverMachineQuery struct {
	Host    string `uri:"host,omitempty" url:"host,omitempty"`
	Port    int    `uri:"port,omitempty" url:"port,omitempty"`
	ProxyID string `uri:"proxyId,omitempty" url:"proxyId,omitempty"`
	Type    string `uri:"type,omitempty" url:"type,omitempty"`
}

type DiscoverWorkerQuery ¶ added in v1.7.0 

type DiscoverWorkerQuery struct {
	Host    string `uri:"host,omitempty" url:"host,omitempty"`
	Port    int    `uri:"port,omitempty" url:"port,omitempty"`
	ProxyID string `uri:"proxyId,omitempty" url:"proxyId,omitempty"`
	Type    string `uri:"type,omitempty" url:"type,omitempty"`
}

type DisplayInfo ¶ added in v1.7.0 

type DisplayInfo struct {
	ConnectivityCheck     *ConnectivityCheck     `json:"ConnectivityCheck,omitempty"`
	Description           string                 `json:"Description,omitempty"`
	Label                 string                 `json:"Label,omitempty"`
	ListAPI               *ListAPIMetadata       `json:"ListApi,omitempty"`
	Options               *OptionsMetadata       `json:"Options,omitempty"`
	PropertyApplicability *PropertyApplicability `json:"PropertyApplicability,omitempty"`
	ReadOnly              bool                   `json:"ReadOnly,omitempty"`
	Required              bool                   `json:"Required,omitempty"`
	ShowCopyToClipboard   bool                   `json:"ShowCopyToClipboard,omitempty"`
}

func NewDisplayInfo ¶ added in v1.7.0 

func NewDisplayInfo() *DisplayInfo

type DockerContainerRegistry ¶ added in v1.7.0 

type DockerContainerRegistry struct {
	APIVersion   string `json:"ApiVersion,omitempty"`
	FeedURI      string `json:"FeedUri,omitempty"`
	RegistryPath string `json:"RegistryPath,omitempty"`

	Feed
}

DockerContainerRegistry represents a Docker container registry.

func NewDockerContainerRegistry ¶ added in v1.7.0 

func NewDockerContainerRegistry(name string) *DockerContainerRegistry

NewDockerContainerRegistry creates and initializes a Docker container registry.

func (*DockerContainerRegistry) GetID ¶ added in v1.7.0 

func (r *DockerContainerRegistry) GetID() string

GetID returns the ID value of the resource. 

func (r *DockerContainerRegistry) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*DockerContainerRegistry) GetModifiedBy ¶ added in v1.7.0 

func (r *DockerContainerRegistry) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*DockerContainerRegistry) GetModifiedOn ¶ added in v1.7.0 

func (r *DockerContainerRegistry) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*DockerContainerRegistry) Validate ¶ added in v1.7.0 

func (d *DockerContainerRegistry) Validate() error

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

type DynamicWorkerPool ¶ added in v1.7.0 

type DynamicWorkerPool struct {
	WorkerPoolType WorkerPoolType `json:"WorkerPoolType"`
	WorkerType     WorkerType     `json:"WorkerType"`

	WorkerPool
}

func NewDynamicWorkerPool ¶ added in v1.7.0 

func NewDynamicWorkerPool(name string, workerType WorkerType) (*DynamicWorkerPool, error)

NewDynamicWorkerPool creates and initializes a dynamic worker pool.

func (*DynamicWorkerPool) GetID ¶ added in v1.7.0 

func (r *DynamicWorkerPool) GetID() string

GetID returns the ID value of the resource.

func (*DynamicWorkerPool) GetIsDefault ¶ added in v1.7.0 

func (d *DynamicWorkerPool) GetIsDefault() bool
func (r *DynamicWorkerPool) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*DynamicWorkerPool) GetModifiedBy ¶ added in v1.7.0 

func (r *DynamicWorkerPool) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*DynamicWorkerPool) GetModifiedOn ¶ added in v1.7.0 

func (r *DynamicWorkerPool) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*DynamicWorkerPool) GetWorkerPoolType ¶ added in v1.7.0 

func (d *DynamicWorkerPool) GetWorkerPoolType() WorkerPoolType

GetWorkerPoolType returns the worker pool type for this worker pool.

func (*DynamicWorkerPool) GetWorkerType ¶ added in v1.7.0 

func (d *DynamicWorkerPool) GetWorkerType() WorkerType

GetWorkerType returns the worker type for this worker pool.

func (*DynamicWorkerPool) Validate ¶ added in v1.7.0 

func (d *DynamicWorkerPool) Validate() error

Validate checks the state of the dynamic worker pool and returns an error if invalid.

type DynamicWorkerPools ¶ added in v1.7.0 

type DynamicWorkerPools struct {
	Items []*DynamicWorkerPool `json:"Items"`
	PagedResults
}

type EndpointResource ¶ added in v1.7.0 

type EndpointResource struct {
	AadClientCredentialSecret            string                         `json:"AadClientCredentialSecret,omitempty"`
	AadCredentialType                    string                         `json:"AadCredentialType,omitempty" validate:"omitempty,oneof=ClientCredential UserCredential"`
	AadUserCredentialUsername            string                         `json:"AadUserCredentialUsername,omitempty"`
	AadUserCredentialPassword            SensitiveValue                 `json:"AadUserCredentialPassword,omitempty"`
	AccountID                            string                         `json:"AccountId"`
	ApplicationsDirectory                string                         `json:"ApplicationsDirectory,omitempty"`
	Authentication                       IKubernetesAuthentication      `json:"Authentication,omitempty"`
	CertificateSignatureAlgorithm        string                         `json:"CertificateSignatureAlgorithm,omitempty"`
	CertificateStoreLocation             string                         `json:"CertificateStoreLocation,omitempty"`
	CertificateStoreName                 string                         `json:"CertificateStoreName,omitempty"`
	ClientCertificateVariable            string                         `json:"ClientCertVariable,omitempty"`
	CloudServiceName                     string                         `json:"CloudServiceName"`
	ClusterCertificate                   string                         `json:"ClusterCertificate,omitempty"`
	ClusterURL                           *url.URL                       `json:"ClusterUrl" validate:"required,url"`
	CommunicationStyle                   string                         `` /* 162-byte string literal not displayed */
	ConnectionEndpoint                   string                         `json:"ConnectionEndpoint,omitempty"`
	Container                            DeploymentActionContainer      `json:"Container,omitempty"`
	DefaultWorkerPoolID                  string                         `json:"DefaultWorkerPoolId"`
	Destination                          *OfflinePackageDropDestination `json:"Destination"`
	DotNetCorePlatform                   string                         `json:"DotNetCorePlatform,omitempty"`
	Fingerprint                          string                         `json:"Fingerprint,omitempty"`
	Host                                 string                         `json:"Host,omitempty"`
	Namespace                            string                         `json:"Namespace,omitempty"`
	Port                                 int                            `json:"Port,omitempty"`
	ProxyID                              string                         `json:"ProxyId,omitempty"`
	ResourceGroupName                    string                         `json:"ResourceGroupName,omitempty"`
	RunningInContainer                   bool                           `json:"RunningInContainer"`
	SecurityMode                         string                         `json:"SecurityMode,omitempty" validate:"omitempty,oneof=Unsecure SecureClientCertificate SecureAzureAD"`
	SensitiveVariablesEncryptionPassword SensitiveValue                 `json:"SensitiveVariablesEncryptionPassword"`
	ServerCertificateThumbprint          string                         `json:"ServerCertThumbprint,omitempty"`
	SkipTLSVerification                  bool                           `json:"SkipTlsVerification"`
	Slot                                 string                         `json:"Slot"`
	StorageAccountName                   string                         `json:"StorageAccountName"`
	SwapIfPossible                       bool                           `json:"SwapIfPossible"`
	TentacleVersionDetails               *TentacleVersionDetails        `json:"TentacleVersionDetails,omitempty"`
	Thumbprint                           string                         `json:"Thumbprint" validate:"required"`
	WorkingDirectory                     string                         `json:"OctopusWorkingDirectory,omitempty"`
	UseCurrentInstanceCount              bool                           `json:"UseCurrentInstanceCount"`
	URI                                  *url.URL                       `json:"Uri" validate:"required,uri"`
	WebAppName                           string                         `json:"WebAppName,omitempty"`
	WebAppSlotName                       string                         `json:"WebAppSlotName"`
	// contains filtered or unexported fields
}

func NewEndpointResource ¶ added in v1.7.0 

func NewEndpointResource(communicationStyle string) *EndpointResource

NewEndpoint creates and initializes an account resource with a name and type.

func ToEndpointResource ¶ added in v1.7.0 

func ToEndpointResource(endpoint IEndpoint) (*EndpointResource, error)

func (*EndpointResource) GetCommunicationStyle ¶ added in v1.7.0 

func (e *EndpointResource) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (*EndpointResource) GetID ¶ added in v1.7.0 

func (r *EndpointResource) GetID() string

GetID returns the ID value of the resource. 

func (r *EndpointResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*EndpointResource) GetModifiedBy ¶ added in v1.7.0 

func (r *EndpointResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*EndpointResource) GetModifiedOn ¶ added in v1.7.0 

func (r *EndpointResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (EndpointResource) Validate ¶ added in v1.7.0 

func (e EndpointResource) Validate() error

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

type EndpointResources ¶ added in v1.7.0 

type EndpointResources struct {
	Items []*EndpointResource `json:"Items"`
	PagedResults
}

type Environment ¶ 

type Environment struct {
	AllowDynamicInfrastructure bool   `json:"AllowDynamicInfrastructure"`
	Description                string `json:"Description,omitempty"`
	Name                       string `json:"Name" validate:"required"`
	SortOrder                  int    `json:"SortOrder"`
	UseGuidedFailure           bool   `json:"UseGuidedFailure"`
	// contains filtered or unexported fields
}

func NewEnvironment ¶ 

func NewEnvironment(name string) *Environment

func (*Environment) GetID ¶ added in v1.7.0 

func (r *Environment) GetID() string

GetID returns the ID value of the resource. 

func (r *Environment) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Environment) GetModifiedBy ¶ added in v1.7.0 

func (r *Environment) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Environment) GetModifiedOn ¶ added in v1.7.0 

func (r *Environment) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Environment) Validate ¶ 

func (e *Environment) Validate() error

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

type Environments ¶ 

type Environments struct {
	Items []*Environment `json:"Items"`
	PagedResults
}

type EnvironmentsQuery ¶ added in v1.7.0 

type EnvironmentsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Name        string   `uri:"name,omitempty" url:"name,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 EnvironmentsSummaryQuery ¶ added in v1.7.0 

type EnvironmentsSummaryQuery struct {
	CommunicationStyles   []string `uri:"commStyles,omitempty" url:"commStyles,omitempty"`
	HealthStatuses        []string `uri:"healthStatuses,omitempty" url:"healthStatuses,omitempty"`
	HideEmptyEnvironments bool     `uri:"hideEmptyEnvironments,omitempty" url:"hideEmptyEnvironments,omitempty"`
	IDs                   []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsDisabled            bool     `uri:"isDisabled,omitempty" url:"isDisabled,omitempty"`
	MachinePartialName    string   `uri:"machinePartialName,omitempty" url:"machinePartialName,omitempty"`
	PartialName           string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Roles                 []string `uri:"roles,omitempty" url:"roles,omitempty"`
	ShellNames            []string `uri:"shellNames,omitempty" url:"shellNames,omitempty"`
	TenantIDs             []string `uri:"tenantIds,omitempty" url:"tenantIds,omitempty"`
	TenantTags            []string `uri:"tenantTags,omitempty" url:"tenantTags,omitempty"`
}

type EventCategoriesQuery ¶ added in v1.7.0 

type EventCategoriesQuery struct {
	AppliesTo string `uri:"appliesTo" url:"appliesTo,omitempty"`
}

type EventGroupsQuery ¶ added in v1.7.0 

type EventGroupsQuery struct {
	AppliesTo string `uri:"appliesTo" url:"appliesTo,omitempty"`
}

type EventsQuery ¶ added in v1.7.0 

type EventsQuery struct {
	AsCSV             string   `uri:"asCsv,omitempty" url:"asCsv,omitempty"`
	DocumentTypes     []string `uri:"documentTypes,omitempty" url:"documentTypes,omitempty"`
	Environments      []string `uri:"environments,omitempty" url:"environments,omitempty"`
	EventAgents       []string `uri:"eventAgents,omitempty" url:"eventAgents,omitempty"`
	EventCategories   []string `uri:"eventCategories,omitempty" url:"eventCategories,omitempty"`
	EventGroups       []string `uri:"eventGroups,omitempty" url:"eventGroups,omitempty"`
	ExcludeDifference bool     `uri:"excludeDifference,omitempty" url:"excludeDifference,omitempty"`
	From              string   `uri:"from,omitempty" url:"from,omitempty"`
	FromAutoID        string   `uri:"fromAutoId,omitempty" url:"fromAutoId,omitempty"`
	IDs               []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IncludeSystem     bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	Internal          string   `uri:"interal,omitempty" url:"interal,omitempty"`
	Name              string   `uri:"name,omitempty" url:"name,omitempty"`
	PartialName       string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	ProjectGroups     []string `uri:"projectGroups,omitempty" url:"projectGroups,omitempty"`
	Projects          []string `uri:"projects,omitempty" url:"projects,omitempty"`
	Regarding         string   `uri:"regarding,omitempty" url:"regarding,omitempty"`
	RegardingAny      string   `uri:"regardingAny,omitempty" url:"regardingAny,omitempty"`
	Skip              int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Spaces            []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	Take              int      `uri:"take,omitempty" url:"take,omitempty"`
	Tags              []string `uri:"tags,omitempty" url:"tags,omitempty"`
	Tenants           []string `uri:"tenants,omitempty" url:"tenants,omitempty"`
	To                string   `uri:"to,omitempty" url:"to,omitempty"`
	ToAutoID          string   `uri:"toAutoId,omitempty" url:"toAutoId,omitempty"`
	User              string   `uri:"user,omitempty" url:"user,omitempty"`
	Users             []string `uri:"users,omitempty" url:"users,omitempty"`
}

type ExtensionSettingsValues ¶ added in v1.7.0 

type ExtensionSettingsValues struct {
	ExtensionID string      `json:"ExtensionId,omitempty"`
	Values      interface{} `json:"Values,omitempty"`
}

type ExternalUserSearchQuery ¶ added in v1.7.0 

type ExternalUserSearchQuery struct {
	PartialName string `uri:"partialName,omitempty" url:"partialName,omitempty"`
}

type Feed ¶ 

type Feed struct {
	Name                              string          `json:"Name" validate:"required,notblank"`
	FeedType                          FeedType        `json:"FeedType"`
	SpaceID                           string          `json:"SpaceId,omitempty"`
	PackageAcquisitionLocationOptions []string        `json:"PackageAcquisitionLocationOptions,omitempty"`
	Password                          *SensitiveValue `json:"Password,omitempty"`
	Username                          string          `json:"Username,omitempty"`
	// contains filtered or unexported fields
}

Feed is the embedded struct used for all feeds.

func (*Feed) GetFeedType ¶ added in v1.7.0 

func (f *Feed) GetFeedType() FeedType

GetFeedType returns the type of this feed.

func (*Feed) GetID ¶ added in v1.7.0 

func (r *Feed) GetID() string

GetID returns the ID value of the resource. 

func (r *Feed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Feed) GetModifiedBy ¶ added in v1.7.0 

func (r *Feed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Feed) GetModifiedOn ¶ added in v1.7.0 

func (r *Feed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Feed) GetName ¶ added in v1.7.0 

func (f *Feed) GetName() string

GetName returns the name of the feed.

func (*Feed) SetName ¶ added in v1.7.0 

func (f *Feed) SetName(name string)

SetName sets the name of the feed.

func (Feed) Validate ¶ 

func (f Feed) Validate() error

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

type FeedResource ¶ added in v1.7.0 

type FeedResource struct {
	AccessKey                         string          `json:"AccessKey,omitempty"`
	APIVersion                        string          `json:"ApiVersion,omitempty"`
	DeleteUnreleasedPackagesAfterDays *int            `json:"DeleteUnreleasedPackagesAfterDays,omitempty"`
	DownloadAttempts                  int             `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds       int             `json:"DownloadRetryBackoffSeconds"`
	EnhancedMode                      bool            `json:"EnhancedMode"`
	FeedType                          FeedType        `json:"FeedType,omitempty"`
	FeedURI                           string          `json:"FeedUri,omitempty"`
	IsBuiltInRepoSyncEnabled          bool            `json:"IsBuiltInRepoSyncEnabled,omitempty"`
	Name                              string          `json:"Name"`
	Password                          *SensitiveValue `json:"Password,omitempty"`
	PackageAcquisitionLocationOptions []string        `json:"PackageAcquisitionLocationOptions,omitempty"`
	Region                            string          `json:"Region,omitempty"`
	RegistryPath                      string          `json:"RegistryPath,omitempty"`
	SecretKey                         *SensitiveValue `json:"SecretKey,omitempty"`
	SpaceID                           string          `json:"SpaceId,omitempty"`
	Username                          string          `json:"Username,omitempty"`
	// contains filtered or unexported fields
}

func NewFeedResource ¶ added in v1.7.0 

func NewFeedResource(name string, feedType FeedType) *FeedResource

func ToFeedResource ¶ added in v1.7.0 

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

func (*FeedResource) GetFeedType ¶ added in v1.7.0 

func (f *FeedResource) GetFeedType() FeedType

func (*FeedResource) GetID ¶ added in v1.7.0 

func (r *FeedResource) GetID() string

GetID returns the ID value of the resource. 

func (r *FeedResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*FeedResource) GetModifiedBy ¶ added in v1.7.0 

func (r *FeedResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*FeedResource) GetModifiedOn ¶ added in v1.7.0 

func (r *FeedResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*FeedResource) GetName ¶ added in v1.7.0 

func (f *FeedResource) GetName() string

func (*FeedResource) SetName ¶ added in v1.7.0 

func (f *FeedResource) SetName(name string)

func (FeedResource) Validate ¶ added in v1.7.0 

func (f FeedResource) Validate() error

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

type FeedResources ¶ added in v1.7.0 

type FeedResources struct {
	Items []*FeedResource `json:"Items"`
	PagedResults
}

type FeedType ¶ added in v1.7.0 

type FeedType string

type Feeds ¶ 

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

func ToFeeds ¶ added in v1.7.0 

func ToFeeds(feedResources *FeedResources) *Feeds

type FeedsQuery ¶ added in v1.7.0 

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 Form ¶ added in v1.7.0 

type Form struct {
	Elements []*FormElement    `json:"Elements"`
	Values   map[string]string `json:"Values,omitempty"`
}

type FormElement ¶ added in v1.7.0 

type FormElement struct {
	Control         Control `json:"Control,omitempty"`
	IsValueRequired *bool   `json:"IsValueRequired,omitempty"`
	Name            string  `json:"Name,omitempty"`
}

type GitHubRepositoryFeed ¶ added in v1.7.0 

type GitHubRepositoryFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	FeedURI                     string `json:"FeedUri,omitempty"`

	Feed
}

GitHubRepositoryFeed represents a GitHub repository feed.

func NewGitHubRepositoryFeed ¶ added in v1.7.0 

func NewGitHubRepositoryFeed(name string) *GitHubRepositoryFeed

NewGitHubRepositoryFeed creates and initializes a GitHub repository feed.

func (*GitHubRepositoryFeed) GetID ¶ added in v1.7.0 

func (r *GitHubRepositoryFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *GitHubRepositoryFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*GitHubRepositoryFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *GitHubRepositoryFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*GitHubRepositoryFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *GitHubRepositoryFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*GitHubRepositoryFeed) Validate ¶ added in v1.7.0 

func (g *GitHubRepositoryFeed) Validate() error

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

type HelmFeed ¶ added in v1.7.0 

type HelmFeed struct {
	FeedURI string `json:"FeedUri,omitempty"`

	Feed
}

HelmFeed represents a Helm feed.

func NewHelmFeed ¶ added in v1.7.0 

func NewHelmFeed(name string) *HelmFeed

NewHelmFeed creates and initializes a Helm feed.

func (*HelmFeed) GetID ¶ added in v1.7.0 

func (r *HelmFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *HelmFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*HelmFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *HelmFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*HelmFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *HelmFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*HelmFeed) Validate ¶ added in v1.7.0 

func (h *HelmFeed) Validate() error

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

type IAccount ¶ added in v1.7.0 

type IAccount interface {
	GetAccountType() AccountType
	GetDescription() string
	GetEnvironmentIDs() []string
	GetTenantedDeploymentMode() TenantedDeploymentMode
	GetTenantIDs() []string
	GetTenantTags() []string
	SetDescription(string)

	IHasName
	IHasSpace
	IResource
}

func ToAccount ¶ added in v1.7.0 

func ToAccount(accountResource *AccountResource) (IAccount, error)

func ToAccountArray ¶ added in v1.7.0 

func ToAccountArray(accountResources []*AccountResource) []IAccount

type IDeploymentTarget ¶ added in v1.7.5 

type IDeploymentTarget interface {
	GetEndpoint() IEndpoint
	GetName() string
	GetHealthStatus() string
	GetIsDisabled() bool
}

type IDynamicWorkerPool ¶ added in v1.7.0 

type IDynamicWorkerPool interface {
	GetWorkerType() WorkerType

	IWorkerPool
}

type IEndpoint ¶ added in v1.7.0 

type IEndpoint interface {
	GetCommunicationStyle() string

	IResource
}

IEndpoint defines the interface for all endpoints.

func ToEndpoint ¶ added in v1.7.0 

func ToEndpoint(endpointResource *EndpointResource) (IEndpoint, error)

func ToEndpointArray ¶ added in v1.7.0 

func ToEndpointArray(endpointResources []*EndpointResource) []IEndpoint

type IEndpointWithAccount ¶ added in v1.7.0 

type IEndpointWithAccount interface {
	GetAccountID() string
}

type IEndpointWithFingerprint ¶ added in v1.7.0 

type IEndpointWithFingerprint interface {
	GetFingerprint() string
}

type IEndpointWithHostname ¶ added in v1.7.0 

type IEndpointWithHostname interface {
	GetHost() string
}

type IEndpointWithProxy ¶ added in v1.7.0 

type IEndpointWithProxy interface {
	GetProxyID() string
	SetProxyID(string)
}

type IFeed ¶ added in v1.7.0 

type IFeed interface {
	GetFeedType() FeedType
	GetName() string
	SetName(string)

	IResource
}

func ToFeed ¶ added in v1.7.0 

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

func ToFeedArray ¶ added in v1.7.0 

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

type IHasName ¶ added in v1.7.0 

type IHasName interface {
	GetName() string
	SetName(string)
}

type IHasSpace ¶ added in v1.7.0 

type IHasSpace interface {
	GetSpaceID() string
	SetSpaceID(string)
}

type IKubernetesAuthentication ¶ added in v1.7.0 

type IKubernetesAuthentication interface {
	GetAuthenticationType() string
}

type IResource ¶ added in v1.7.0 

type IResource interface {
	GetID() string
	GetModifiedBy() string
	GetModifiedOn() *time.Time
	GetLinks() map[string]string
	Validate() error
}

IResource defines the interface for all resources.

type IRunsOnAWorker ¶ added in v1.7.0 

type IRunsOnAWorker interface {
	GetDefaultWorkerPoolID() string
	SetDefaultWorkerPoolID(string)
}

IRunsOnAWorker defines the interface for all workers.

type IService ¶ added in v1.7.0 

type IService interface {
	// contains filtered or unexported methods
}

IService defines the contract for all services that communicate with the Octopus API.

type IWorkerPool ¶ added in v1.7.0 

type IWorkerPool interface {
	GetWorkerPoolType() WorkerPoolType
	GetIsDefault() bool

	IHasName
	IResource
}

type Identity ¶ added in v1.7.0 

type Identity struct {
	Claims               map[string]IdentityClaim `json:"Claims,omitempty"`
	IdentityProviderName string                   `json:"IdentityProviderName,omitempty"`
}

type IdentityClaim ¶ added in v1.7.0 

type IdentityClaim struct {
	IsIdentifyingClaim bool   `json:"IsIdentifyingClaim,omitempty"`
	Value              string `json:"Value,omitempty"`
}

type Interruption ¶ 

type Interruption struct {
	CanTakeResponsibility       bool      `json:"CanTakeResponsibility,omitempty"`
	CorrelationID               string    `json:"CorrelationId,omitempty"`
	Created                     time.Time `json:"Created,omitempty"`
	Form                        *Form     `json:"Form,omitempty"`
	HasResponsibility           bool      `json:"HasResponsibility"`
	IsLinkedToOtherInterruption bool      `json:"IsLinkedToOtherInterruption"`
	IsPending                   bool      `json:"IsPending"`
	RelatedDocumentIDs          []string  `json:"RelatedDocumentIds"`
	ResponsibleTeamIDs          []string  `json:"ResponsibleTeamIds"`
	ResponsibleUserID           string    `json:"ResponsibleUserId,omitempty"`
	SpaceID                     string    `json:"SpaceId,omitempty"`
	TaskID                      string    `json:"TaskId,omitempty"`
	Title                       string    `json:"Title,omitempty"`
	// contains filtered or unexported fields
}

func NewInterruption ¶ added in v1.7.0 

func NewInterruption() *Interruption

func (*Interruption) GetID ¶ added in v1.7.0 

func (r *Interruption) GetID() string

GetID returns the ID value of the resource. 

func (r *Interruption) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Interruption) GetModifiedBy ¶ added in v1.7.0 

func (r *Interruption) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Interruption) GetModifiedOn ¶ added in v1.7.0 

func (r *Interruption) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Interruption) Validate ¶ added in v1.7.0 

func (r *Interruption) Validate() error

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

type InterruptionSubmitRequest ¶ 

type InterruptionSubmitRequest struct {
	Instructions string `json:"Instructions"`
	Notes        string `json:"Notes"`
	Result       string `json:"Result"`
}

func NewInterruptionSubmitRequest ¶ added in v1.7.0 

func NewInterruptionSubmitRequest() *InterruptionSubmitRequest

type Interruptions ¶ 

type Interruptions struct {
	Items []*Interruption `json:"Items"`
	PagedResults
}

type InterruptionsQuery ¶ added in v1.7.0 

type InterruptionsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PendingOnly bool     `uri:"pendingOnly,omitempty" url:"pendingOnly,omitempty"`
	Regarding   string   `uri:"regarding,omitempty" url:"regarding,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type IssueTrackersQuery ¶ added in v1.7.0 

type IssueTrackersQuery struct {
	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 KubernetesAuthentication ¶ added in v1.7.0 

type KubernetesAuthentication struct {
	AccountID                 string `json:"AccountId,omitempty"`
	AdminLogin                string `json:"AdminLogin,omitempty"`
	AssumedRoleARN            string `json:"AssumedRoleArn,omitempty"`
	AssumedRoleSession        string `json:"AssumedRoleSession,omitempty"`
	AssumeRole                bool   `json:"AssumeRole,omitempty"`
	AssumeRoleSessionDuration int    `json:"AssumeRoleSessionDurationSeconds,omitempty"`
	AssumeRoleExternalID      string `json:"AssumeRoleExternalId,omitempty"`
	AuthenticationType        string `json:"AuthenticationType,omitempty"`
	ClientCertificate         string `json:"ClientCertificate,omitempty"`
	ClusterName               string `json:"ClusterName,omitempty"`
	ClusterResourceGroup      string `json:"ClusterResourceGroup,omitempty"`
	UseInstanceRole           bool   `json:"UseInstanceRole,omitempty"`
}

func (*KubernetesAuthentication) GetAuthenticationType ¶ added in v1.7.0 

func (k *KubernetesAuthentication) GetAuthenticationType() string

GetAuthenticationType returns the authentication type of this Kubernetes-based authentication.

type KubernetesAwsAuthentication ¶ added in v1.7.0 

type KubernetesAwsAuthentication struct {
	AssumedRoleARN            string `json:"AssumedRoleArn,omitempty"`
	AssumedRoleSession        string `json:"AssumedRoleSession,omitempty"`
	AssumeRole                bool   `json:"AssumeRole,omitempty"`
	AssumeRoleExternalID      string `json:"AssumeRoleExternalId,omitempty"`
	AssumeRoleSessionDuration int    `json:"AssumeRoleSessionDurationSeconds,omitempty"`
	ClusterName               string `json:"ClusterName,omitempty"`
	UseInstanceRole           bool   `json:"UseInstanceRole,omitempty"`

	KubernetesStandardAuthentication
}

func NewKubernetesAwsAuthentication ¶ added in v1.7.0 

func NewKubernetesAwsAuthentication() *KubernetesAwsAuthentication

NewKubernetesAwsAuthentication creates and initializes a Kubernetes AWS authentication.

type KubernetesAzureAuthentication ¶ added in v1.7.0 

type KubernetesAzureAuthentication struct {
	ClusterName          string `json:"ClusterName,omitempty"`
	ClusterResourceGroup string `json:"ClusterResourceGroup,omitempty"`

	KubernetesStandardAuthentication
}

func NewKubernetesAzureAuthentication ¶ added in v1.7.0 

func NewKubernetesAzureAuthentication() *KubernetesAzureAuthentication

NewKubernetesAzureAuthentication creates and initializes a Kubernetes Azure authentication.

type KubernetesCertificateAuthentication ¶ added in v1.7.0 

type KubernetesCertificateAuthentication struct {
	AuthenticationType string `json:"AuthenticationType"`
	ClientCertificate  string `json:"ClientCertificate,omitempty"`
}

func NewKubernetesCertificateAuthentication ¶ added in v1.7.0 

func NewKubernetesCertificateAuthentication() *KubernetesCertificateAuthentication

NewKubernetesCertificateAuthentication creates and initializes a Kubernetes certificate authentication.

func (*KubernetesCertificateAuthentication) GetAuthenticationType ¶ added in v1.7.0 

func (k *KubernetesCertificateAuthentication) GetAuthenticationType() string

GetAuthenticationType returns the authentication type of this Kubernetes-based authentication.

type KubernetesEndpoint ¶ added in v1.7.0 

type KubernetesEndpoint struct {
	Authentication      IKubernetesAuthentication `json:"Authentication,omitempty"`
	ClusterCertificate  string                    `json:"ClusterCertificate,omitempty"`
	ClusterURL          *url.URL                  `json:"ClusterUrl" validate:"required,url"`
	CommunicationStyle  string                    `json:"CommunicationStyle" validate:"required,eq=Kubernetes"`
	Container           DeploymentActionContainer `json:"Container,omitempty"`
	DefaultWorkerPoolID string                    `json:"DefaultWorkerPoolId,omitempty"`
	Namespace           string                    `json:"Namespace,omitempty"`
	ProxyID             string                    `json:"ProxyId,omitempty"`
	RunningInContainer  bool                      `json:"RunningInContainer"`
	SkipTLSVerification bool                      `json:"SkipTlsVerification"`
	// contains filtered or unexported fields
}

func NewKubernetesEndpoint ¶ added in v1.7.0 

func NewKubernetesEndpoint(clusterURL *url.URL) *KubernetesEndpoint

NewKubernetesEndpoint creates and initializes a new Kubernetes endpoint.

func (*KubernetesEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (s *KubernetesEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (*KubernetesEndpoint) GetDefaultWorkerPoolID ¶ added in v1.7.0 

func (k *KubernetesEndpoint) GetDefaultWorkerPoolID() string

GetDefaultWorkerPoolID returns the default worker pool ID of this Kubernetes endpoint.

func (*KubernetesEndpoint) GetID ¶ added in v1.7.0 

func (r *KubernetesEndpoint) GetID() string

GetID returns the ID value of the resource. 

func (r *KubernetesEndpoint) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*KubernetesEndpoint) GetModifiedBy ¶ added in v1.7.0 

func (r *KubernetesEndpoint) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*KubernetesEndpoint) GetModifiedOn ¶ added in v1.7.0 

func (r *KubernetesEndpoint) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*KubernetesEndpoint) GetProxyID ¶ added in v1.7.0 

func (k *KubernetesEndpoint) GetProxyID() string

GetProxyID returns the proxy ID associated with this Kubernetes endpoint.

func (*KubernetesEndpoint) MarshalJSON ¶ added in v1.7.0 

func (k *KubernetesEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON returns a Kubernetes endpoint as its JSON encoding.

func (*KubernetesEndpoint) SetDefaultWorkerPoolID ¶ added in v1.7.0 

func (k *KubernetesEndpoint) SetDefaultWorkerPoolID(defaultWorkerPoolID string)

SetDefaultWorkerPoolID sets the default worker pool ID of this Kubernetes endpoint.

func (*KubernetesEndpoint) SetProxyID ¶ added in v1.7.0 

func (k *KubernetesEndpoint) SetProxyID(proxyID string)

SetProxyID sets the proxy ID associated with this Kubernetes endpoint.

func (*KubernetesEndpoint) UnmarshalJSON ¶ added in v1.7.0 

func (k *KubernetesEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON sets this Kubernetes endpoint to its representation in JSON.

func (*KubernetesEndpoint) Validate ¶ added in v1.7.0 

func (k *KubernetesEndpoint) Validate() error

Validate checks the state of the Kubernetes endpoint and returns an error if invalid.

type KubernetesStandardAuthentication ¶ added in v1.7.0 

type KubernetesStandardAuthentication struct {
	AccountID          string `json:"AccountId,omitempty"`
	AuthenticationType string `json:"AuthenticationType"`
}

func NewKubernetesStandardAuthentication ¶ added in v1.7.0 

func NewKubernetesStandardAuthentication(authenticationType string) *KubernetesStandardAuthentication

NewKubernetesStandardAuthentication creates and initializes a Kubernetes AWS authentication.

func (*KubernetesStandardAuthentication) GetAuthenticationType ¶ added in v1.7.0 

func (k *KubernetesStandardAuthentication) GetAuthenticationType() string

GetAuthenticationType returns the authentication type of this Kubernetes-based authentication.

type Library ¶ added in v1.7.0 

type Library struct {
	LibraryVariableSetID   string                     `json:"LibraryVariableSetId,omitempty"`
	LibraryVariableSetName string                     `json:"LibraryVariableSetName,omitempty"`
	Links                  map[string]string          `json:"Links,omitempty"`
	Templates              []*ActionTemplateParameter `json:"Templates"`
	Variables              map[string]PropertyValue   `json:"Variables,omitempty"`
}

type LibraryVariable ¶ added in v1.7.24 

type LibraryVariable struct {
	LibraryVariableSetID   string                     `json:"LibraryVariableSetId,omitempty"`
	LibraryVariableSetName string                     `json:"LibraryVariableSetName,omitempty"`
	Links                  map[string]string          `json:"Links,omitempty"`
	Templates              []*ActionTemplateParameter `json:"Templates"`
	Variables              map[string]PropertyValue   `json:"Variables,omitempty"`
}

func NewLibraryVariable ¶ added in v1.7.28 

func NewLibraryVariable() *LibraryVariable

type LibraryVariableSet ¶ 

type LibraryVariableSet struct {
	ContentType   string                    `json:"ContentType" validate:"required,oneof=ScriptModule Variables"`
	Description   string                    `json:"Description,omitempty"`
	Name          string                    `json:"Name" validate:"required"`
	SpaceID       string                    `json:"SpaceId,omitempty"`
	Templates     []ActionTemplateParameter `json:"Templates,omitempty"`
	VariableSetID string                    `json:"VariableSetId,omitempty"`
	// contains filtered or unexported fields
}

func NewLibraryVariableSet ¶ 

func NewLibraryVariableSet(name string) *LibraryVariableSet

func (*LibraryVariableSet) GetID ¶ added in v1.7.0 

func (r *LibraryVariableSet) GetID() string

GetID returns the ID value of the resource. 

func (r *LibraryVariableSet) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*LibraryVariableSet) GetModifiedBy ¶ added in v1.7.0 

func (r *LibraryVariableSet) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*LibraryVariableSet) GetModifiedOn ¶ added in v1.7.0 

func (r *LibraryVariableSet) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (LibraryVariableSet) Validate ¶ added in v1.7.0 

func (l LibraryVariableSet) Validate() error

Validate checks the state of the library variable set and returns an error if invalid.

type LibraryVariableSetUsageEntry ¶ added in v1.7.0 

type LibraryVariableSetUsageEntry struct {
	LibraryVariableSetID   string `json:"LibraryVariableSetId,omitempty"`
	LibraryVariableSetName string `json:"LibraryVariableSetName,omitempty"`
	// contains filtered or unexported fields
}

func NewLibraryVariableSetUsageEntry ¶ added in v1.7.0 

func NewLibraryVariableSetUsageEntry() *LibraryVariableSetUsageEntry

func (*LibraryVariableSetUsageEntry) GetID ¶ added in v1.7.0 

func (r *LibraryVariableSetUsageEntry) GetID() string

GetID returns the ID value of the resource. 

func (r *LibraryVariableSetUsageEntry) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*LibraryVariableSetUsageEntry) GetModifiedBy ¶ added in v1.7.0 

func (r *LibraryVariableSetUsageEntry) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*LibraryVariableSetUsageEntry) GetModifiedOn ¶ added in v1.7.0 

func (r *LibraryVariableSetUsageEntry) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*LibraryVariableSetUsageEntry) Validate ¶ added in v1.7.0 

func (r *LibraryVariableSetUsageEntry) Validate() error

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

type LibraryVariableSets ¶ 

type LibraryVariableSets struct {
	Items []*LibraryVariableSet `json:"Items"`
	PagedResults
}

type LibraryVariablesQuery ¶ added in v1.7.0 

type LibraryVariablesQuery struct {
	ContentType string   `uri:"contentType,omitempty" url:"contentType,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 Lifecycle ¶ 

type Lifecycle struct {
	Description             string          `json:"Description,omitempty"`
	Name                    string          `json:"Name" validate:"required"`
	Phases                  []Phase         `json:"Phases,omitempty"`
	ReleaseRetentionPolicy  RetentionPeriod `json:"ReleaseRetentionPolicy,omitempty"`
	SpaceID                 string          `json:"SpaceId,omitempty"`
	TentacleRetentionPolicy RetentionPeriod `json:"TentacleRetentionPolicy,omitempty"`
	// contains filtered or unexported fields
}

func NewLifecycle ¶ 

func NewLifecycle(name string) *Lifecycle

func (*Lifecycle) GetID ¶ added in v1.7.0 

func (r *Lifecycle) GetID() string

GetID returns the ID value of the resource. 

func (r *Lifecycle) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Lifecycle) GetModifiedBy ¶ added in v1.7.0 

func (r *Lifecycle) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Lifecycle) GetModifiedOn ¶ added in v1.7.0 

func (r *Lifecycle) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Lifecycle) Validate ¶ added in v1.7.0 

func (l *Lifecycle) Validate() error

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

type Lifecycles ¶ 

type Lifecycles struct {
	Items []*Lifecycle `json:"Items"`
	PagedResults
}

type LifecyclesQuery ¶ added in v1.7.0 

type LifecyclesQuery struct {
	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 Links struct {
	Self        string `json:"Self"`
	Template    string `json:"Template"`
	PageAll     string `json:"Page.All"`
	PageCurrent string `json:"Page.Current"`
	PageLast    string `json:"Page.Last"`
	PageNext    string `json:"Page.Next"`
}

type ListAPIMetadata ¶ added in v1.7.0 

type ListAPIMetadata struct {
	APIEndpoint string `json:"ApiEndpoint,omitempty"`
	SelectMode  string `json:"SelectMode,omitempty"`
}

func NewListAPIMetadata ¶ added in v1.7.0 

func NewListAPIMetadata() *ListAPIMetadata

type ListeningTentacleDeploymentTarget ¶ added in v1.7.5 

type ListeningTentacleDeploymentTarget struct {
	Endpoint               *ListeningTentacleEndpoint `json:"Endpoint" validate:"required"`
	EnvironmentIDs         []string                   `json:"EnvironmentIds,omitempty"`
	HasLatestCalamari      bool                       `json:"HasLatestCalamari,omitempty"`
	HealthStatus           string                     `json:"HealthStatus,omitempty" validate:"omitempty,oneof=HasWarnings Healthy Unavailable Unhealthy Unknown"`
	IsDisabled             bool                       `json:"IsDisabled,omitempty"`
	IsInProcess            bool                       `json:"IsInProcess,omitempty"`
	MachinePolicyID        string                     `json:"MachinePolicyId,omitempty"`
	Name                   string                     `json:"Name,omitempty"`
	OperatingSystem        string                     `json:"OperatingSystem,omitempty"`
	Roles                  []string                   `json:"Roles,omitempty"`
	ShellName              string                     `json:"ShellName,omitempty"`
	ShellVersion           string                     `json:"ShellVersion,omitempty"`
	SpaceID                string                     `json:"SpaceId,omitempty"`
	Status                 string                     `json:"Status,omitempty" validate:"omitempty,oneof=CalamariNeedsUpgrade Disabled NeedsUpgrade Offline Online Unknown"`
	StatusSummary          string                     `json:"StatusSummary,omitempty"`
	TenantedDeploymentMode TenantedDeploymentMode     `json:"TenantedDeploymentParticipation,omitempty"`
	TenantIDs              []string                   `json:"TenantIds,omitempty"`
	TenantTags             []string                   `json:"TenantTags,omitempty"`
	Thumbprint             string                     `json:"Thumbprint,omitempty"`
	URI                    string                     `json:"Uri,omitempty" validate:"omitempty,uri"`
	// contains filtered or unexported fields
}

func NewListeningTentacleDeploymentTarget ¶ added in v1.7.5 

func NewListeningTentacleDeploymentTarget(name string, endpoint *ListeningTentacleEndpoint, environmentIDs []string, roles []string) *ListeningTentacleDeploymentTarget

func (*ListeningTentacleDeploymentTarget) GetEndpoint ¶ added in v1.7.5 

func (l *ListeningTentacleDeploymentTarget) GetEndpoint() IEndpoint

func (*ListeningTentacleDeploymentTarget) GetHealthStatus ¶ added in v1.7.5 

func (l *ListeningTentacleDeploymentTarget) GetHealthStatus() string

func (*ListeningTentacleDeploymentTarget) GetID ¶ added in v1.7.5 

func (r *ListeningTentacleDeploymentTarget) GetID() string

GetID returns the ID value of the resource.

func (*ListeningTentacleDeploymentTarget) GetIsDisabled ¶ added in v1.7.5 

func (l *ListeningTentacleDeploymentTarget) GetIsDisabled() bool
func (r *ListeningTentacleDeploymentTarget) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ListeningTentacleDeploymentTarget) GetModifiedBy ¶ added in v1.7.5 

func (r *ListeningTentacleDeploymentTarget) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ListeningTentacleDeploymentTarget) GetModifiedOn ¶ added in v1.7.5 

func (r *ListeningTentacleDeploymentTarget) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ListeningTentacleDeploymentTarget) GetName ¶ added in v1.7.5 

func (l *ListeningTentacleDeploymentTarget) GetName() string

func (*ListeningTentacleDeploymentTarget) Validate ¶ added in v1.7.5 

func (r *ListeningTentacleDeploymentTarget) Validate() error

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

type ListeningTentacleEndpoint ¶ added in v1.7.0 

type ListeningTentacleEndpoint struct {
	ProxyID string   `json:"ProxyId,omitempty"`
	URI     *url.URL `json:"Uri" validate:"required,uri"`
	// contains filtered or unexported fields
}

func NewListeningTentacleEndpoint ¶ added in v1.7.0 

func NewListeningTentacleEndpoint(uri *url.URL, thumbprint string) *ListeningTentacleEndpoint

func (ListeningTentacleEndpoint) MarshalJSON ¶ added in v1.7.0 

func (l ListeningTentacleEndpoint) MarshalJSON() ([]byte, error)

func (*ListeningTentacleEndpoint) UnmarshalJSON ¶ added in v1.7.0 

func (l *ListeningTentacleEndpoint) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this listening tentacle endpoint to its representation in JSON.

func (*ListeningTentacleEndpoint) Validate ¶ added in v1.7.0 

func (l *ListeningTentacleEndpoint) Validate() error

Validate checks the state of the listening tentacle endpoint and returns an error if invalid.

type MachineCleanupPolicy ¶ added in v1.7.0 

type MachineCleanupPolicy struct {
	DeleteMachinesBehavior        string        `json:"DeleteMachinesBehavior" validate:"required,oneof=DeleteUnavailableMachines DoNotDelete"`
	DeleteMachinesElapsedTimeSpan time.Duration `json:"DeleteMachinesElapsedTimeSpan,omitempty"`
}

func NewMachineCleanupPolicy ¶ added in v1.7.0 

func NewMachineCleanupPolicy() *MachineCleanupPolicy

func (*MachineCleanupPolicy) MarshalJSON ¶ added in v1.7.0 

func (m *MachineCleanupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON returns a machine policy as its JSON encoding.

func (*MachineCleanupPolicy) UnmarshalJSON ¶ added in v1.7.0 

func (m *MachineCleanupPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON sets this Kubernetes endpoint to its representation in JSON.

func (*MachineCleanupPolicy) Validate ¶ added in v1.7.0 

func (m *MachineCleanupPolicy) Validate() error

Validate checks the state of the machine policy and returns an error if invalid.

type MachineConnectionStatus ¶ added in v1.7.0 

type MachineConnectionStatus struct {
	CurrentTentacleVersion string                `json:"CurrentTentacleVersion,omitempty"`
	LastChecked            time.Time             `json:"LastChecked,omitempty"`
	Logs                   []*ActivityLogElement `json:"Logs"`
	MachineID              string                `json:"MachineId,omitempty"`
	Status                 string                `json:"Status,omitempty"`
	// contains filtered or unexported fields
}

func NewMachineConnectionStatus ¶ added in v1.7.0 

func NewMachineConnectionStatus() *MachineConnectionStatus

func (*MachineConnectionStatus) GetID ¶ added in v1.7.0 

func (r *MachineConnectionStatus) GetID() string

GetID returns the ID value of the resource. 

func (r *MachineConnectionStatus) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*MachineConnectionStatus) GetModifiedBy ¶ added in v1.7.0 

func (r *MachineConnectionStatus) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*MachineConnectionStatus) GetModifiedOn ¶ added in v1.7.0 

func (r *MachineConnectionStatus) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*MachineConnectionStatus) Validate ¶ added in v1.7.0 

func (r *MachineConnectionStatus) Validate() error

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

type MachineConnectivityPolicy ¶ added in v1.7.0 

type MachineConnectivityPolicy struct {
	MachineConnectivityBehavior string `json:"MachineConnectivityBehavior" validate:"oneof=ExpectedToBeOnline MayBeOfflineAndCanBeSkipped"`
}

func NewMachineConnectivityPolicy ¶ added in v1.7.0 

func NewMachineConnectivityPolicy() *MachineConnectivityPolicy

type MachineHealthCheckPolicy ¶ 

type MachineHealthCheckPolicy struct {
	BashHealthCheckPolicy       *MachineScriptPolicy `json:"BashHealthCheckPolicy" validate:"required"`
	HealthCheckCron             string               `json:"HealthCheckCron,omitempty"`
	HealthCheckCronTimezone     string               `json:"HealthCheckCronTimezone" validate:"required"`
	HealthCheckInterval         time.Duration        `json:"HealthCheckInterval,omitempty"`
	HealthCheckType             string               `json:"HealthCheckType" validate:"required,oneof=OnlyConnectivity RunScript"`
	PowerShellHealthCheckPolicy *MachineScriptPolicy `json:"PowerShellHealthCheckPolicy" validate:"required"`
}

func NewMachineHealthCheckPolicy ¶ added in v1.7.0 

func NewMachineHealthCheckPolicy() *MachineHealthCheckPolicy

func (*MachineHealthCheckPolicy) MarshalJSON ¶ added in v1.7.0 

func (m *MachineHealthCheckPolicy) MarshalJSON() ([]byte, error)

MarshalJSON returns a machine health check policy as its JSON encoding.

func (*MachineHealthCheckPolicy) UnmarshalJSON ¶ added in v1.7.0 

func (m *MachineHealthCheckPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON sets this machine health check policy to its representation in JSON.

func (*MachineHealthCheckPolicy) Validate ¶ added in v1.7.0 

func (m *MachineHealthCheckPolicy) Validate() error

Validate checks the state of the machine health check policy and returns an error if invalid.

type MachinePolicies ¶ 

type MachinePolicies struct {
	Items []*MachinePolicy `json:"Items"`
	PagedResults
}

type MachinePoliciesQuery ¶ added in v1.7.0 

type MachinePoliciesQuery struct {
	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 MachinePolicy ¶ 

type MachinePolicy struct {
	ConnectionConnectTimeout                      time.Duration              `json:"ConnectionConnectTimeout" validate:"required,min=10s"`
	ConnectionRetryCountLimit                     int32                      `json:"ConnectionRetryCountLimit" validate:"required,gte=2"`
	ConnectionRetrySleepInterval                  time.Duration              `json:"ConnectionRetrySleepInterval" validate:"required"`
	ConnectionRetryTimeLimit                      time.Duration              `json:"ConnectionRetryTimeLimit" validate:"required,min=10s"`
	Description                                   string                     `json:"Description,omitempty"`
	IsDefault                                     bool                       `json:"IsDefault"`
	MachineCleanupPolicy                          *MachineCleanupPolicy      `json:"MachineCleanupPolicy"`
	MachineConnectivityPolicy                     *MachineConnectivityPolicy `json:"MachineConnectivityPolicy"`
	MachineHealthCheckPolicy                      *MachineHealthCheckPolicy  `json:"MachineHealthCheckPolicy"`
	MachineUpdatePolicy                           *MachineUpdatePolicy       `json:"MachineUpdatePolicy"`
	Name                                          string                     `json:"Name" validate:"required,notblank"`
	PollingRequestMaximumMessageProcessingTimeout time.Duration              `json:"PollingRequestMaximumMessageProcessingTimeout" validate:"required"`
	PollingRequestQueueTimeout                    time.Duration              `json:"PollingRequestQueueTimeout" validate:"required"`
	SpaceID                                       string                     `json:"SpaceId,omitempty"`
	// contains filtered or unexported fields
}

func NewMachinePolicy ¶ added in v1.7.0 

func NewMachinePolicy(name string) *MachinePolicy

func (*MachinePolicy) GetID ¶ added in v1.7.0 

func (r *MachinePolicy) GetID() string

GetID returns the ID value of the resource. 

func (r *MachinePolicy) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*MachinePolicy) GetModifiedBy ¶ added in v1.7.0 

func (r *MachinePolicy) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*MachinePolicy) GetModifiedOn ¶ added in v1.7.0 

func (r *MachinePolicy) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*MachinePolicy) MarshalJSON ¶ added in v1.7.0 

func (m *MachinePolicy) MarshalJSON() ([]byte, error)

MarshalJSON returns a machine policy as its JSON encoding.

func (*MachinePolicy) UnmarshalJSON ¶ added in v1.7.0 

func (m *MachinePolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON sets this Kubernetes endpoint to its representation in JSON.

func (*MachinePolicy) Validate ¶ added in v1.7.0 

func (m *MachinePolicy) Validate() error

Validate checks the state of the machine policy and returns an error if invalid.

type MachineScriptPolicy ¶ added in v1.7.0 

type MachineScriptPolicy struct {
	RunType    string  `json:"RunType" validate:"required,oneof=InheritFromDefault Inline OnlyConnectivity"`
	ScriptBody *string `json:"ScriptBody"`
}

func NewMachineScriptPolicy ¶ added in v1.7.0 

func NewMachineScriptPolicy() *MachineScriptPolicy

type MachineTentacleVersionDetails ¶ 

type MachineTentacleVersionDetails struct {
	UpgradeLocked    bool   `json:"UpgradeLocked"`
	Version          string `json:"Version"`
	UpgradeSuggested bool   `json:"UpgradeSuggested"`
	UpgradeRequired  bool   `json:"UpgradeRequired"`
}

type MachineUpdatePolicy ¶ added in v1.7.0 

type MachineUpdatePolicy struct {
	CalamariUpdateBehavior  string `json:"CalamariUpdateBehavior" validate:"required,oneof=UpdateAlways UpdateOnDeployment UpdateOnNewMachine"`
	TentacleUpdateAccountID string `json:"TentacleUpdateAccountId,omitempty"`
	TentacleUpdateBehavior  string `json:"TentacleUpdateBehavior" validate:"required,oneof=NeverUpdate Update"`
}

func NewMachineUpdatePolicy ¶ added in v1.7.0 

func NewMachineUpdatePolicy() *MachineUpdatePolicy

type MachinesQuery ¶ added in v1.7.0 

type MachinesQuery struct {
	CommunicationStyles []string `uri:"commStyles,omitempty" url:"commStyles,omitempty"`
	DeploymentID        string   `uri:"deploymentId,omitempty" url:"deploymentId,omitempty"`
	EnvironmentIDs      []string `uri:"environmentIds,omitempty" url:"environmentIds,omitempty"`
	HealthStatuses      []string `uri:"healthStatuses,omitempty" url:"healthStatuses,omitempty"`
	IDs                 []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsDisabled          bool     `uri:"isDisabled,omitempty" url:"isDisabled,omitempty"`
	Name                string   `uri:"name,omitempty" url:"name,omitempty"`
	PartialName         string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Roles               []string `uri:"roles,omitempty" url:"roles,omitempty"`
	ShellNames          []string `uri:"shellNames,omitempty" url:"shellNames,omitempty"`
	Skip                int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take                int      `uri:"take,omitempty" url:"take,omitempty"`
	TenantIDs           []string `uri:"tenantIds,omitempty" url:"tenantIds,omitempty"`
	TenantTags          []string `uri:"tenantTags,omitempty" url:"tenantTags,omitempty"`
	Thumbprint          string   `uri:"thumbprint,omitempty" url:"thumbprint,omitempty"`
}

type MavenFeed ¶ added in v1.7.0 

type MavenFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	FeedURI                     string `json:"FeedUri,omitempty"`

	Feed
}

MavenFeed represents a Maven feed.

func NewMavenFeed ¶ added in v1.7.0 

func NewMavenFeed(name string) *MavenFeed

NewMavenFeed creates and initializes a Maven feed.

func (*MavenFeed) GetID ¶ added in v1.7.0 

func (r *MavenFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *MavenFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*MavenFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *MavenFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*MavenFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *MavenFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*MavenFeed) Validate ¶ added in v1.7.0 

func (m *MavenFeed) Validate() error

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

type Metadata ¶ added in v1.7.0 

type Metadata struct {
	Description string          `json:"Description,omitempty"`
	Types       []*TypeMetadata `json:"Types"`
}

func NewMetadata ¶ added in v1.7.0 

func NewMetadata() *Metadata

type MissingVariable ¶ added in v1.7.24 

type MissingVariable struct {
	EnvironmentID        string            `json:"EnvironmentId,omitempty"`
	LibraryVariableSetID string            `json:"LibraryVariableSetId,omitempty"`
	Links                map[string]string `json:"Links,omitempty"`
	ProjectID            string            `json:"ProjectId,omitempty"`
	VariableTemplateID   string            `json:"VariableTemplateId,omitempty"`
	VariableTemplateName string            `json:"VariableTemplateName,omitempty"`
}

type MissingVariablesQuery ¶ added in v1.7.24 

type MissingVariablesQuery struct {
	EnvironmentID  string `uri:"environmentId,omitempty" url:"environmentId,omitempty"`
	IncludeDetails bool   `uri:"includeDetails,omitempty" url:"includeDetails,omitempty"`
	ProjectID      string `uri:"projectId,omitempty" url:"projectId,omitempty"`
	TenantID       string `uri:"tenantId,omitempty" url:"tenantId,omitempty"`
}

type NamedReferenceItem ¶ added in v1.7.0 

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

func NewNamedReferenceItem ¶ added in v1.7.0 

func NewNamedReferenceItem() *NamedReferenceItem

type NuGetFeed ¶ added in v1.7.0 

type NuGetFeed struct {
	DownloadAttempts            int    `json:"DownloadAttempts"`
	DownloadRetryBackoffSeconds int    `json:"DownloadRetryBackoffSeconds"`
	EnhancedMode                bool   `json:"EnhancedMode"`
	FeedURI                     string `json:"FeedUri,omitempty"`

	Feed
}

NuGetFeed represents a NuGet feed.

func NewNuGetFeed ¶ added in v1.7.0 

func NewNuGetFeed(name string, feedURI string) *NuGetFeed

NewNuGetFeed creates and initializes a NuGet feed.

func (*NuGetFeed) GetID ¶ added in v1.7.0 

func (r *NuGetFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *NuGetFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*NuGetFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *NuGetFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*NuGetFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *NuGetFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*NuGetFeed) Validate ¶ added in v1.7.0 

func (n *NuGetFeed) Validate() error

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

type OctopusProjectFeed ¶ added in v1.7.0 

type OctopusProjectFeed struct {
	Feed
}

OctopusProjectFeed represents an Octopus project feed.

func NewOctopusProjectFeed ¶ added in v1.7.0 

func NewOctopusProjectFeed(name string, feedURI string) *OctopusProjectFeed

NewOctopusProjectFeed creates and initializes a Octopus project feed.

func (*OctopusProjectFeed) GetID ¶ added in v1.7.0 

func (r *OctopusProjectFeed) GetID() string

GetID returns the ID value of the resource. 

func (r *OctopusProjectFeed) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*OctopusProjectFeed) GetModifiedBy ¶ added in v1.7.0 

func (r *OctopusProjectFeed) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*OctopusProjectFeed) GetModifiedOn ¶ added in v1.7.0 

func (r *OctopusProjectFeed) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*OctopusProjectFeed) Validate ¶ added in v1.7.0 

func (o *OctopusProjectFeed) Validate() error

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

type OctopusServerNodeResource ¶ added in v1.7.0 

type OctopusServerNodeResource struct {
	IsInMaintenanceMode bool   `json:"IsInMaintenanceMode,omitempty"`
	MaxConcurrentTasks  int32  `json:"MaxConcurrentTasks,omitempty"`
	Name                string `json:"Name,omitempty"`
	// contains filtered or unexported fields
}

func NewOctopusServerNodeResource ¶ added in v1.7.0 

func NewOctopusServerNodeResource() *OctopusServerNodeResource

func (*OctopusServerNodeResource) GetID ¶ added in v1.7.0 

func (r *OctopusServerNodeResource) GetID() string

GetID returns the ID value of the resource. 

func (r *OctopusServerNodeResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*OctopusServerNodeResource) GetModifiedBy ¶ added in v1.7.0 

func (r *OctopusServerNodeResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*OctopusServerNodeResource) GetModifiedOn ¶ added in v1.7.0 

func (r *OctopusServerNodeResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*OctopusServerNodeResource) Validate ¶ added in v1.7.0 

func (r *OctopusServerNodeResource) Validate() error

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

type OctopusServerNodesQuery ¶ added in v1.7.0 

type OctopusServerNodesQuery struct {
	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 OfflinePackageDropDeploymentTarget ¶ added in v1.7.3 

type OfflinePackageDropDeploymentTarget struct {
	Endpoint               OfflinePackageDropEndpoint `json:"Endpoint" validate:"required"`
	EnvironmentIDs         []string                   `json:"EnvironmentIds"`
	HasLatestCalamari      bool                       `json:"HasLatestCalamari"`
	HealthStatus           string                     `json:"HealthStatus,omitempty" validate:"omitempty,oneof=HasWarnings Healthy Unavailable Unhealthy Unknown"`
	IsDisabled             bool                       `json:"IsDisabled"`
	IsInProcess            bool                       `json:"IsInProcess"`
	MachinePolicyID        string                     `json:"MachinePolicyId,omitempty"`
	Name                   string                     `json:"Name"`
	OperatingSystem        string                     `json:"OperatingSystem,omitempty"`
	Roles                  []string                   `json:"Roles"`
	ShellName              string                     `json:"ShellName,omitempty"`
	ShellVersion           string                     `json:"ShellVersion,omitempty"`
	SpaceID                string                     `json:"SpaceId,omitempty"`
	Status                 string                     `json:"Status,omitempty" validate:"omitempty,oneof=CalamariNeedsUpgrade Disabled NeedsUpgrade Offline Online Unknown"`
	StatusSummary          string                     `json:"StatusSummary,omitempty"`
	TenantedDeploymentMode TenantedDeploymentMode     `json:"TenantedDeploymentParticipation,omitempty"`
	TenantIDs              []string                   `json:"TenantIds"`
	TenantTags             []string                   `json:"TenantTags"`
	Thumbprint             string                     `json:"Thumbprint,omitempty"`
	URI                    string                     `json:"Uri,omitempty" validate:"omitempty,uri"`
	// contains filtered or unexported fields
}

func NewOfflinePackageDropDeploymentTarget ¶ added in v1.7.3 

func NewOfflinePackageDropDeploymentTarget(name string, endpoint OfflinePackageDropEndpoint, environmentIDs []string, roles []string) *OfflinePackageDropDeploymentTarget

func (*OfflinePackageDropDeploymentTarget) GetID ¶ added in v1.7.3 

func (r *OfflinePackageDropDeploymentTarget) GetID() string

GetID returns the ID value of the resource. 

func (r *OfflinePackageDropDeploymentTarget) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*OfflinePackageDropDeploymentTarget) GetModifiedBy ¶ added in v1.7.3 

func (r *OfflinePackageDropDeploymentTarget) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*OfflinePackageDropDeploymentTarget) GetModifiedOn ¶ added in v1.7.3 

func (r *OfflinePackageDropDeploymentTarget) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*OfflinePackageDropDeploymentTarget) Validate ¶ added in v1.7.3 

func (r *OfflinePackageDropDeploymentTarget) Validate() error

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

type OfflinePackageDropDestination ¶ added in v1.7.3 

type OfflinePackageDropDestination struct {
	DestinationType string `json:"DestinationType" validate:"oneof=Artifact FileSystem"`
	DropFolderPath  string `json:"DropFolderPath,omitempty"`
}

func NewOfflinePackageDropDestination ¶ added in v1.7.3 

func NewOfflinePackageDropDestination() *OfflinePackageDropDestination

type OfflinePackageDropEndpoint ¶ added in v1.7.3 

type OfflinePackageDropEndpoint struct {
	ApplicationsDirectory                string                        `json:"ApplicationsDirectory,omitempty"`
	Destination                          OfflinePackageDropDestination `json:"Destination"`
	SensitiveVariablesEncryptionPassword *SensitiveValue               `json:"SensitiveVariablesEncryptionPassword"`
	WorkingDirectory                     string                        `json:"OctopusWorkingDirectory,omitempty"`
	// contains filtered or unexported fields
}

func NewOfflinePackageDropEndpoint ¶ added in v1.7.3 

func NewOfflinePackageDropEndpoint() *OfflinePackageDropEndpoint

func (OfflinePackageDropEndpoint) GetCommunicationStyle ¶ added in v1.7.3 

func (e OfflinePackageDropEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (OfflinePackageDropEndpoint) Validate ¶ added in v1.7.3 

func (e OfflinePackageDropEndpoint) Validate() error

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

type OptionsMetadata ¶ added in v1.7.0 

type OptionsMetadata struct {
	SelectMode string            `json:"SelectMode,omitempty"`
	Values     map[string]string `json:"Values,omitempty"`
}

func NewOptionsMetadata ¶ added in v1.7.0 

func NewOptionsMetadata() *OptionsMetadata

type Package ¶ added in v1.7.0 

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 `json:"PackageVersionBuildInformation,omitempty"`
	Published        time.Time         `json:"ReleaseNotes,omitempty"`
	Summary          string            `json:"Summary,omitempty"`
	Title            string            `json:"Title,omitempty"`
	Version          string            `json:"Version,omitempty"`
	// contains filtered or unexported fields
}

func NewPackage ¶ added in v1.7.0 

func NewPackage() *Package

func (*Package) GetID ¶ added in v1.7.0 

func (r *Package) GetID() string

GetID returns the ID value of the resource. 

func (r *Package) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Package) GetModifiedBy ¶ added in v1.7.0 

func (r *Package) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Package) GetModifiedOn ¶ added in v1.7.0 

func (r *Package) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Package) Validate ¶ added in v1.7.0 

func (r *Package) Validate() error

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

type PackageDeltaSignatureQuery ¶ added in v1.7.0 

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

type PackageDeltaUploadQuery ¶ added in v1.7.0 

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 ¶ added in v1.7.0 

type PackageDescription struct {
	Description   string            `json:"Description,omitempty"`
	ID            string            `json:"Id,omitempty"`
	LatestVersion string            `json:"LatestVersion,omitempty"`
	Links         map[string]string `json:"Links,omitempty"`
	Name          string            `json:"Name,omitempty"`
}

type PackageDescriptions ¶ added in v1.7.0 

type PackageDescriptions struct {
	Items []*PackageDescription `json:"Items"`
	PagedResults
}

type PackageMetadataQuery ¶ added in v1.7.0 

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 PackageNote ¶ added in v1.7.0 

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 ¶ added in v1.7.0 

func NewPackageNote() *PackageNote

type PackageNotesListQuery ¶ added in v1.7.0 

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

type PackageNotesResult ¶ added in v1.7.0 

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 ¶ added in v1.7.0 

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 PackageUploadQuery ¶ added in v1.7.0 

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

type PackageVersion ¶ added in v1.7.0 

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"`
	// contains filtered or unexported fields
}

func NewPackageVersion ¶ added in v1.7.0 

func NewPackageVersion() *PackageVersion

func (*PackageVersion) GetID ¶ added in v1.7.0 

func (r *PackageVersion) GetID() string

GetID returns the ID value of the resource. 

func (r *PackageVersion) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*PackageVersion) GetModifiedBy ¶ added in v1.7.0 

func (r *PackageVersion) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*PackageVersion) GetModifiedOn ¶ added in v1.7.0 

func (r *PackageVersion) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*PackageVersion) Validate ¶ added in v1.7.0 

func (r *PackageVersion) Validate() error

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

type Packages ¶ added in v1.7.0 

type Packages struct {
	Items []*Package `json:"Items"`
	PagedResults
}

type PackagesBulkQuery ¶ added in v1.7.0 

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

type PackagesQuery ¶ added in v1.7.0 

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 PagedResults ¶ 

type PagedResults struct {
	IsStale        bool   `json:"IsStale"`
	ItemsPerPage   int    `json:"ItemsPerPage"`
	ItemType       string `json:"ItemType"`
	LastPageNumber int    `json:"LastPageNumber"`
	Links          Links  `json:"Links"`
	NumberOfPages  int    `json:"NumberOfPages"`
	TotalResults   int    `json:"TotalResults"`
}

type PermissionDescription ¶ added in v1.7.0 

type PermissionDescription struct {
	CanApplyAtSpaceLevel  *bool    `json:"CanApplyAtSpaceLevel,omitempty"`
	CanApplyAtSystemLevel *bool    `json:"CanApplyAtSystemLevel,omitempty"`
	Description           string   `json:"Description,omitempty"`
	SupportedRestrictions []string `json:"SupportedRestrictions"`
}

type Phase ¶ 

type Phase struct {
	AutomaticDeploymentTargets         []string         `json:"AutomaticDeploymentTargets"`
	ID                                 string           `json:"Id,omitempty"`
	IsOptionalPhase                    bool             `json:"IsOptionalPhase"`
	MinimumEnvironmentsBeforePromotion int32            `json:"MinimumEnvironmentsBeforePromotion"`
	Name                               string           `json:"Name" validate:"required"`
	OptionalDeploymentTargets          []string         `json:"OptionalDeploymentTargets"`
	ReleaseRetentionPolicy             *RetentionPeriod `json:"ReleaseRetentionPolicy"`
	TentacleRetentionPolicy            *RetentionPeriod `json:"TentacleRetentionPolicy"`
}

type PollingTentacleEndpoint ¶ added in v1.7.0 

type PollingTentacleEndpoint struct {
	URI *url.URL `json:"Uri" validate:"required,uri"`
	// contains filtered or unexported fields
}

func NewPollingTentacleEndpoint ¶ added in v1.7.0 

func NewPollingTentacleEndpoint(uri *url.URL, thumbprint string) *PollingTentacleEndpoint

func (PollingTentacleEndpoint) MarshalJSON ¶ added in v1.7.3 

func (l PollingTentacleEndpoint) MarshalJSON() ([]byte, error)

func (*PollingTentacleEndpoint) UnmarshalJSON ¶ added in v1.7.3 

func (l *PollingTentacleEndpoint) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this polling tentacle endpoint to its representation in JSON.

func (*PollingTentacleEndpoint) Validate ¶ added in v1.7.0 

func (l *PollingTentacleEndpoint) Validate() error

Validate checks the state of the listening tentacle endpoint and returns an error if invalid.

type ProcessReferenceDataItem ¶ added in v1.7.0 

type ProcessReferenceDataItem struct {
	ID          string `json:"Id,omitempty"`
	Name        string `json:"Name,omitempty"`
	ProcessType string `json:"ProcessType,omitempty"`
}

type Progression ¶ added in v1.7.0 

type Progression struct {
	ChannelEnvironments map[string][]ReferenceDataItem `json:"ChannelEnvironments,omitempty"`
	Environments        []*ReferenceDataItem           `json:"Environments"`
	Releases            []*ReleaseProgression          `json:"Releases"`
	// contains filtered or unexported fields
}

func (*Progression) GetID ¶ added in v1.7.0 

func (r *Progression) GetID() string

GetID returns the ID value of the resource. 

func (r *Progression) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Progression) GetModifiedBy ¶ added in v1.7.0 

func (r *Progression) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Progression) GetModifiedOn ¶ added in v1.7.0 

func (r *Progression) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Progression) Validate ¶ added in v1.7.0 

func (r *Progression) Validate() error

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

type Project ¶ 

type Project struct {
	AutoCreateRelease               bool                        `json:"AutoCreateRelease"`
	AutoDeployReleaseOverrides      []AutoDeployReleaseOverride `json:"AutoDeployReleaseOverrides,omitempty"`
	ClonedFromProjectID             string                      `json:"ClonedFromProjectId,omitempty"`
	DefaultGuidedFailureMode        string                      `json:"DefaultGuidedFailureMode,omitempty"`
	DefaultToSkipIfAlreadyInstalled bool                        `json:"DefaultToSkipIfAlreadyInstalled"`
	DeploymentChangesTemplate       string                      `json:"DeploymentChangesTemplate,omitempty"`
	DeploymentProcessID             string                      `json:"DeploymentProcessId,omitempty"`
	Description                     string                      `json:"Description,omitempty"`
	ExtensionSettings               []ExtensionSettingsValues   `json:"ExtensionSettings,omitempty"`
	IncludedLibraryVariableSets     []string                    `json:"IncludedLibraryVariableSetIds,omitempty"`
	IsDisabled                      bool                        `json:"IsDisabled"`
	IsDiscreteChannelRelease        bool                        `json:"DiscreteChannelRelease"`
	IsVersionControlled             bool                        `json:"IsVersionControlled"`
	LifecycleID                     string                      `json:"LifecycleId" validate:"required"`
	Name                            string                      `json:"Name" validate:"required"`
	ConnectivityPolicy              *ConnectivityPolicy         `json:"ProjectConnectivityPolicy,omitempty"`
	ProjectGroupID                  string                      `json:"ProjectGroupId" validate:"required"`
	ReleaseCreationStrategy         *ReleaseCreationStrategy    `json:"ReleaseCreationStrategy,omitempty"`
	ReleaseNotesTemplate            string                      `json:"ReleaseNotesTemplate,omitempty"`
	Slug                            string                      `json:"Slug,omitempty"`
	SpaceID                         string                      `json:"SpaceId,omitempty"`
	Templates                       []ActionTemplateParameter   `json:"Templates,omitempty"`
	TenantedDeploymentMode          TenantedDeploymentMode      `json:"TenantedDeploymentMode"`
	VariableSetID                   string                      `json:"VariableSetId,omitempty"`
	VersionControlSettings          *VersionControlSettings     `json:"VersionControlSettings,omitempty"`
	VersioningStrategy              VersioningStrategy          `json:"VersioningStrategy"`
	// contains filtered or unexported fields
}

func NewProject ¶ 

func NewProject(name string, lifeCycleID string, projectGroupID string) *Project

func (*Project) GetID ¶ added in v1.7.0 

func (r *Project) GetID() string

GetID returns the ID value of the resource. 

func (r *Project) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Project) GetModifiedBy ¶ added in v1.7.0 

func (r *Project) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Project) GetModifiedOn ¶ added in v1.7.0 

func (r *Project) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (Project) Validate ¶ added in v1.7.0 

func (resource Project) Validate() error

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

type ProjectGroup ¶ 

type ProjectGroup struct {
	Description       string   `json:"Description,omitempty"`
	EnvironmentIDs    []string `json:"EnvironmentIds,omitempty"`
	Name              string   `json:"Name,omitempty" validate:"required"`
	RetentionPolicyID string   `json:"RetentionPolicyId,omitempty"`
	// contains filtered or unexported fields
}

func NewProjectGroup ¶ 

func NewProjectGroup(name string) *ProjectGroup

func (*ProjectGroup) GetID ¶ added in v1.7.0 

func (r *ProjectGroup) GetID() string

GetID returns the ID value of the resource. 

func (r *ProjectGroup) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ProjectGroup) GetModifiedBy ¶ added in v1.7.0 

func (r *ProjectGroup) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ProjectGroup) GetModifiedOn ¶ added in v1.7.0 

func (r *ProjectGroup) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ProjectGroup) Validate ¶ 

func (r *ProjectGroup) Validate() error

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

type ProjectGroups ¶ 

type ProjectGroups struct {
	Items []*ProjectGroup `json:"Items"`
	PagedResults
}

type ProjectGroupsQuery ¶ added in v1.7.0 

type ProjectGroupsQuery struct {
	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 ProjectPulseQuery ¶ added in v1.7.0 

type ProjectPulseQuery struct {
	ProjectIDs []string `uri:"projectIds,omitempty" url:"projectIds,omitempty"`
}

type ProjectSummary ¶ added in v1.7.0 

type ProjectSummary struct {
	HasDeploymentProcess bool `json:"HasDeploymentProcess,omitempty"`
	HasRunbooks          bool `json:"HasRunbooks,omitempty"`
}

type ProjectTrigger ¶ 

type ProjectTrigger struct {
	Action      ProjectTriggerAction `json:"Action"`
	Description string               `json:"Description,omitempty"`
	Filter      ProjectTriggerFilter `json:"Filter"`
	IsDisabled  bool                 `json:"IsDisabled,omitempty"`
	Name        string               `json:"Name"`
	ProjectID   string               `json:"ProjectId,omitempty"`
	SpaceID     string               `json:"SpaceId,omitempty"`
	// contains filtered or unexported fields
}

func NewProjectDeploymentTargetTrigger ¶ 

func NewProjectDeploymentTargetTrigger(name, projectID string, shouldRedeploy bool, roles, eventGroups, eventCategories []string) *ProjectTrigger

func (*ProjectTrigger) AddEventCategories ¶ 

func (t *ProjectTrigger) AddEventCategories(eventCategories []string)

func (*ProjectTrigger) AddEventGroups ¶ 

func (t *ProjectTrigger) AddEventGroups(eventGroups []string)

func (*ProjectTrigger) GetID ¶ added in v1.7.0 

func (r *ProjectTrigger) GetID() string

GetID returns the ID value of the resource. 

func (r *ProjectTrigger) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ProjectTrigger) GetModifiedBy ¶ added in v1.7.0 

func (r *ProjectTrigger) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ProjectTrigger) GetModifiedOn ¶ added in v1.7.0 

func (r *ProjectTrigger) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ProjectTrigger) Validate ¶ added in v1.7.0 

func (r *ProjectTrigger) Validate() error

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

type ProjectTriggerAction ¶ 

type ProjectTriggerAction struct {
	ActionType                                 string `json:"ActionType"`
	DestinationEnvironmentID                   string `json:"DestinationEnvironmentId"`
	ShouldRedeployWhenMachineHasBeenDeployedTo bool   `json:"ShouldRedeployWhenMachineHasBeenDeployedTo"`
	SourceEnvironmentID                        string `json:"SourceEnvironmentId"`
}

type ProjectTriggerFilter ¶ 

type ProjectTriggerFilter struct {
	DateOfMonth         string   `json:"DateOfMonth"`
	DayNumberOfMonth    string   `json:"DayNumberOfMonth"`
	DayOfWeek           string   `json:"DayOfWeek"`
	EnvironmentIDs      []string `json:"EnvironmentIds,omitempty"`
	EventCategories     []string `json:"EventCategories,omitempty"`
	EventGroups         []string `json:"EventGroups,omitempty"`
	FilterType          string   `json:"FilterType"`
	MonthlyScheduleType string   `json:"MonthlyScheduleType"`
	Roles               []string `json:"Roles"`
	StartTime           string   `json:"StartTime"`
	Timezone            string   `json:"Timezone"`
}

type ProjectTriggers ¶ 

type ProjectTriggers struct {
	Items []*ProjectTrigger `json:"Items"`
	PagedResults
}

type ProjectTriggersQuery ¶ added in v1.7.0 

type ProjectTriggersQuery struct {
	IDs      []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Runbooks []string `uri:"runbooks,omitempty" url:"runbooks,omitempty"`
	Skip     int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take     int      `uri:"take,omitempty" url:"take,omitempty"`
}

type ProjectVariable ¶ added in v1.7.24 

type ProjectVariable struct {
	Links       map[string]string                   `json:"Links,omitempty"`
	ProjectID   string                              `json:"ProjectId,omitempty"`
	ProjectName string                              `json:"ProjectName,omitempty"`
	Templates   []*ActionTemplateParameter          `json:"Templates"`
	Variables   map[string]map[string]PropertyValue `json:"Variables,omitempty"`
}

type ProjectVariableSetUsage ¶ added in v1.7.0 

type ProjectVariableSetUsage struct {
	IsCurrentlyBeingUsedInProject bool                         `json:"IsCurrentlyBeingUsedInProject"`
	ProjectID                     string                       `json:"ProjectId,omitempty"`
	ProjectName                   string                       `json:"ProjectName,omitempty"`
	ProjectSlug                   string                       `json:"ProjectSlug,omitempty"`
	Releases                      []*ReleaseUsageEntry         `json:"Releases"`
	RunbookSnapshots              []*RunbookSnapshotUsageEntry `json:"RunbookSnapshots"`
}

type ProjectedTeamReferenceDataItem ¶ added in v1.7.0 

type ProjectedTeamReferenceDataItem struct {
	ExternalSecurityGroups []NamedReferenceItem `json:"ExternalSecurityGroups"`
	ID                     string               `json:"Id,omitempty"`
	IsDirectlyAssigned     bool                 `json:"IsDirectlyAssigned,omitempty"`
	Name                   string               `json:"Name,omitempty"`
	SpaceID                string               `json:"SpaceId,omitempty"`
}

type Projects ¶ 

type Projects struct {
	Items []*Project `json:"Items"`
	PagedResults
}

type ProjectsExperimentalSummariesQuery ¶ added in v1.7.0 

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

type ProjectsQuery ¶ added in v1.7.0 

type ProjectsQuery struct {
	ClonedFromProjectID string   `url:"clonedFromProjectId"`
	IDs                 []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsClone             bool     `uri:"clone,omitempty" url:"clone,omitempty"`
	Name                string   `uri:"name,omitempty" url:"name,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 PropertyApplicability ¶ added in v1.7.0 

type PropertyApplicability struct {
	DependsOnPropertyName  string      `json:"DependsOnPropertyName,omitempty"`
	DependsOnPropertyValue interface{} `json:"DependsOnPropertyValue,omitempty"`
	Mode                   string      `` /* 149-byte string literal not displayed */
}

func NewPropertyApplicability ¶ added in v1.7.0 

func NewPropertyApplicability() *PropertyApplicability

func (PropertyApplicability) Validate ¶ added in v1.7.0 

func (p PropertyApplicability) Validate() error

Validate checks the state of the property applicability and returns an error if invalid.

type PropertyMetadata ¶ added in v1.7.0 

type PropertyMetadata struct {
	DisplayInfo *DisplayInfo `json:"DisplayInfo,omitempty"`
	Name        string       `json:"Name,omitempty"`
	Type        string       `json:"Type,omitempty"`
}

func NewPropertyMetadata ¶ added in v1.7.0 

func NewPropertyMetadata() *PropertyMetadata

type PropertyValue ¶ 

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

func NewPropertyValue ¶ added in v1.7.15 

func NewPropertyValue(value string, isSensitive bool) PropertyValue

func (PropertyValue) MarshalJSON ¶ added in v1.7.15 

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

func (*PropertyValue) UnmarshalJSON ¶ added in v1.7.15 

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

UnmarshalJSON sets this property value to its representation in JSON.

type ProxiesQuery ¶ added in v1.7.0 

type ProxiesQuery struct {
	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 ReferenceDataItem ¶ added in v1.7.0 

type ReferenceDataItem struct {
	ID   string `json:"Id,omitempty"`
	Name string `json:"Name,omitempty"`
}

type Release ¶ added in v1.7.0 

type Release struct {
	Assembled                          time.Time                                `json:"Assembled,omitempty"`
	BuildInformation                   []*ReleasePackageVersionBuildInformation `json:"BuildInformation,omitempty"`
	ChannelID                          string                                   `json:"ChannelId,omitempty"`
	IgnoreChannelRules                 bool                                     `json:"IgnoreChannelRules,omitempty"`
	LibraryVariableSetSnapshotIDs      []string                                 `json:"LibraryVariableSetSnapshotIds,omitempty"`
	ProjectDeploymentProcessSnapshotID string                                   `json:"ProjectDeploymentProcessSnapshotId,omitempty"`
	ProjectID                          string                                   `json:"ProjectId,omitempty"`
	ProjectVariableSetSnapshotID       string                                   `json:"ProjectVariableSetSnapshotId,omitempty"`
	ReleaseNotes                       string                                   `json:"ReleaseNotes,omitempty"`
	SelectedPackages                   []*SelectedPackage                       `json:"SelectedPackages,omitempty"`
	SpaceID                            string                                   `json:"SpaceId,omitempty"`
	Version                            string                                   `json:"Version"`
	// contains filtered or unexported fields
}

func NewRelease ¶ added in v1.7.0 

func NewRelease(channelID string, projectID string, version string) *Release

func (*Release) GetID ¶ added in v1.7.0 

func (r *Release) GetID() string

GetID returns the ID value of the resource. 

func (r *Release) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Release) GetModifiedBy ¶ added in v1.7.0 

func (r *Release) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Release) GetModifiedOn ¶ added in v1.7.0 

func (r *Release) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Release) Validate ¶ added in v1.7.0 

func (r *Release) Validate() error

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

type ReleaseChanges ¶ added in v1.7.0 

type ReleaseChanges struct {
	BuildInformation []*ReleasePackageVersionBuildInformation `json:"BuildInformation"`
	Commits          []*CommitDetails                         `json:"Commits"`
	ReleaseNotes     string                                   `json:"ReleaseNotes,omitempty"`
	Version          string                                   `json:"Version,omitempty"`
	WorkItems        []*WorkItemLink                          `json:"WorkItems"`
}

type ReleaseCreationStrategy ¶ 

type ReleaseCreationStrategy struct {
	ChannelID                    string                   `json:"ChannelId,omitempty"`
	ReleaseCreationPackage       *DeploymentActionPackage `json:"ReleaseCreationPackage,omitempty"`
	ReleaseCreationPackageStepID string                   `json:"ReleaseCreationPackageStepId,omitempty"`
}

type ReleasePackageVersionBuildInformation ¶ added in v1.7.0 

type ReleasePackageVersionBuildInformation struct {
	Branch           string           `json:"Branch,omitempty"`
	BuildEnvironment string           `json:"BuildEnvironment,omitempty"`
	BuildNumber      string           `json:"BuildNumber,omitempty"`
	BuildURL         string           `json:"BuildUrl,omitempty"`
	Commits          []*CommitDetails `json:"Commits"`
	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        []*WorkItemLink  `json:"WorkItems"`
}

type ReleaseProgression ¶ added in v1.7.0 

type ReleaseProgression struct {
	Channel                 *Channel                   `json:"Channel,omitempty"`
	Deployments             map[string][]DashboardItem `json:"Deployments,omitempty"`
	HasUnresolvedDefect     bool                       `json:"HasUnresolvedDefect,omitempty"`
	NextDeployments         []string                   `json:"NextDeployments"`
	Release                 *Release                   `json:"Release,omitempty"`
	ReleaseRetentionPeriod  *RetentionPeriod           `json:"ReleaseRetentionPeriod,omitempty"`
	TentacleRetentionPeriod *RetentionPeriod           `json:"TentacleRetentionPeriod,omitempty"`
}

type ReleaseQuery ¶ added in v1.7.0 

type ReleaseQuery struct {
	SearchByVersion string `uri:"searchByVersion" url:"searchByVersion,omitempty"`
	Skip            int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take            int    `uri:"take,omitempty" url:"take,omitempty"`
}

type ReleaseUsage ¶ added in v1.7.0 

type ReleaseUsage struct {
	ProjectID   string               `json:"ProjectId,omitempty"`
	ProjectName string               `json:"ProjectName,omitempty"`
	Releases    []*ReleaseUsageEntry `json:"Releases"`
}

type ReleaseUsageEntry ¶ added in v1.7.0 

type ReleaseUsageEntry struct {
	ReleaseID      string `json:"ReleaseId,omitempty"`
	ReleaseVersion string `json:"ReleaseVersion,omitempty"`
}

type Releases ¶ added in v1.7.0 

type Releases struct {
	Items []*Release `json:"Items"`
	PagedResults
}

Releases defines a collection of Release instance with built-in support for paged results from the API.

type ReleasesQuery ¶ added in v1.7.0 

type ReleasesQuery struct {
	IDs                []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IgnoreChannelRules bool     `uri:"ignoreChannelRules,omitempty" url:"ignoreChannelRules,omitempty"`
	Skip               int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take               int      `uri:"take,omitempty" url:"take,omitempty"`
}

type ReplacementCertificate ¶ added in v1.7.0 

type ReplacementCertificate struct {
	CertificateData string `json:"CertificateData,omitempty"`
	Password        string `json:"Password,omitempty"`
}

func NewReplacementCertificate ¶ added in v1.7.0 

func NewReplacementCertificate(certificateData string, password string) *ReplacementCertificate

type Resources ¶ added in v1.7.0 

type Resources struct {
	Items []*resource `json:"Items"`
	PagedResults
}

type RetentionPeriod ¶ 

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

type RootResource ¶ added in v1.7.0 

type RootResource struct {
	Application          string     `json:"Application" validate:"required"`
	Version              string     `json:"Version" validate:"required"`
	APIVersion           string     `json:"ApiVersion" validate:"required"`
	InstallationID       *uuid.UUID `json:"InstallationId" validate:"required"`
	IsEarlyAccessProgram bool       `json:"IsEarlyAccessProgram"`
	HasLongTermSupport   bool       `json:"HasLongTermSupport"`
	// contains filtered or unexported fields
}

func NewRootResource ¶ added in v1.7.0 

func NewRootResource() *RootResource

func (*RootResource) GetID ¶ added in v1.7.0 

func (r *RootResource) GetID() string

GetID returns the ID value of the resource.

func (*RootResource) GetLinkPath ¶ added in v1.7.0 

func (r *RootResource) GetLinkPath(args ...interface{}) string

GetLinkPath returns correct Link Path 

func (r *RootResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*RootResource) GetModifiedBy ¶ added in v1.7.0 

func (r *RootResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*RootResource) GetModifiedOn ¶ added in v1.7.0 

func (r *RootResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*RootResource) Validate ¶ added in v1.7.0 

func (r *RootResource) Validate() error

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

type Runbook ¶ added in v1.7.0 

type Runbook struct {
	ConnectivityPolicy         *ConnectivityPolicy     `json:"ConnectivityPolicy,omitempty"`
	DefaultGuidedFailureMode   string                  `json:"DefaultGuidedFailureMode" validate:"required,oneof=EnvironmentDefault Off On"`
	Description                string                  `json:"Description,omitempty"`
	EnvironmentScope           string                  `json:"EnvironmentScope" validate:"required,oneof=All FromProjectLifecycles Specified"`
	Environments               []string                `json:"Environments,omitempty"`
	MultiTenancyMode           string                  `json:"MultiTenancyMode" validate:"required,oneof=Untenanted TenantedOrUntenanted Tenanted"`
	Name                       string                  `json:"Name,omitempty"`
	ProjectID                  string                  `json:"ProjectId,omitempty"`
	PublishedRunbookSnapshotID string                  `json:"PublishedRunbookSnapshotId,omitempty"`
	RunRetentionPolicy         *RunbookRetentionPeriod `json:"RunRetentionPolicy,omitempty"`
	RunbookProcessID           string                  `json:"RunbookProcessId,omitempty"`
	SpaceID                    string                  `json:"SpaceId,omitempty"`
	// contains filtered or unexported fields
}

func NewRunbook ¶ added in v1.7.0 

func NewRunbook(
	name string,
	projectID string,
) *Runbook

NewRunbook creates and initializes a runbook.

func (*Runbook) GetID ¶ added in v1.7.0 

func (r *Runbook) GetID() string

GetID returns the ID value of the resource. 

func (r *Runbook) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Runbook) GetModifiedBy ¶ added in v1.7.0 

func (r *Runbook) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Runbook) GetModifiedOn ¶ added in v1.7.0 

func (r *Runbook) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Runbook) Validate ¶ added in v1.7.0 

func (r *Runbook) Validate() error

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

type RunbookProcess ¶ added in v1.7.0 

type RunbookProcess struct {
	LastSnapshotID string            `json:"LastSnapshotId,omitempty"`
	ProjectID      string            `json:"ProjectId,omitempty"`
	RunbookID      string            `json:"RunbookId,omitempty"`
	SpaceID        string            `json:"SpaceId,omitempty"`
	Steps          []*DeploymentStep `json:"Steps"`
	Version        *int32            `json:"Version"`
	// contains filtered or unexported fields
}

func NewRunbookProcess ¶ added in v1.7.0 

func NewRunbookProcess() *RunbookProcess

func (*RunbookProcess) GetID ¶ added in v1.7.0 

func (r *RunbookProcess) GetID() string

GetID returns the ID value of the resource. 

func (r *RunbookProcess) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*RunbookProcess) GetModifiedBy ¶ added in v1.7.0 

func (r *RunbookProcess) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*RunbookProcess) GetModifiedOn ¶ added in v1.7.0 

func (r *RunbookProcess) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*RunbookProcess) Validate ¶ added in v1.7.0 

func (r *RunbookProcess) Validate() error

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

type RunbookProcesses ¶ added in v1.7.0 

type RunbookProcesses struct {
	Items []*RunbookProcess `json:"Items"`
	PagedResults
}

type RunbookProcessesQuery ¶ added in v1.7.0 

type RunbookProcessesQuery struct {
	IDs  []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Skip int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int      `uri:"take,omitempty" url:"take,omitempty"`
}

type RunbookRetentionPeriod ¶ added in v1.7.0 

type RunbookRetentionPeriod struct {
	QuantityToKeep    int32 `json:"QuantityToKeep"`
	ShouldKeepForever bool  `json:"ShouldKeepForever"`
}

func NewRunbookRetentionPeriod ¶ added in v1.7.0 

func NewRunbookRetentionPeriod() *RunbookRetentionPeriod

type RunbookRunsQuery ¶ added in v1.7.0 

type RunbookRunsQuery struct {
	Environments []string `uri:"environments,omitempty" url:"environments,omitempty"`
	IDs          []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName  string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Projects     []string `uri:"projects,omitempty" url:"projects,omitempty"`
	Runbooks     []string `uri:"runbooks,omitempty" url:"runbooks,omitempty"`
	Skip         int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take         int      `uri:"take,omitempty" url:"take,omitempty"`
	TaskState    string   `uri:"taskState,omitempty" url:"taskState,omitempty"`
	Tenants      []string `uri:"tenants,omitempty" url:"tenants,omitempty"`
}

type RunbookSnapshotUsage ¶ added in v1.7.0 

type RunbookSnapshotUsage struct {
	ProjectID   string                       `json:"ProjectId,omitempty"`
	ProjectName string                       `json:"ProjectName,omitempty"`
	RunbookID   string                       `json:"RunbookId,omitempty"`
	RunbookName string                       `json:"RunbookName,omitempty"`
	Snapshots   []*RunbookSnapshotUsageEntry `json:"Snapshots"`
}

type RunbookSnapshotUsageEntry ¶ added in v1.7.0 

type RunbookSnapshotUsageEntry struct {
	SnapshotID   string `json:"SnapshotId,omitempty"`
	SnapshotName string `json:"SnapshotName,omitempty"`
}

type RunbookSnapshotsQuery ¶ added in v1.7.0 

type RunbookSnapshotsQuery struct {
	IDs     []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Publish bool     `uri:"publish,omitempty" url:"publish,omitempty"`
	Skip    int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take    int      `uri:"take,omitempty" url:"take,omitempty"`
}

type RunbookStepUsage ¶ added in v1.7.0 

type RunbookStepUsage struct {
	ProcessID   string            `json:"ProcessId,omitempty"`
	ProjectID   string            `json:"ProjectId,omitempty"`
	ProjectName string            `json:"ProjectName,omitempty"`
	ProjectSlug string            `json:"ProjectSlug,omitempty"`
	RunbookID   string            `json:"RunbookId,omitempty"`
	RunbookName string            `json:"RunbookName,omitempty"`
	Steps       []*StepUsageEntry `json:"Steps"`
}

type Runbooks ¶ added in v1.7.0 

type Runbooks struct {
	Items []*Runbook `json:"Items"`
	PagedResults
}

Runbooks defines a collection of runbooks with built-in support for paged results.

type RunbooksQuery ¶ added in v1.7.0 

type RunbooksQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsClone     bool     `uri:"clone,omitempty" url:"clone,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	ProjectIDs  []string `uri:"projectIds,omitempty" url:"projectIds,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type SSHEndpoint ¶ added in v1.7.0 

type SSHEndpoint struct {
	AccountID          string `json:"AccountId,omitempty"`
	CommunicationStyle string `json:"CommunicationStyle" validate:"required,eq=Ssh"`
	DotNetCorePlatform string
	Fingerprint        string
	Host               string
	ProxyID            string `json:"ProxyId,omitempty"`
	Port               int
	URI                *url.URL `json:"Uri"`
	// contains filtered or unexported fields
}

SSHEndpoint contains the information necessary to communicate with an SSH endpoint. If a private key file is provided it will be used; otherwise we fall back to username/password.

func NewSSHEndpoint ¶ added in v1.7.0 

func NewSSHEndpoint(host string, port int, fingerprint string) *SSHEndpoint

NewSSHEndpoint creates and initializes a new SSH endpoint.

func (*SSHEndpoint) GetAccountID ¶ added in v1.7.0 

func (s *SSHEndpoint) GetAccountID() string

GetAccountID returns the account ID associated with this SSH endpoint.

func (*SSHEndpoint) GetCommunicationStyle ¶ added in v1.7.0 

func (s *SSHEndpoint) GetCommunicationStyle() string

GetCommunicationStyle returns the communication style of this endpoint.

func (*SSHEndpoint) GetFingerprint ¶ added in v1.7.0 

func (s *SSHEndpoint) GetFingerprint() string

GetFingerprint returns the fingerprint associated with this SSH endpoint.

func (*SSHEndpoint) GetHost ¶ added in v1.7.0 

func (s *SSHEndpoint) GetHost() string

GetHost returns the host associated with this SSH endpoint.

func (*SSHEndpoint) GetID ¶ added in v1.7.0 

func (r *SSHEndpoint) GetID() string

GetID returns the ID value of the resource. 

func (r *SSHEndpoint) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*SSHEndpoint) GetModifiedBy ¶ added in v1.7.0 

func (r *SSHEndpoint) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*SSHEndpoint) GetModifiedOn ¶ added in v1.7.0 

func (r *SSHEndpoint) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*SSHEndpoint) GetProxyID ¶ added in v1.7.0 

func (s *SSHEndpoint) GetProxyID() string

GetProxyID returns the proxy ID associated with this SSH endpoint.

func (*SSHEndpoint) MarshalJSON ¶ added in v1.7.0 

func (s *SSHEndpoint) MarshalJSON() ([]byte, error)

func (*SSHEndpoint) SetProxyID ¶ added in v1.7.0 

func (s *SSHEndpoint) SetProxyID(proxyID string)

SetProxyID sets the proxy ID associated with this SSH endpoint.

func (*SSHEndpoint) UnmarshalJSON ¶ added in v1.7.0 

func (s *SSHEndpoint) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this SSH endpoint to its representation in JSON.

func (*SSHEndpoint) Validate ¶ added in v1.7.0 

func (s *SSHEndpoint) Validate() error

Validate checks the state of the SSH endpoint and returns an error if invalid.

type SSHKeyAccount ¶ added in v1.7.0 

type SSHKeyAccount struct {
	PrivateKeyFile       *SensitiveValue `validate:"required"`
	PrivateKeyPassphrase *SensitiveValue
	Username             string `validate:"required"`
	// contains filtered or unexported fields
}

SSHKeyAccount represents a SSH key pair account.

func NewSSHKeyAccount ¶ added in v1.7.0 

func NewSSHKeyAccount(name string, username string, privateKeyFile *SensitiveValue, options ...func(*SSHKeyAccount)) (*SSHKeyAccount, error)

NewSSHKeyAccount initializes and returns a SSH key pair account with a name, username, and private key file.

func (*SSHKeyAccount) GetAccountType ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*SSHKeyAccount) GetDescription ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetDescription() string

GetDescription returns the description of the account.

func (*SSHKeyAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetEnvironmentIDs() []string

func (*SSHKeyAccount) GetName ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetName() string

GetName returns the name of the account.

func (*SSHKeyAccount) GetSpaceID ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*SSHKeyAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetTenantIDs() []string

func (*SSHKeyAccount) GetTenantTags ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetTenantTags() []string

func (*SSHKeyAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *SSHKeyAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*SSHKeyAccount) SetDescription ¶ added in v1.7.0 

func (a *SSHKeyAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*SSHKeyAccount) SetName ¶ added in v1.7.0 

func (a *SSHKeyAccount) SetName(name string)

SetName sets the name of the account.

func (*SSHKeyAccount) SetSpaceID ¶ added in v1.7.0 

func (a *SSHKeyAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*SSHKeyAccount) Validate ¶ added in v1.7.0 

func (s *SSHKeyAccount) Validate() error

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

type ScheduledProjectTriggersQuery ¶ added in v1.7.0 

type ScheduledProjectTriggersQuery struct {
	IDs  []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Skip int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take int      `uri:"take,omitempty" url:"take,omitempty"`
}

type SchedulerQuery ¶ added in v1.7.0 

type SchedulerQuery struct {
	Verbose bool   `uri:"verbose,omitempty" url:"verbose,omitempty"`
	Tail    string `uri:"tail,omitempty" url:"tail,omitempty"`
}

type ScopedUserRole ¶ added in v1.7.15 

type ScopedUserRole struct {
	EnvironmentIDs  []string `json:"EnvironmentIds,omitempty"`
	ProjectIDs      []string `json:"ProjectIds,omitempty"`
	ProjectGroupIDs []string `json:"ProjectGroupIds,omitempty"`
	TeamID          string   `json:"TeamId"`
	TenantIDs       []string `json:"TenantIds,omitempty"`
	SpaceID         string   `json:"SpaceId"`
	UserRoleID      string   `json:"UserRoleId"`
	// contains filtered or unexported fields
}

func NewScopedUserRole ¶ added in v1.7.17 

func NewScopedUserRole(userRoleId string) *ScopedUserRole

func (*ScopedUserRole) GetID ¶ added in v1.7.15 

func (r *ScopedUserRole) GetID() string

GetID returns the ID value of the resource. 

func (r *ScopedUserRole) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ScopedUserRole) GetModifiedBy ¶ added in v1.7.15 

func (r *ScopedUserRole) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ScopedUserRole) GetModifiedOn ¶ added in v1.7.15 

func (r *ScopedUserRole) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ScopedUserRole) Validate ¶ added in v1.7.15 

func (r *ScopedUserRole) Validate() error

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

type ScopedUserRoles ¶ added in v1.7.15 

type ScopedUserRoles struct {
	Items []*ScopedUserRole `json:"Items"`
	PagedResults
}

type ScopedUserRolesQuery ¶ added in v1.7.0 

type ScopedUserRolesQuery struct {
	IDs           []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IncludeSystem bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	PartialName   string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip          int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Spaces        []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	Take          int      `uri:"take,omitempty" url:"take,omitempty"`
}

type SearchPackagesQuery ¶ added in v1.7.0 

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"`
}

type SelectedPackage ¶ added in v1.7.0 

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

type SensitiveValue ¶ 

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

func NewSensitiveValue ¶ added in v1.7.0 

func NewSensitiveValue(newValue string) *SensitiveValue

NewSensitiveValue creates and initializes a sensitive value.

type ServerStatus ¶ added in v1.7.14 

type ServerStatus struct {
	IsDatabaseEncrypted                     bool   `json:"IsDatabaseEncrypted,omitempty"`
	IsMajorMinorUpgrade                     bool   `json:"IsMajorMinorUpgrade,omitempty"`
	IsInMaintenanceMode                     bool   `json:"IsInMaintenanceMode,omitempty"`
	IsUpgradeAvailable                      bool   `json:"IsUpgradeAvailable,omitempty"`
	MaintenanceExpires                      string `json:"MaintenanceExpires,omitempty"`
	MaximumAvailableVersion                 string `json:"MaximumAvailableVersion,omitempty"`
	MaximumAvailableVersionCoveredByLicense string `json:"MaximumAvailableVersionCoveredByLicense,omitempty"`
	// contains filtered or unexported fields
}

func (*ServerStatus) GetID ¶ added in v1.7.14 

func (r *ServerStatus) GetID() string

GetID returns the ID value of the resource. 

func (r *ServerStatus) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*ServerStatus) GetModifiedBy ¶ added in v1.7.14 

func (r *ServerStatus) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*ServerStatus) GetModifiedOn ¶ added in v1.7.14 

func (r *ServerStatus) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*ServerStatus) Validate ¶ added in v1.7.14 

func (r *ServerStatus) Validate() error

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

type SignInQuery ¶ added in v1.7.0 

type SignInQuery struct {
	ReturnURL string `uri:"returnUrl,omitempty" url:"returnUrl,omitempty"`
}

type SkipMachineBehavior ¶ added in v1.7.0 

type SkipMachineBehavior string

type Space ¶ added in v1.1.0 

type Space struct {
	Description              string   `json:"Description,omitempty"`
	IsDefault                bool     `json:"IsDefault,omitempty"`
	Name                     string   `json:"Name" validate:"required,max=20"`
	SpaceManagersTeamMembers []string `json:"SpaceManagersTeamMembers,omitempty"`
	SpaceManagersTeams       []string `json:"SpaceManagersTeams,omitempty"`
	TaskQueueStopped         bool     `json:"TaskQueueStopped,omitempty"`
	// contains filtered or unexported fields
}

func NewSpace ¶ added in v1.1.0 

func NewSpace(name string) *Space

NewSpace initializes a Space with a name.

func (*Space) GetID ¶ added in v1.7.0 

func (r *Space) GetID() string

GetID returns the ID value of the resource. 

func (r *Space) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Space) GetModifiedBy ¶ added in v1.7.0 

func (r *Space) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Space) GetModifiedOn ¶ added in v1.7.0 

func (r *Space) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Space) Validate ¶ added in v1.1.0 

func (s *Space) Validate() error

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

type SpaceHomeQuery ¶ added in v1.7.0 

type SpaceHomeQuery struct {
	SpaceID string `uri:"spaceId,omitempty" url:"spaceId,omitempty"`
}

type SpacePermissions ¶ added in v1.7.0 

type SpacePermissions struct {
	AccountCreate                     []UserPermissionRestriction `json:"AccountCreate"`
	AccountDelete                     []UserPermissionRestriction `json:"AccountDelete"`
	AccountEdit                       []UserPermissionRestriction `json:"AccountEdit"`
	AccountView                       []UserPermissionRestriction `json:"AccountView"`
	ActionTemplateCreate              []UserPermissionRestriction `json:"ActionTemplateCreate"`
	ActionTemplateDelete              []UserPermissionRestriction `json:"ActionTemplateDelete"`
	ActionTemplateEdit                []UserPermissionRestriction `json:"ActionTemplateEdit"`
	ActionTemplateView                []UserPermissionRestriction `json:"ActionTemplateView"`
	AdministerSystem                  []UserPermissionRestriction `json:"AdministerSystem"`
	ArtifactCreate                    []UserPermissionRestriction `json:"ArtifactCreate"`
	ArtifactDelete                    []UserPermissionRestriction `json:"ArtifactDelete"`
	ArtifactEdit                      []UserPermissionRestriction `json:"ArtifactEdit"`
	ArtifactView                      []UserPermissionRestriction `json:"ArtifactView"`
	BuildInformationAdminister        []UserPermissionRestriction `json:"BuildInformationAdminister"`
	BuildInformationPush              []UserPermissionRestriction `json:"BuildInformationPush"`
	BuiltInFeedAdminister             []UserPermissionRestriction `json:"BuiltInFeedAdminister"`
	BuiltInFeedDownload               []UserPermissionRestriction `json:"BuiltInFeedDownload"`
	BuiltInFeedPush                   []UserPermissionRestriction `json:"BuiltInFeedPush"`
	CertificateCreate                 []UserPermissionRestriction `json:"CertificateCreate"`
	CertificateDelete                 []UserPermissionRestriction `json:"CertificateDelete"`
	CertificateEdit                   []UserPermissionRestriction `json:"CertificateEdit"`
	CertificateExportPrivateKey       []UserPermissionRestriction `json:"CertificateExportPrivateKey"`
	CertificateView                   []UserPermissionRestriction `json:"CertificateView"`
	ConfigureServer                   []UserPermissionRestriction `json:"ConfigureServer"`
	DefectReport                      []UserPermissionRestriction `json:"DefectReport"`
	DefectResolve                     []UserPermissionRestriction `json:"DefectResolve"`
	DeploymentCreate                  []UserPermissionRestriction `json:"DeploymentCreate"`
	DeploymentDelete                  []UserPermissionRestriction `json:"DeploymentDelete"`
	DeploymentView                    []UserPermissionRestriction `json:"DeploymentView"`
	EnvironmentCreate                 []UserPermissionRestriction `json:"EnvironmentCreate"`
	EnvironmentDelete                 []UserPermissionRestriction `json:"EnvironmentDelete"`
	EnvironmentEdit                   []UserPermissionRestriction `json:"EnvironmentEdit"`
	EnvironmentView                   []UserPermissionRestriction `json:"EnvironmentView"`
	EventView                         []UserPermissionRestriction `json:"EventView"`
	FeedEdit                          []UserPermissionRestriction `json:"FeedEdit"`
	FeedView                          []UserPermissionRestriction `json:"FeedView"`
	InterruptionSubmit                []UserPermissionRestriction `json:"InterruptionSubmit"`
	InterruptionView                  []UserPermissionRestriction `json:"InterruptionView"`
	InterruptionViewSubmitResponsible []UserPermissionRestriction `json:"InterruptionViewSubmitResponsible"`
	LibraryVariableSetCreate          []UserPermissionRestriction `json:"LibraryVariableSetCreate"`
	LibraryVariableSetDelete          []UserPermissionRestriction `json:"LibraryVariableSetDelete"`
	LibraryVariableSetEdit            []UserPermissionRestriction `json:"LibraryVariableSetEdit"`
	LibraryVariableSetView            []UserPermissionRestriction `json:"LibraryVariableSetView"`
	LifecycleCreate                   []UserPermissionRestriction `json:"LifecycleCreate"`
	LifecycleDelete                   []UserPermissionRestriction `json:"LifecycleDelete"`
	LifecycleEdit                     []UserPermissionRestriction `json:"LifecycleEdit"`
	LifecycleView                     []UserPermissionRestriction `json:"LifecycleView"`
	MachineCreate                     []UserPermissionRestriction `json:"MachineCreate"`
	MachineDelete                     []UserPermissionRestriction `json:"MachineDelete"`
	MachineEdit                       []UserPermissionRestriction `json:"MachineEdit"`
	MachinePolicyCreate               []UserPermissionRestriction `json:"MachinePolicyCreate"`
	MachinePolicyDelete               []UserPermissionRestriction `json:"MachinePolicyDelete"`
	MachinePolicyEdit                 []UserPermissionRestriction `json:"MachinePolicyEdit"`
	MachinePolicyView                 []UserPermissionRestriction `json:"MachinePolicyView"`
	MachineView                       []UserPermissionRestriction `json:"MachineView"`
	ProcessEdit                       []UserPermissionRestriction `json:"ProcessEdit"`
	ProcessView                       []UserPermissionRestriction `json:"ProcessView"`
	ProjectCreate                     []UserPermissionRestriction `json:"ProjectCreate"`
	ProjectDelete                     []UserPermissionRestriction `json:"ProjectDelete"`
	ProjectEdit                       []UserPermissionRestriction `json:"ProjectEdit"`
	ProjectGroupCreate                []UserPermissionRestriction `json:"ProjectGroupCreate"`
	ProjectGroupDelete                []UserPermissionRestriction `json:"ProjectGroupDelete"`
	ProjectGroupEdit                  []UserPermissionRestriction `json:"ProjectGroupEdit"`
	ProjectGroupView                  []UserPermissionRestriction `json:"ProjectGroupView"`
	ProjectView                       []UserPermissionRestriction `json:"ProjectView"`
	ProxyCreate                       []UserPermissionRestriction `json:"ProxyCreate"`
	ProxyDelete                       []UserPermissionRestriction `json:"ProxyDelete"`
	ProxyEdit                         []UserPermissionRestriction `json:"ProxyEdit"`
	ProxyView                         []UserPermissionRestriction `json:"ProxyView"`
	ReleaseCreate                     []UserPermissionRestriction `json:"ReleaseCreate"`
	ReleaseDelete                     []UserPermissionRestriction `json:"ReleaseDelete"`
	ReleaseEdit                       []UserPermissionRestriction `json:"ReleaseEdit"`
	ReleaseView                       []UserPermissionRestriction `json:"ReleaseView"`
	RunbookEdit                       []UserPermissionRestriction `json:"RunbookEdit"`
	RunbookRunCreate                  []UserPermissionRestriction `json:"RunbookRunCreate"`
	RunbookRunDelete                  []UserPermissionRestriction `json:"RunbookRunDelete"`
	RunbookRunView                    []UserPermissionRestriction `json:"RunbookRunView"`
	RunbookView                       []UserPermissionRestriction `json:"RunbookView"`
	SpaceCreate                       []UserPermissionRestriction `json:"SpaceCreate"`
	SpaceDelete                       []UserPermissionRestriction `json:"SpaceDelete"`
	SpaceEdit                         []UserPermissionRestriction `json:"SpaceEdit"`
	SpaceView                         []UserPermissionRestriction `json:"SpaceView"`
	SubscriptionCreate                []UserPermissionRestriction `json:"SubscriptionCreate"`
	SubscriptionDelete                []UserPermissionRestriction `json:"SubscriptionDelete"`
	SubscriptionEdit                  []UserPermissionRestriction `json:"SubscriptionEdit"`
	SubscriptionView                  []UserPermissionRestriction `json:"SubscriptionView"`
	TagSetCreate                      []UserPermissionRestriction `json:"TagSetCreate"`
	TagSetDelete                      []UserPermissionRestriction `json:"TagSetDelete"`
	TagSetEdit                        []UserPermissionRestriction `json:"TagSetEdit"`
	TaskCancel                        []UserPermissionRestriction `json:"TaskCancel"`
	TaskCreate                        []UserPermissionRestriction `json:"TaskCreate"`
	TaskEdit                          []UserPermissionRestriction `json:"TaskEdit"`
	TaskView                          []UserPermissionRestriction `json:"TaskView"`
	TeamCreate                        []UserPermissionRestriction `json:"TeamCreate"`
	TeamDelete                        []UserPermissionRestriction `json:"TeamDelete"`
	TeamEdit                          []UserPermissionRestriction `json:"TeamEdit"`
	TeamView                          []UserPermissionRestriction `json:"TeamView"`
	TenantCreate                      []UserPermissionRestriction `json:"TenantCreate"`
	TenantDelete                      []UserPermissionRestriction `json:"TenantDelete"`
	TenantEdit                        []UserPermissionRestriction `json:"TenantEdit"`
	TenantView                        []UserPermissionRestriction `json:"TenantView"`
	TriggerCreate                     []UserPermissionRestriction `json:"TriggerCreate"`
	TriggerDelete                     []UserPermissionRestriction `json:"TriggerDelete"`
	TriggerEdit                       []UserPermissionRestriction `json:"TriggerEdit"`
	TriggerView                       []UserPermissionRestriction `json:"TriggerView"`
	UserEdit                          []UserPermissionRestriction `json:"UserEdit"`
	UserInvite                        []UserPermissionRestriction `json:"UserInvite"`
	UserRoleEdit                      []UserPermissionRestriction `json:"UserRoleEdit"`
	UserRoleView                      []UserPermissionRestriction `json:"UserRoleView"`
	UserView                          []UserPermissionRestriction `json:"UserView"`
	VariableEdit                      []UserPermissionRestriction `json:"VariableEdit"`
	VariableEditUnscoped              []UserPermissionRestriction `json:"VariableEditUnscoped"`
	VariableView                      []UserPermissionRestriction `json:"VariableView"`
	VariableViewUnscoped              []UserPermissionRestriction `json:"VariableViewUnscoped"`
	WorkerEdit                        []UserPermissionRestriction `json:"WorkerEdit"`
	WorkerView                        []UserPermissionRestriction `json:"WorkerView"`
}

type Spaces ¶ added in v1.1.0 

type Spaces struct {
	Items []*Space `json:"Items"`
	PagedResults
}

type SpacesQuery ¶ added in v1.7.0 

type SpacesQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Name        string   `uri:"name,omitempty" url:"name,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 StaticWorkerPool ¶ added in v1.7.0 

type StaticWorkerPool struct {
	WorkerPoolType WorkerPoolType `json:"WorkerPoolType"`

	WorkerPool
}

func NewStaticWorkerPool ¶ added in v1.7.0 

func NewStaticWorkerPool(name string) (*StaticWorkerPool, error)

NewStaticWorkerPool creates and initializes a static worker pool.

func (*StaticWorkerPool) GetID ¶ added in v1.7.0 

func (r *StaticWorkerPool) GetID() string

GetID returns the ID value of the resource.

func (*StaticWorkerPool) GetIsDefault ¶ added in v1.7.0 

func (s *StaticWorkerPool) GetIsDefault() bool
func (r *StaticWorkerPool) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*StaticWorkerPool) GetModifiedBy ¶ added in v1.7.0 

func (r *StaticWorkerPool) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*StaticWorkerPool) GetModifiedOn ¶ added in v1.7.0 

func (r *StaticWorkerPool) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*StaticWorkerPool) GetWorkerPoolType ¶ added in v1.7.0 

func (s *StaticWorkerPool) GetWorkerPoolType() WorkerPoolType

GetWorkerPoolType returns the worker type for this worker pool.

func (*StaticWorkerPool) Validate ¶ added in v1.7.0 

func (s *StaticWorkerPool) Validate() error

Validate checks the state of the static worker pool and returns an error if invalid.

type StaticWorkerPools ¶ added in v1.7.0 

type StaticWorkerPools struct {
	Items []*StaticWorkerPool `json:"Items"`
	PagedResults
}

type StepUsage ¶ added in v1.7.0 

type StepUsage struct {
	ProjectID   string            `json:"ProjectId,omitempty"`
	ProjectName string            `json:"ProjectName,omitempty"`
	ProjectSlug string            `json:"ProjectSlug,omitempty"`
	Steps       []*StepUsageEntry `json:"Steps"`
}

type StepUsageEntry ¶ added in v1.7.0 

type StepUsageEntry struct {
	StepID   string `json:"StepId,omitempty"`
	StepName string `json:"StepName,omitempty"`
}

type SubscriptionsQuery ¶ added in v1.7.0 

type SubscriptionsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Spaces      []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}

type Tag ¶ 

type Tag struct {
	ID               string `json:"Id,omitempty"`
	Name             string `json:"Name,omitempty"`
	Color            string `json:"Color,omitempty"`
	CanonicalTagName string `json:"CanonicalTagName,omitempty"`
	Description      string `json:"Description,omitempty"`
	SortOrder        int    `json:"SortOrder"`
}

type TagSet ¶ 

type TagSet struct {
	Description string `json:"Description,omitempty"`
	Name        string `json:"Name"`
	SortOrder   int32  `json:"SortOrder,omitempty"`
	SpaceID     string `json:"SpaceId,omitempty"`
	Tags        []Tag  `json:"Tags,omitempty"`
	// contains filtered or unexported fields
}

func NewTagSet ¶ 

func NewTagSet(name string) *TagSet

NewTagSet initializes a TagSet with a name.

func (*TagSet) GetID ¶ added in v1.7.0 

func (r *TagSet) GetID() string

GetID returns the ID value of the resource. 

func (r *TagSet) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*TagSet) GetModifiedBy ¶ added in v1.7.0 

func (r *TagSet) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*TagSet) GetModifiedOn ¶ added in v1.7.0 

func (r *TagSet) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*TagSet) Validate ¶ 

func (r *TagSet) Validate() error

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

type TagSets ¶ 

type TagSets struct {
	Items []*TagSet `json:"Items"`
	PagedResults
}

type TagSetsQuery ¶ added in v1.7.0 

type TagSetsQuery struct {
	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 TargetUsageEntry ¶ added in v1.7.0 

type TargetUsageEntry struct {
	TargetID   string `json:"TargetId,omitempty"`
	TargetName string `json:"TargetName,omitempty"`
}

type TasksQuery ¶ added in v1.7.0 

type TasksQuery struct {
	Environment             string   `uri:"environment,omitempty" url:"environment,omitempty"`
	HasPendingInterruptions bool     `uri:"hasPendingInterruptions,omitempty" url:"hasPendingInterruptions,omitempty"`
	HasWarningsOrErrors     bool     `uri:"hasWarningsOrErrors,omitempty" url:"hasWarningsOrErrors,omitempty"`
	IDs                     []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IncludeSystem           bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	IsActive                bool     `uri:"active,omitempty" url:"active,omitempty"`
	IsRunning               bool     `uri:"running,omitempty" url:"running,omitempty"`
	Name                    string   `uri:"name,omitempty" url:"name,omitempty"`
	Node                    string   `uri:"node,omitempty" url:"node,omitempty"`
	PartialName             string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Project                 string   `uri:"project,omitempty" url:"project,omitempty"`
	Runbook                 string   `uri:"runbook,omitempty" url:"runbook,omitempty"`
	Skip                    int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Spaces                  []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	States                  []string `uri:"states,omitempty" url:"states,omitempty"`
	Take                    int      `uri:"take,omitempty" url:"take,omitempty"`
	Tenant                  string   `uri:"tenant,omitempty" url:"tenant,omitempty"`
}

type Team ¶ added in v1.7.0 

type Team struct {
	CanBeDeleted           bool                 `json:"CanBeDeleted,omitempty"`
	CanBeRenamed           bool                 `json:"CanBeRenamed,omitempty"`
	CanChangeMembers       bool                 `json:"CanChangeMembers,omitempty"`
	CanChangeRoles         bool                 `json:"CanChangeRoles,omitempty"`
	Description            string               `json:"Description,omitempty"`
	ExternalSecurityGroups []NamedReferenceItem `json:"ExternalSecurityGroups,omitempty"`
	MemberUserIDs          []string             `json:"MemberUserIds"`
	Name                   string               `json:"Name" validate:"required"`
	SpaceID                string               `json:"SpaceId,omitempty"`
	// contains filtered or unexported fields
}

func NewTeam ¶ added in v1.7.0 

func NewTeam(name string) *Team

func (*Team) GetID ¶ added in v1.7.0 

func (r *Team) GetID() string

GetID returns the ID value of the resource. 

func (r *Team) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Team) GetModifiedBy ¶ added in v1.7.0 

func (r *Team) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Team) GetModifiedOn ¶ added in v1.7.0 

func (r *Team) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Team) Validate ¶ added in v1.7.0 

func (t *Team) Validate() error

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

type TeamMembershipQuery ¶ added in v1.7.0 

type TeamMembershipQuery struct {
	IncludeSystem bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	Spaces        []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	UserID        string   `uri:"userId,omitempty" url:"userId,omitempty"`
}

type Teams ¶ added in v1.7.0 

type Teams struct {
	Items []*Team `json:"Items"`
	PagedResults
}

Teams defines a collection of teams with built-in support for paged results.

type TeamsQuery ¶ added in v1.7.0 

type TeamsQuery struct {
	IDs           []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IncludeSystem bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	PartialName   string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip          int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Spaces        []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
	Take          int      `uri:"take,omitempty" url:"take,omitempty"`
}

type Tenant ¶ added in v1.7.0 

type Tenant struct {
	ClonedFromTenantID  string              `json:"ClonedFromTenantId"`
	Description         string              `json:"Description"`
	Name                string              `json:"Name" validate:"required"`
	ProjectEnvironments map[string][]string `json:"ProjectEnvironments,omitempty"`
	SpaceID             string              `json:"SpaceId"`
	TenantTags          []string            `json:"TenantTags,omitempty"`
	// contains filtered or unexported fields
}

func NewTenant ¶ added in v1.7.0 

func NewTenant(name string) *Tenant

NewTenant initializes a Tenant with a name.

func (*Tenant) GetID ¶ added in v1.7.0 

func (r *Tenant) GetID() string

GetID returns the ID value of the resource. 

func (r *Tenant) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Tenant) GetModifiedBy ¶ added in v1.7.0 

func (r *Tenant) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Tenant) GetModifiedOn ¶ added in v1.7.0 

func (r *Tenant) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (Tenant) Validate ¶ added in v1.7.0 

func (t Tenant) Validate() error

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

type TenantVariables ¶ added in v1.7.25 

type TenantVariables struct {
	LibraryVariables map[string]LibraryVariable `json:"LibraryVariables,omitempty"`
	ProjectVariables map[string]ProjectVariable `json:"ProjectVariables,omitempty"`
	SpaceID          string                     `json:"SpaceId,omitempty"`
	TenantID         string                     `json:"TenantId,omitempty"`
	TenantName       string                     `json:"TenantName,omitempty"`
	// contains filtered or unexported fields
}

func NewTenantVariables ¶ added in v1.7.25 

func NewTenantVariables(tenantID string) *TenantVariables

func (*TenantVariables) GetID ¶ added in v1.7.25 

func (r *TenantVariables) GetID() string

GetID returns the ID value of the resource. 

func (r *TenantVariables) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*TenantVariables) GetModifiedBy ¶ added in v1.7.25 

func (r *TenantVariables) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*TenantVariables) GetModifiedOn ¶ added in v1.7.25 

func (r *TenantVariables) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*TenantVariables) Validate ¶ added in v1.7.25 

func (r *TenantVariables) Validate() error

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

type TenantVariablesQuery ¶ added in v1.7.0 

type TenantVariablesQuery struct {
	ProjectID string `uri:"projectId,omitempty" url:"projectId,omitempty"`
}

type TenantedDeploymentMode ¶ added in v1.6.0 

type TenantedDeploymentMode string

type Tenants ¶ added in v1.7.0 

type Tenants struct {
	Items []*Tenant `json:"Items"`
	PagedResults
}

type TenantsMissingVariables ¶ added in v1.7.24 

type TenantsMissingVariables struct {
	Links            map[string]string `json:"Links,omitempty"`
	MissingVariables []MissingVariable `json:"MissingVariables,omitempty"`
	TenantID         string            `json:"TenantId,omitempty"`
}

type TenantsMissingVariablesQuery ¶ added in v1.7.0 

type TenantsMissingVariablesQuery struct {
	EnvironmentID  []string `uri:"environmentId,omitempty" url:"environmentId,omitempty"`
	IncludeDetails bool     `uri:"includeDetails,omitempty" url:"includeDetails,omitempty"`
	ProjectID      string   `uri:"projectId,omitempty" url:"projectId,omitempty"`
	TenantID       string   `uri:"tenantId,omitempty" url:"tenantId,omitempty"`
}

type TenantsQuery ¶ added in v1.7.0 

type TenantsQuery struct {
	ClonedFromTenantID string   `uri:"clonedFromTenantId,omitempty" url:"clonedFromTenantId,omitempty"`
	IDs                []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsClone            bool     `uri:"clone,omitempty" url:"clone,omitempty"`
	Name               string   `uri:"name,omitempty" url:"name,omitempty"`
	PartialName        string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	ProjectID          string   `uri:"projectId,omitempty" url:"projectId,omitempty"`
	Skip               int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Tags               []string `uri:"tags,omitempty" url:"tags,omitempty"`
	Take               int      `uri:"take,omitempty" url:"take,omitempty"`
}

type TentacleVersionDetails ¶ added in v1.7.0 

type TentacleVersionDetails struct {
	UpgradeLocked    bool    `json:"UpgradeLocked"`
	UpgradeSuggested bool    `json:"UpgradeSuggested"`
	UpgradeRequired  bool    `json:"UpgradeRequired"`
	Version          *string `json:"Version"`
}

func NewTentacleVersionDetails ¶ added in v1.7.0 

func NewTentacleVersionDetails(version *string, upgradeLocked bool, upgradeSuggested bool, upgradeRequired bool) *TentacleVersionDetails

NewTentacleVersionDetails creates and initializes tentacle version details.

type TokenAccount ¶ added in v1.7.0 

type TokenAccount struct {
	Token *SensitiveValue `json:"Token,omitempty" validate:"required"`
	// contains filtered or unexported fields
}

TokenAccount represents a token account.

func NewTokenAccount ¶ added in v1.7.0 

func NewTokenAccount(name string, token *SensitiveValue, options ...func(*TokenAccount)) (*TokenAccount, error)

NewTokenAccount creates and initializes a token account with a name and token.

func (*TokenAccount) GetAccountType ¶ added in v1.7.0 

func (a *TokenAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*TokenAccount) GetDescription ¶ added in v1.7.0 

func (a *TokenAccount) GetDescription() string

GetDescription returns the description of the account.

func (*TokenAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *TokenAccount) GetEnvironmentIDs() []string

func (*TokenAccount) GetName ¶ added in v1.7.0 

func (a *TokenAccount) GetName() string

GetName returns the name of the account.

func (*TokenAccount) GetSpaceID ¶ added in v1.7.0 

func (a *TokenAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*TokenAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *TokenAccount) GetTenantIDs() []string

func (*TokenAccount) GetTenantTags ¶ added in v1.7.0 

func (a *TokenAccount) GetTenantTags() []string

func (*TokenAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *TokenAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*TokenAccount) SetDescription ¶ added in v1.7.0 

func (a *TokenAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*TokenAccount) SetName ¶ added in v1.7.0 

func (a *TokenAccount) SetName(name string)

SetName sets the name of the account.

func (*TokenAccount) SetSpaceID ¶ added in v1.7.0 

func (a *TokenAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*TokenAccount) Validate ¶ added in v1.7.0 

func (t *TokenAccount) Validate() error

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

type TriggerAction ¶ added in v1.7.0 

type TriggerAction struct {
	ActionType string `json:"ActionType" validate:"required,oneof=AutoDeploy DeployLatestRelease DeployNewRelease RunRunbook"`
	// contains filtered or unexported fields
}

func NewTriggerAction ¶ added in v1.7.0 

func NewTriggerAction() *TriggerAction

func (*TriggerAction) GetID ¶ added in v1.7.0 

func (r *TriggerAction) GetID() string

GetID returns the ID value of the resource. 

func (r *TriggerAction) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*TriggerAction) GetModifiedBy ¶ added in v1.7.0 

func (r *TriggerAction) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*TriggerAction) GetModifiedOn ¶ added in v1.7.0 

func (r *TriggerAction) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*TriggerAction) Validate ¶ added in v1.7.0 

func (r *TriggerAction) Validate() error

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

type TypeMetadata ¶ added in v1.7.0 

type TypeMetadata struct {
	Name       string              `json:"Name,omitempty"`
	Properties []*PropertyMetadata `json:"Properties"`
}

func NewTypeMetadata ¶ added in v1.7.0 

func NewTypeMetadata() *TypeMetadata

type User ¶ 

type User struct {
	CanPasswordBeEdited bool       `json:"CanPasswordBeEdited,omitempty"`
	DisplayName         string     `json:"DisplayName,omitempty"`
	EmailAddress        string     `json:"EmailAddress,omitempty"`
	Identities          []Identity `json:"Identities,omitempty"`
	IsActive            bool       `json:"IsActive,omitempty"`
	IsRequestor         bool       `json:"IsRequestor,omitempty"`
	IsService           bool       `json:"IsService,omitempty"`
	Password            string     `json:"Password,omitempty" validate:"max=20"`
	Username            string     `json:"Username,omitempty"`
	// contains filtered or unexported fields
}

User represents a user in Octopus.

func NewUser ¶ added in v1.7.0 

func NewUser(username string, displayName string) *User

NewUser initializes a user with an username and a display name.

func (*User) GetID ¶ added in v1.7.0 

func (r *User) GetID() string

GetID returns the ID value of the resource. 

func (r *User) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*User) GetModifiedBy ¶ added in v1.7.0 

func (r *User) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*User) GetModifiedOn ¶ added in v1.7.0 

func (r *User) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*User) Validate ¶ added in v1.7.0 

func (r *User) Validate() error

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

type UserAuthentication ¶ added in v1.7.0 

type UserAuthentication struct {
	AuthenticationProviders             []AuthenticationProviderElement
	CanCurrentUserEditIdentitiesForUser bool
	Links                               map[string]string
}

UserAuthentication represents enabled authentication providers and whether the current user can edit logins for the given user.

type UserPermissionRestriction ¶ added in v1.7.0 

type UserPermissionRestriction struct {
	RestrictedToEnvironmentIds  []string `json:"RestrictedToEnvironmentIds"`
	RestrictedToProjectGroupIds []string `json:"RestrictedToProjectGroupIds"`
	RestrictedToProjectIds      []string `json:"RestrictedToProjectIds"`
	RestrictedToTenantIds       []string `json:"RestrictedToTenantIds"`
	SpaceID                     string   `json:"SpaceId,omitempty"`
}

type UserPermissionSet ¶ added in v1.7.0 

type UserPermissionSet struct {
	ID                    string                           `json:"Id"`
	IsPermissionsComplete bool                             `json:"IsPermissionsComplete,omitempty"`
	IsTeamsComplete       bool                             `json:"IsTeamsComplete,omitempty"`
	Links                 map[string]string                `json:"Links,omitempty"`
	SpacePermissions      SpacePermissions                 `json:"SpacePermissions,omitempty"`
	SystemPermissions     []string                         `json:"SystemPermissions"`
	Teams                 []ProjectedTeamReferenceDataItem `json:"Teams"`
}

type UserQuery ¶ added in v1.7.0 

type UserQuery struct {
	IncludeSystem bool     `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
	Spaces        []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
}

type UserRole ¶ added in v1.7.2 

type UserRole struct {
	CanBeDeleted                 bool     `json:"CanBeDeleted,omitempty"`
	Description                  string   `json:"Description,omitempty"`
	GrantedSpacePermissions      []string `json:"GrantedSpacePermissions"`
	GrantedSystemPermissions     []string `json:"GrantedSystemPermissions"`
	Name                         string   `json:"Name,omitempty"`
	SpacePermissionDescriptions  []string `json:"SpacePermissionDescriptions"`
	SupportedRestrictions        []string `json:"SupportedRestrictions"`
	SystemPermissionDescriptions []string `json:"SystemPermissionDescriptions"`
	// contains filtered or unexported fields
}

UserRole represents a user role in Octopus.

func NewUserRole ¶ added in v1.7.4 

func NewUserRole(name string) *UserRole

NewUserRole initializes a user role with a name.

func (*UserRole) GetID ¶ added in v1.7.2 

func (r *UserRole) GetID() string

GetID returns the ID value of the resource. 

func (r *UserRole) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*UserRole) GetModifiedBy ¶ added in v1.7.2 

func (r *UserRole) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*UserRole) GetModifiedOn ¶ added in v1.7.2 

func (r *UserRole) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*UserRole) Validate ¶ added in v1.7.2 

func (r *UserRole) Validate() error

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

type UserRoles ¶ added in v1.7.2 

type UserRoles struct {
	Items []*UserRole `json:"Items"`
	PagedResults
}

UserRoles defines a collection of user roles with built-in support for paged results.

type UserRolesQuery ¶ added in v1.7.0 

type UserRolesQuery struct {
	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 UsernamePasswordAccount ¶ added in v1.7.0 

type UsernamePasswordAccount struct {
	Username string
	Password *SensitiveValue
	// contains filtered or unexported fields
}

UsernamePasswordAccount represents a username/password account.

func NewUsernamePasswordAccount ¶ added in v1.7.0 

func NewUsernamePasswordAccount(name string, options ...func(*UsernamePasswordAccount)) (*UsernamePasswordAccount, error)

NewUsernamePasswordAccount creates and initializes a username/password account with a name.

func (*UsernamePasswordAccount) GetAccountType ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetAccountType() AccountType

GetAccountType returns the type of this account.

func (*UsernamePasswordAccount) GetDescription ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetDescription() string

GetDescription returns the description of the account.

func (*UsernamePasswordAccount) GetEnvironmentIDs ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetEnvironmentIDs() []string

func (*UsernamePasswordAccount) GetName ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetName() string

GetName returns the name of the account.

func (*UsernamePasswordAccount) GetSpaceID ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetSpaceID() string

GetSpaceID returns the space ID of this account.

func (*UsernamePasswordAccount) GetTenantIDs ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetTenantIDs() []string

func (*UsernamePasswordAccount) GetTenantTags ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetTenantTags() []string

func (*UsernamePasswordAccount) GetTenantedDeploymentMode ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) GetTenantedDeploymentMode() TenantedDeploymentMode

func (*UsernamePasswordAccount) SetDescription ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) SetDescription(description string)

SetDescription sets the description of the account.

func (*UsernamePasswordAccount) SetName ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) SetName(name string)

SetName sets the name of the account.

func (*UsernamePasswordAccount) SetSpaceID ¶ added in v1.7.0 

func (a *UsernamePasswordAccount) SetSpaceID(spaceID string)

SetSpaceID sets the space ID of this account.

func (*UsernamePasswordAccount) Validate ¶ added in v1.7.0 

func (u *UsernamePasswordAccount) Validate() error

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

type Users ¶ added in v1.7.0 

type Users struct {
	Items []*User `json:"Items"`
	PagedResults
}

Users defines a collection of users with built-in support for paged results.

type UsersQuery ¶ added in v1.7.0 

type UsersQuery struct {
	Filter string   `uri:"filter,omitempty" url:"filter,omitempty"`
	IDs    []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Skip   int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take   int      `uri:"take,omitempty" url:"take,omitempty"`
}

type Variable ¶ 

type Variable struct {
	Description string                 `json:"Description"`
	IsEditable  bool                   `json:"IsEditable"`
	IsSensitive bool                   `json:"IsSensitive"`
	Name        string                 `json:"Name"`
	Prompt      *VariablePromptOptions `json:"Prompt,omitempty"`
	Scope       VariableScope          `json:"Scope"`
	Type        string                 `json:"Type"`
	Value       string                 `json:"Value"`
	// contains filtered or unexported fields
}

func NewVariable ¶ 

func NewVariable(name string) *Variable

func (*Variable) GetID ¶ added in v1.7.0 

func (r *Variable) GetID() string

GetID returns the ID value of the resource. 

func (r *Variable) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*Variable) GetModifiedBy ¶ added in v1.7.0 

func (r *Variable) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*Variable) GetModifiedOn ¶ added in v1.7.0 

func (r *Variable) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*Variable) Validate ¶ 

func (r *Variable) Validate() error

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

type VariableNamesQuery ¶ added in v1.7.0 

type VariableNamesQuery struct {
	Project                   string `uri:"project,omitempty" url:"project,omitempty"`
	ProjectEnvironmentsFilter string `uri:"projectEnvironmentsFilter,omitempty" url:"projectEnvironmentsFilter,omitempty"`
	Runbook                   string `uri:"runbook,omitempty" url:"runbook,omitempty"`
}

type VariablePreviewQuery ¶ added in v1.7.0 

type VariablePreviewQuery struct {
	Action      string `uri:"action,omitempty" url:"action,omitempty"`
	Channel     string `uri:"channel,omitempty" url:"channel,omitempty"`
	Environment string `uri:"environment,omitempty" url:"environment,omitempty"`
	Machine     string `uri:"machine,omitempty" url:"machine,omitempty"`
	Project     string `uri:"project,omitempty" url:"project,omitempty"`
	Role        string `uri:"role,omitempty" url:"role,omitempty"`
	Runbook     string `uri:"runbook,omitempty" url:"runbook,omitempty"`
	Tenant      string `uri:"tenant,omitempty" url:"tenant,omitempty"`
}

type VariablePromptOptions ¶ 

type VariablePromptOptions struct {
	Label       string `json:"Label"`
	Description string `json:"Description"`
	Required    bool   `json:"Required"`
}

type VariableScope ¶ 

type VariableScope struct {
	Environments []string `json:"Environment,omitempty"`
	Machines     []string `json:"Machine,omitempty"`
	Actions      []string `json:"Action,omitempty"`
	Roles        []string `json:"Role,omitempty"`
	Channels     []string `json:"Channel,omitempty"`
	TenantTags   []string `json:"TenantTag,omitempty"`
}

func (VariableScope) IsEmpty ¶ added in v1.7.17 

func (scope VariableScope) IsEmpty() bool

type VariableScopeValues ¶ added in v1.7.0 

type VariableScopeValues struct {
	Actions      []*ReferenceDataItem        `json:"Actions"`
	Channels     []*ReferenceDataItem        `json:"Channels"`
	Environments []*ReferenceDataItem        `json:"Environments"`
	Machines     []*ReferenceDataItem        `json:"Machines"`
	Processes    []*ProcessReferenceDataItem `json:"Processes"`
	Roles        []*ReferenceDataItem        `json:"Roles"`
	TenantTags   []*ReferenceDataItem        `json:"TenantTags"`
}

type VariableSet ¶ added in v1.7.0 

type VariableSet struct {
	OwnerID     string               `json:"OwnerId,omitempty"`
	ScopeValues *VariableScopeValues `json:"ScopeValues,omitempty"`
	SpaceID     string               `json:"SpaceId,omitempty"`
	Variables   []*Variable          `json:"Variables"`
	Version     int32                `json:"Version,omitempty"`
	// contains filtered or unexported fields
}

func NewVariableSet ¶ added in v1.7.0 

func NewVariableSet() *VariableSet

func (*VariableSet) GetID ¶ added in v1.7.0 

func (r *VariableSet) GetID() string

GetID returns the ID value of the resource. 

func (r *VariableSet) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*VariableSet) GetModifiedBy ¶ added in v1.7.0 

func (r *VariableSet) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*VariableSet) GetModifiedOn ¶ added in v1.7.0 

func (r *VariableSet) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*VariableSet) Validate ¶ added in v1.7.0 

func (r *VariableSet) Validate() error

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

type VariablesQuery ¶ added in v1.7.0 

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

type VersionControlSettings ¶ added in v1.7.0 

type VersionControlSettings struct {
	BasePath      string          `json:"BasePath,omitempty"`
	DefaultBranch string          `json:"DefaultBranch,omitempty"`
	HasValue      bool            `json:"HasValue,omitempty"`
	Password      *SensitiveValue `json:"Password,omitempty"`
	URL           string          `json:"Url,omitempty"`
	Username      string          `json:"Username,omitempty"`
}

type VersionRuleTestQuery ¶ added in v1.7.0 

type VersionRuleTestQuery struct {
	FeetType      string `uri:"feetType,omitempty" url:"feetType,omitempty"`
	PreReleaseTag string `uri:"preReleaseTag,omitempty" url:"preReleaseTag,omitempty"`
	Version       string `uri:"version,omitempty" url:"version,omitempty"`
	VersionRange  string `uri:"versionRange,omitempty" url:"versionRange,omitempty"`
}

type VersioningStrategy ¶ 

type VersioningStrategy struct {
	DonorPackage       *DeploymentActionPackage `json:"DonorPackage,omitempty"`
	DonorPackageStepID *string                  `json:"DonorPackageStepId,omitempty"`
	Template           string                   `json:"Template,omitempty"`
}
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

type Worker ¶ added in v1.7.0 

type Worker struct {
	SpaceID       string   `json:"SpaceId,omitempty"`
	WorkerPoolIDs []string `json:"WorkerPoolIds,omitempty"`
	// contains filtered or unexported fields
}

func NewWorker ¶ added in v1.7.0 

func NewWorker(name string, endpoint IEndpoint) *Worker

func (*Worker) GetSpaceID ¶ added in v1.7.0 

func (w *Worker) GetSpaceID() string

GetSpaceID returns the space ID that is associated with this worker.

func (*Worker) MarshalJSON ¶ added in v1.7.0 

func (w *Worker) MarshalJSON() ([]byte, error)

MarshalJSON returns a worker as its JSON encoding.

func (*Worker) SetSpaceID ¶ added in v1.7.0 

func (w *Worker) SetSpaceID(spaceID string)

SetSpaceID sets the space ID that is associated with this worker.

func (*Worker) UnmarshalJSON ¶ added in v1.7.0 

func (w *Worker) UnmarshalJSON(b []byte) error

UnmarshalJSON sets this worker to its representation in JSON.

func (Worker) Validate ¶ added in v1.7.0 

func (m Worker) Validate() error

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

type WorkerPool ¶ added in v1.7.0 

type WorkerPool struct {
	CanAddWorkers bool   `json:"CanAddWorkers"`
	Description   string `json:"Description,omitempty"`
	IsDefault     bool   `json:"IsDefault"`
	Name          string `json:"Name" validate:"required,notblank"`
	SpaceID       string `json:"SpaceId,omitempty" validate:"omitempty,notblank"`
	SortOrder     int    `json:"SortOrder"`
	// contains filtered or unexported fields
}

WorkerPool is the embedded struct used for all worker pools.

func (*WorkerPool) GetID ¶ added in v1.7.0 

func (r *WorkerPool) GetID() string

GetID returns the ID value of the resource. 

func (r *WorkerPool) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*WorkerPool) GetModifiedBy ¶ added in v1.7.0 

func (r *WorkerPool) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*WorkerPool) GetModifiedOn ¶ added in v1.7.0 

func (r *WorkerPool) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*WorkerPool) GetName ¶ added in v1.7.0 

func (w *WorkerPool) GetName() string

GetName returns the name of the worker pool.

func (*WorkerPool) SetName ¶ added in v1.7.0 

func (w *WorkerPool) SetName(name string)

SetName sets the name of the worker pool.

func (*WorkerPool) Validate ¶ added in v1.7.0 

func (w *WorkerPool) Validate() error

Validate checks the state of the worker pool and returns an error if invalid.

type WorkerPoolResource ¶ added in v1.7.0 

type WorkerPoolResource struct {
	CanAddWorkers  bool           `json:"CanAddWorkers"`
	Description    string         `json:"Description,omitempty"`
	IsDefault      bool           `json:"IsDefault"`
	Name           string         `json:"Name" validate:"required,notblank"`
	SpaceID        string         `json:"SpaceId,omitempty" validate:"omitempty,notblank"`
	SortOrder      int            `json:"SortOrder"`
	WorkerPoolType WorkerPoolType `json:"WorkerPoolType"`
	WorkerType     WorkerType     `json:"WorkerType,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkerPoolResource) GetID ¶ added in v1.7.0 

func (r *WorkerPoolResource) GetID() string

GetID returns the ID value of the resource.

func (*WorkerPoolResource) GetIsDefault ¶ added in v1.7.0 

func (w *WorkerPoolResource) GetIsDefault() bool
func (r *WorkerPoolResource) GetLinks() map[string]string

GetLinks returns the associated links with the value of this resource.

func (*WorkerPoolResource) GetModifiedBy ¶ added in v1.7.0 

func (r *WorkerPoolResource) GetModifiedBy() string

GetModifiedBy returns the name of the account that modified the value of this resource.

func (*WorkerPoolResource) GetModifiedOn ¶ added in v1.7.0 

func (r *WorkerPoolResource) GetModifiedOn() *time.Time

GetModifiedOn returns the time when the value of this resource was changed.

func (*WorkerPoolResource) GetName ¶ added in v1.7.0 

func (w *WorkerPoolResource) GetName() string

GetName returns the name of the worker pool resource.

func (*WorkerPoolResource) GetWorkerPoolType ¶ added in v1.7.0 

func (w *WorkerPoolResource) GetWorkerPoolType() WorkerPoolType

GetWorkerPoolType returns the worker type for this worker pool resource.

func (*WorkerPoolResource) GetWorkerType ¶ added in v1.7.0 

func (w *WorkerPoolResource) GetWorkerType() WorkerType

GetWorkerType returns the worker type for this worker pool resource.

func (*WorkerPoolResource) SetName ¶ added in v1.7.0 

func (w *WorkerPoolResource) SetName(name string)

SetName sets the name of the worker pool resource.

func (*WorkerPoolResource) Validate ¶ added in v1.7.0 

func (w *WorkerPoolResource) Validate() error

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

type WorkerPoolResources ¶ added in v1.7.0 

type WorkerPoolResources struct {
	Items []*WorkerPoolResource `json:"Items"`
	PagedResults
}

type WorkerPoolType ¶ added in v1.7.0 

type WorkerPoolType string
const (
	WorkerPoolTypeDynamic WorkerPoolType = "DynamicWorkerPool"
	WorkerPoolTypeStatic  WorkerPoolType = "StaticWorkerPool"
)

type WorkerPools ¶ added in v1.7.0 

type WorkerPools struct {
	Items []IWorkerPool `json:"Items"`
	PagedResults
}

type WorkerPoolsQuery ¶ added in v1.7.0 

type WorkerPoolsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	Name        string   `uri:"name,omitempty" url:"name,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 WorkerPoolsSummaryQuery ¶ added in v1.7.0 

type WorkerPoolsSummaryQuery struct {
	CommunicationStyles  []string `uri:"commStyles,omitempty" url:"commStyles,omitempty"`
	HealthStatuses       []string `uri:"healthStatuses,omitempty" url:"healthStatuses,omitempty"`
	HideEmptyWorkerPools bool     `uri:"hideEmptyWorkerPools,omitempty" url:"hideEmptyWorkerPools,omitempty"`
	IDs                  []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsDisabled           bool     `uri:"isDisabled,omitempty" url:"isDisabled,omitempty"`
	MachinePartialName   string   `uri:"machinePartialName,omitempty" url:"machinePartialName,omitempty"`
	PartialName          string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	ShellNames           []string `uri:"shellNames,omitempty" url:"shellNames,omitempty"`
}

type WorkerType ¶ added in v1.7.0 

type WorkerType string
const (
	WorkerTypeUbuntu1804      WorkerType = "Ubuntu1804"
	WorkerTypeUbuntuDefault   WorkerType = "UbuntuDefault"
	WorkerTypeWindows2016     WorkerType = "Windows2016"
	WorkerTypeWindows2019     WorkerType = "Windows2019"
	WorkerTypeUWindowsDefault WorkerType = "WindowsDefault"
)

type Workers ¶ added in v1.7.0 

type Workers struct {
	Items []*Worker `json:"Items"`
	PagedResults
}

Workers defines a collection of workers with built-in support for paged results.

type WorkersQuery ¶ added in v1.7.0 

type WorkersQuery struct {
	CommunicationStyles []string `uri:"commStyles,omitempty" url:"commStyles,omitempty"`
	HealthStatuses      []string `uri:"healthStatuses,omitempty" url:"healthStatuses,omitempty"`
	IDs                 []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IsDisabled          bool     `uri:"isDisabled,omitempty" url:"isDisabled,omitempty"`
	Name                string   `uri:"name,omitempty" url:"name,omitempty"`
	PartialName         string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	ShellNames          []string `uri:"shellNames,omitempty" url:"shellNames,omitempty"`
	Skip                int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take                int      `uri:"take,omitempty" url:"take,omitempty"`
	Thumbprint          string   `uri:"thumbprint,omitempty" url:"thumbprint,omitempty"`
	WorkerPoolIDs       []string `uri:"workerPoolIds" url:"workerPoolIds,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.