# Functions

ActionTypeString retrieves an enum value from the enum constants string name.
ActionTypeValues returns all values of the enum.
APIErrorChecker is a generic error handler for the OctopusDeploy API.
No description provided by the author
DailyScheduledIntervalString retrieves an enum value from the enum constants string name.
DailyScheduledIntervalValues returns all values of the enum.
FilterTypeString retrieves an enum value from the enum constants string name.
FilterTypeValues returns all values of the enum.
No description provided by the author
GetFakeOctopusClient -.
No description provided by the author
No description provided by the author
LoadNextPage checks if the next page should be loaded from the API.
MonthlyScheduleString retrieves an enum value from the enum constants string name.
MonthlyScheduleValues returns all values of the enum.
NewAccount creates and initializes an account resource with a name and type.
NewAccountUsage initializes an AccountUsage.
NewActionTemplate creates and initializes an action template.
No description provided by the author
NewAmazonWebServicesAccount initializes and returns an AWS account with a name, access key, and secret key.
No description provided by the author
NewAPIKey initializes an API key with a purpose.
NewArtifact creates and initializes an artifact.
No description provided by the author
No description provided by the author
NewAwsElasticContainerRegistry creates and initializes an Amazon Web Services (AWS) Elastic Container Registry (ECR).
NewAzureCloudServiceEndpoint creates and initializes a new Azure cloud service endpoint.
No description provided by the author
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.
No description provided by the author
NewBuiltInFeed creates and initializes a built-in feed.
NewCertificateResource initializes a certificate resource with a name and credentials.
No description provided by the author
NewClient returns a new Octopus API client.
NewCloudRegionEndpoint creates and initializes a new cloud service endpoint.
No description provided by the author
No description provided by the author
NewCommunityActionTemplate initializes a community action template.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewDatabasePersistenceSettings creates an instance of database persistence settings.
No description provided by the author
No description provided by the author
No description provided by the author
NewDeployment initializes a deployment with a name, environment ID, and release ID.
NewDeploymentAction initializes a DeploymentAction with a name.
NewDeploymentActionContainer creates and initializes a new Kubernetes endpoint.
NewDeploymentProcess initializes a deployment process.
NewDeploymentStep initializes a DeploymentStep with a name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
NewGitHubRepositoryFeed creates and initializes a GitHub repository feed.
NewGitPersistenceSettings creates an instance of persistence settings.
NewGoogleCloudPlatformAccount initializes and returns a Google cloud account.
NewHelmFeed creates and initializes a Helm feed.
No description provided by the author
No description provided by the author
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.
NewKubernetesGcpAuthentication creates and initializes a Kubernetes GCP authentication.
NewKubernetesStandardAuthentication creates and initializes a Kubernetes authentication.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewMavenFeed creates and initializes a Maven feed.
No description provided by the author
No description provided by the author
NewNuGetFeed creates and initializes a NuGet feed.
NewOctopusProjectFeed creates and initializes a Octopus project feed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRunbook creates and initializes a runbook.
No description provided by the author
No description provided by the author
NewRunbookSnapshot creates and initializes a runbook snapshot.
No description provided by the author
No description provided by the author
NewScriptModule creates and initializes a script module.
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.
NewTask creates and initializes a task.
No description provided by the author
NewTenant initializes a Tenant with a name.
No description provided by the author
NewTentacleVersionDetails creates and initializes tentacle version details.
NewTokenAccount creates and initializes a token account with a name and token.
No description provided by the author
NewUser initializes a user with an username and a display name.
NewUsernamePasswordAccount creates and initializes a username/password account with a name.
NewUsernamePasswordGitCredential creates and initializes an username-password Git credential.
NewUserRole initializes a user role with a name.
No description provided by the author
No description provided by the author
NewVersionControlSettings creates an instance of version control settings.
No description provided by the author
NewWorkerPoolResource creates and initializes a worker pool resource.
No description provided by the author
NotAll is the validation function for validating if the current field has a value of "all".
No description provided by the author
ScheduledTriggerFilterRunTypeString retrieves an enum value from the enum constants string name.
ScheduledTriggerFilterRunTypeValues returns all values of the enum.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
ValidateStringInSlice checks if a string is in the given slice.
WeekdayString retrieves an enum value from the enum constants string name.
WeekdayValues returns all values of the enum.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

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.

# Structs

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.
No description provided by the author
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.
No description provided by the author
ActivityLogElement represents an activity log element.
ActivityLogEntry represents an activity log entry.
AmazonWebServicesAccount represents an Amazon Web Services (AWS) account.
No description provided by the author
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.
No description provided by the author
Artifact represents an artifact.
Artifacts defines a collection of artifacts with built-in support for paged results from the API.
No description provided by the author
Authentication represents enabled authentication providers.
AuthenticationProviderElement represents an authentication provider element.
No description provided by the author
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.
No description provided by the author
AzureServicePrincipalAccount represents an Azure service principal account.
AzureSubscriptionAccount represents an Azure subscription account.
AzureWebAppEndpoint represents the an Azure web app-based endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
BuiltInFeed represents a built-in feed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Channels defines a collection of channels with built-in support for paged results.
No description provided by the author
Client is an OctopusDeploy for making Octopus API requests.
CloudRegionEndpoint represents a cloud service endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
CommunityActionTemplate represents a community action template in Octopus Deploy.
CommunityActionTemplates defines a collection of community action templates with built-in support for paged results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DatabasePersistenceSettings represents database persistence settings associated with a project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deployments defines a collection of deployment instances with built-in support for paged results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DeploymentTargets defines a collection of deployment targets with built-in support for paged results from the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DockerContainerRegistry represents a Docker container registry.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GitHubRepositoryFeed represents a GitHub repository feed.
GitPersistenceSettings represents persistence settings associated with a project.
GoogleCloudPlatformAccount represents a Google cloud account.
HelmFeed represents a Helm feed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MavenFeed represents a Maven feed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NuGetFeed represents a NuGet feed.
OctopusProjectFeed represents an Octopus project feed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Releases defines a collection of Release instance with built-in support for paged results from the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Runbooks defines a collection of runbooks with built-in support for paged results.
RunbookSnapshot represents a runbook snapshot.
RunbookSnapshots defines a collection of runbook snapshots with built-in support for paged results from the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SSHEndpoint contains the information necessary to communicate with an SSH endpoint.
SSHKeyAccount represents a SSH key pair account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Teams defines a collection of teams with built-in support for paged results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TokenAccount represents a token account.
No description provided by the author
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.
UsernamePasswordGitCredential defines a username-password Git credential.
No description provided by the author
No description provided by the author
No description provided by the author
UserRole represents a user role in Octopus.
UserRoles defines a collection of user roles with built-in support for paged results.
No description provided by the author
Users defines a collection of users with built-in support for paged results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VersionControlSettings represents version control settings associated with a project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Workers defines a collection of workers with built-in support for paged results.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
IAccount defines the interface for accounts.
No description provided by the author
No description provided by the author
IEndpoint defines the interface for endpoints.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IGitCredential defines the interface for Git-associated credentials.
No description provided by the author
No description provided by the author
No description provided by the author
IPersistenceSettings defines the interface for persistence settings.
IResource defines the interface for resources.
IRunsOnAWorker defines the interface for workers.
IService defines the contract for all services that communicate with the Octopus API.
ISSHKeyAccount defines the interface for SSH key accounts.
ITriggerAction defines the interface for trigger actions.
ITriggerFilter defines the interface for trigger filters.
IUsernamePasswordAccount defines the interface for username-password accounts.
IWorkerPool defines the interface for worker pools.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author