APIErrorChecker is a generic error handler for the OctopusDeploy API.

GetFakeOctopusClient -.

LoadNextPage checks if the next page should be loaded from the API.

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

NewAccountUsage initializes an AccountUsage.

NewActionTemplate creates and initializes an action template.

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

NewAPIKey initializes an API key with a purpose.

NewArtifact creates and initializes an artifact.

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

NewAzureCloudServiceEndpoint creates and initializes a new Azure cloud service endpoint.

NewAzureServicePrincipalAccount creates and initializes an Azure service principal account.

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

NewAzureWebAppEndpoint creates a new endpoint for Azure web apps.

NewBuiltInFeed creates and initializes a built-in feed.

NewCertificateResource initializes a certificate resource with a name and credentials.

NewClient returns a new Octopus API client.

NewCloudRegionEndpoint creates and initializes a new cloud service endpoint.

NewCommunityActionTemplate initializes a community action template.

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

NewDeploymentAction initializes a DeploymentAction with a name.

NewDeploymentProcess initializes a deployment process.

NewDeploymentStep initializes a DeploymentStep with a name.

NewDockerContainerRegistry creates and initializes a Docker container registry.

NewDynamicWorkerPool creates and initializes a dynamic worker pool.

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

NewEnvironment initializes an Environment with a name.

NewGitHubRepositoryFeed creates and initializes a GitHub repository feed.

NewHelmFeed creates and initializes a Helm feed.

NewKubernetesAwsAuthentication creates and initializes a Kubernetes AWS authentication.

NewKubernetesAzureAuthentication creates and initializes a Kubernetes Azure authentication.

NewKubernetesCertificateAuthentication creates and initializes a Kubernetes certificate authentication.

NewKubernetesEndpoint creates and initializes a new Kubernetes endpoint.

NewKubernetesStandardAuthentication creates and initializes a Kubernetes AWS authentication.

NewMavenFeed creates and initializes a Maven feed.

NewNuGetFeed creates and initializes a NuGet feed.

NewOctopusProjectFeed creates and initializes a Octopus project feed.

NewRunbook creates and initializes a runbook.

NewRunbookProcess creates and initializes a runbook process.

NewSensitiveValue creates and initializes a sensitive value.

NewSpace initializes a Space with a name.

NewSSHEndpoint creates and initializes a new SSH endpoint.

NewSSHKeyAccount initializes and returns a SSH key pair account with a name, username, and private key file.

NewStaticWorkerPool creates and initializes a static worker pool.

NewTagSet initializes a TagSet with a name.

NewTenant initializes a Tenant with a name.

NewTentacleVersionDetails creates and initializes tentacle version details.

NewTokenAccount creates and initializes a token account with a name and token.

NewUser initializes a user with an username and a display name.

NewUsernamePasswordAccount creates and initializes a username/password account with a name.

NewUserRole initializes a user role with a name.

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

ValidateLibraryVariableSetValues checks the values of a library variable set to see if they are suitable for sending to Octopus Deploy.

ValidateMultipleProperties returns the first error in a list of property validations.

ValidatePropertiesMatch checks two values against each other.

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

ValidateRequiredPropertyValue returns an error if the property value is empty.

ValidateStringInSlice checks if a string is in the given slice.

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

ValidMachineStatuses provides options for valid machine status.

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

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

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

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

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

AccountsQuery represents parameters to query the Accounts service.

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

ActionTemplate represents an action template in Octopus Deploy.

ActionTemplateCategory represents an action template category.

ActionTemplateParameter represents an action template parameter.

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

ActionTemplateSearch represents an action template search.

ActionTemplatesQuery represents parameters to query the ActionTemplates service.

ActivityLogElement represents an activity log element.

ActivityLogEntry represents an activity log entry.

AmazonWebServicesAccount represents an Amazon Web Services (AWS) account.

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

APIKey represents an API key.

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

Artifact represents an artifact.

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

Authentication represents enabled authentication providers.

AuthenticationProviderElement represents an authentication provider element.

AutoDeployReleaseOverride represents an auto-deploy release override.

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

AzureCloudServiceEndpoint represents an Azure cloud service endpoint.

AzureServicePrincipalAccount represents an Azure service principal account.

AzureSubscriptionAccount represents an Azure subscription account.

AzureWebAppEndpoint represents the an Azure web app-based endpoint.

BuiltInFeed represents a built-in feed.

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

Client is an OctopusDeploy for making Octopus API requests.

CloudRegionEndpoint represents a cloud service endpoint.

CommunityActionTemplate represents a community action template in Octopus Deploy.

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

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

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

DockerContainerRegistry represents a Docker container registry.

Feed is the embedded struct used for all feeds.

GitHubRepositoryFeed represents a GitHub repository feed.

HelmFeed represents a Helm feed.

MavenFeed represents a Maven feed.

NuGetFeed represents a NuGet feed.

OctopusProjectFeed represents an Octopus project feed.

Releases defines a collection of Release instance with built-in support for paged results from the API.

RunbookProcess represents a deployment process.

RunbookProcesses defines a collection of runbooks processes with built-in support for paged results.

Runbooks defines a collection of runbooks with built-in support for paged results.

SSHEndpoint contains the information necessary to communicate with an SSH endpoint.

SSHKeyAccount represents a SSH key pair account.

Teams defines a collection of teams with built-in support for paged results.

TokenAccount represents a token account.

User represents a user in Octopus.

UserAuthentication represents enabled authentication providers and whether the current user can edit logins for the given user.

UsernamePasswordAccount represents a username/password account.

UserRole represents a user role in Octopus.

UserRoles defines a collection of user roles with built-in support for paged results.

Users defines a collection of users with built-in support for paged results.

WorkerPool is the embedded struct used for all worker pools.

Workers defines a collection of workers with built-in support for paged results.

IEndpoint defines the interface for all endpoints.

IResource defines the interface for all resources.

IRunsOnAWorker defines the interface for all workers.

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