Documentation ¶
Index ¶
- Constants
- Variables
- func GetCredentialDirectory(leafDir string, serverlessDir string) string
- func GetCurrentServerlessVersion(serverlessDir string) string
- func GetMinServerlessVersion() string
- func HashAccessToken(token string) string
- func ListForbiddenConfigs(serverlessProject *ServerlessSpec) ([]string, error)
- func ListInvalidWebsecureValues(serverlessProject *ServerlessSpec) ([]string, error)
- func PaginateResp(gen Generator) ([]any, error)
- func PreserveCreds(leafDir string, stagingDir string, serverlessDir string) error
- type Account
- type AccountService
- type Action
- type Actions
- type ActionsService
- type AlertPolicies
- type AlertPolicy
- type AppsService
- type Balance
- type BalanceService
- type BillingHistory
- type BillingHistoryService
- type CDN
- type CDNsService
- type Certificate
- type Certificates
- type CertificatesService
- type Database
- type DatabaseBackup
- type DatabaseBackups
- type DatabaseConnection
- type DatabaseDB
- type DatabaseDBs
- type DatabaseFirewallRule
- type DatabaseFirewallRules
- type DatabaseLayout
- type DatabaseMaintenanceWindow
- type DatabaseOptions
- type DatabasePool
- type DatabasePools
- type DatabaseReplica
- type DatabaseReplicas
- type DatabaseTopic
- type DatabaseTopicPartitions
- type DatabaseTopics
- type DatabaseUser
- type DatabaseUsers
- type Databases
- type DatabasesService
- type Domain
- type DomainRecord
- type DomainRecordEditRequest
- type DomainRecords
- type Domains
- type DomainsService
- type Droplet
- type DropletActionsService
- type DropletIPTable
- type Droplets
- type DropletsService
- type Firewall
- type Firewalls
- type FirewallsService
- type FunctionParameter
- type FunctionParameterReparse
- type GarbageCollection
- type Generator
- type Image
- type ImageActionsService
- type Images
- type ImagesService
- type InterfaceType
- type Invoice
- type InvoiceItem
- type InvoiceList
- type InvoiceSummary
- type InvoicesService
- type Kernel
- type Kernels
- type KeysService
- type KubernetesAssociatedResources
- type KubernetesCluster
- type KubernetesClusterCredentials
- type KubernetesClusters
- type KubernetesNodePool
- type KubernetesNodePools
- type KubernetesNodeSize
- type KubernetesNodeSizes
- type KubernetesRegion
- type KubernetesRegions
- type KubernetesService
- type KubernetesVersion
- type KubernetesVersions
- type LoadBalancer
- type LoadBalancers
- type LoadBalancersService
- type MonitoringService
- type MySQLConfig
- type NamespaceListResponse
- type NamespaceResponse
- type OAuthApplication
- type OAuthService
- type OAuthTokenInfo
- type OneClick
- type OneClickService
- type OneClicks
- type OutputNamespace
- type PostgreSQLConfig
- type Project
- type ProjectMetadata
- type ProjectResource
- type ProjectResources
- type Projects
- type ProjectsService
- type RateLimit
- type RedisConfig
- type Region
- type Regions
- type RegionsService
- type Registry
- type RegistryService
- type RegistrySubscriptionTier
- type Repository
- type RepositoryManifest
- type RepositoryTag
- type RepositoryV2
- type ReservedIP
- type ReservedIPActionsService
- type ReservedIPs
- type ReservedIPsService
- type SSHKey
- type SSHKeys
- type ServerlessCredential
- type ServerlessCredentials
- type ServerlessFunction
- type ServerlessHostInfo
- type ServerlessOutput
- type ServerlessPackage
- type ServerlessProject
- type ServerlessRuntime
- type ServerlessService
- type ServerlessSpec
- type ServerlessTrigger
- type ServerlessTriggerGetResponse
- type ServerlessTriggerListResponse
- type Size
- type Sizes
- type SizesService
- type Snapshot
- type Snapshots
- type SnapshotsService
- type Tag
- type Tags
- type TagsService
- type TriggerScheduledDetails
- type TriggerScheduledRuns
- type UpdateTriggerRequest
- type UptimeAlert
- type UptimeCheck
- type UptimeCheckState
- type UptimeChecksService
- type VPC
- type VPCs
- type VPCsService
- type Volume
- type VolumeActionsService
- type VolumesService
Constants ¶
const ( // ForbiddenConfigWebSecure ... ForbiddenConfigWebSecure = "webSecure" // ForbiddenConfigSequence ... ForbiddenConfigSequence = "sequence" // ForbiddenConfigProvideAPIKeyAnnotation ... ForbiddenConfigProvideAPIKeyAnnotation = "provideAPIKeyAnnotation" // ForbiddenConfigRequireWhiskAuthAnnotation ... ForbiddenConfigRequireWhiskAuthAnnotation = "provideWhiskAuthAnnotation" // ForbiddenAnnotationProvideAPIKey ... ForbiddenAnnotationProvideAPIKey = "provide-api-key" // ForbiddenAnnotationRequireWhiskAuth ... ForbiddenAnnotationRequireWhiskAuth = "require-whisk-auth" )ForbiddenConfigShared = "shared"
const (
// CredentialsFile is the name of the file where the sandbox plugin stores OpenWhisk credentials.
CredentialsFile = "credentials.json"
)
const RegistryHostname = "registry.digitalocean.com"
RegistryHostname is the hostname for the DO registry
Variables ¶
var ( // ErrServerlessNotInstalled is the error returned to users when the sandbox is not installed. ErrServerlessNotInstalled = errors.New("serverless support is not installed (use `doctl serverless install`)") // ErrServerlessNeedsUpgrade is the error returned to users when the sandbox is at too low a version ErrServerlessNeedsUpgrade = errors.New("serverless support needs to be upgraded (use `doctl serverless upgrade`)") // ErrServerlessNotConnected is the error returned to users when the sandbox is not connected to a namespace ErrServerlessNotConnected = errors.New("serverless support is installed but not connected to a functions namespace (use `doctl serverless connect`)") )
Functions ¶
func GetCredentialDirectory ¶ added in v1.80.0
GetCredentialDirectory returns the directory in which credentials should be stored for a given CmdConfig. The actual leaf directory is a function of the access token being used. This ties serverless credentials to DO credentials
func GetCurrentServerlessVersion ¶ added in v1.80.0
GetCurrentServerlessVersion gets the version of the current plugin. To be called only when the plugin is known to exist. Returns "0" if the installed plugin pre-dates the versioning system Otherwise, returns the version string stored in the serverless directory.
func GetMinServerlessVersion ¶ added in v1.80.0
func GetMinServerlessVersion() string
GetMinServerlessVersion returns the minServerlessVersion (allows the constant to be overridden via an environment variable)
func HashAccessToken ¶ added in v1.82.0
HashAccessToken converts a DO access token string into a shorter but suitably random string via hashing. This is used to form part of the path for storing OpenWhisk credentials
func ListForbiddenConfigs ¶ added in v1.80.0
func ListForbiddenConfigs(serverlessProject *ServerlessSpec) ([]string, error)
ListForbiddenConfigs returns a list of forbidden config values in a project spec.
func ListInvalidWebsecureValues ¶ added in v1.80.0
func ListInvalidWebsecureValues(serverlessProject *ServerlessSpec) ([]string, error)
ListInvalidWebsecureValues returns a list of forbidden websecure values for an action in a project spec. a valid websecure value is any string other than "true"
func PaginateResp ¶
PaginateResp paginates a Response.
Types ¶
type AccountService ¶
AccountService is an interface for interacting with DigitalOcean's account api.
func NewAccountService ¶
func NewAccountService(godoClient *godo.Client) AccountService
NewAccountService builds an AccountService instance.
type ActionsService ¶
ActionsService is an interface for interacting with DigitalOcean's action api.
func NewActionsService ¶
func NewActionsService(godoClient *godo.Client) ActionsService
NewActionsService builds an ActionsService instance.
type AlertPolicies ¶ added in v1.63.1
type AlertPolicies []AlertPolicy
AlertPolicies is a slice of AlertPolicy.
type AlertPolicy ¶ added in v1.63.1
type AlertPolicy struct {
*godo.AlertPolicy
}
AlertPolicy is a wrapper for godo.AlertPolicy
type AppsService ¶ added in v1.46.0
type AppsService interface { Create(req *godo.AppCreateRequest) (*godo.App, error) Get(appID string) (*godo.App, error) List(withProjects bool) ([]*godo.App, error) Update(appID string, req *godo.AppUpdateRequest) (*godo.App, error) Delete(appID string) error Propose(req *godo.AppProposeRequest) (*godo.AppProposeResponse, error) CreateDeployment(appID string, forceRebuild bool) (*godo.Deployment, error) GetDeployment(appID, deploymentID string) (*godo.Deployment, error) ListDeployments(appID string) ([]*godo.Deployment, error) GetLogs(appID, deploymentID, component string, logType godo.AppLogType, follow bool, tail int) (*godo.AppLogs, error) ListRegions() ([]*godo.AppRegion, error) ListTiers() ([]*godo.AppTier, error) GetTier(slug string) (*godo.AppTier, error) ListInstanceSizes() ([]*godo.AppInstanceSize, error) GetInstanceSize(slug string) (*godo.AppInstanceSize, error) ListAlerts(appID string) ([]*godo.AppAlert, error) UpdateAlertDestinations(appID, alertID string, update *godo.AlertDestinationUpdateRequest) (*godo.AppAlert, error) ListBuildpacks() ([]*godo.Buildpack, error) UpgradeBuildpack(appID string, options godo.UpgradeBuildpackOptions) (affectedComponents []string, deployment *godo.Deployment, err error) }
AppsService is the interface that wraps godo AppsService.
func NewAppsService ¶ added in v1.46.0
func NewAppsService(client *godo.Client) AppsService
NewAppsService builds an instance of AppsService.
type BalanceService ¶ added in v1.37.0
BalanceService is an interface for interacting with DigitalOcean's balance api.
func NewBalanceService ¶ added in v1.37.0
func NewBalanceService(godoClient *godo.Client) BalanceService
NewBalanceService builds an BalanceService instance.
type BillingHistory ¶ added in v1.40.0
type BillingHistory struct {
*godo.BillingHistory
}
BillingHistory is a wrapper for godo.BillingHistory
type BillingHistoryService ¶ added in v1.40.0
type BillingHistoryService interface {
List() (*BillingHistory, error)
}
BillingHistoryService is an interface for interacting with DigitalOcean's invoices api.
func NewBillingHistoryService ¶ added in v1.40.0
func NewBillingHistoryService(client *godo.Client) BillingHistoryService
NewBillingHistoryService builds an BillingHistoryService instance.
type CDNsService ¶ added in v1.9.0
type CDNsService interface { List() ([]CDN, error) Get(string) (*CDN, error) Create(*godo.CDNCreateRequest) (*CDN, error) UpdateTTL(string, *godo.CDNUpdateTTLRequest) (*CDN, error) UpdateCustomDomain(string, *godo.CDNUpdateCustomDomainRequest) (*CDN, error) FlushCache(string, *godo.CDNFlushCacheRequest) error Delete(string) error }
CDNsService is an interface for interacting with DigitalOcean's CDN api.
func NewCDNsService ¶ added in v1.9.0
func NewCDNsService(godoClient *godo.Client) CDNsService
NewCDNsService builds an NewCDNsService instance.
type Certificate ¶ added in v1.6.0
type Certificate struct {
*godo.Certificate
}
Certificate wraps a godo Certificate.
type Certificates ¶ added in v1.6.0
type Certificates []Certificate
Certificates is a slice of Certificate.
type CertificatesService ¶ added in v1.6.0
type CertificatesService interface { Get(cID string) (*Certificate, error) Create(cr *godo.CertificateRequest) (*Certificate, error) List() (Certificates, error) Delete(cID string) error }
CertificatesService is the godo CertificatesService interface.
func NewCertificatesService ¶ added in v1.6.0
func NewCertificatesService(client *godo.Client) CertificatesService
NewCertificatesService builds an instance of CertificatesService.
type DatabaseBackup ¶ added in v1.15.0
type DatabaseBackup struct {
*godo.DatabaseBackup
}
DatabaseBackup is a wrapper for godo.DatabaseBackup
type DatabaseBackups ¶ added in v1.15.0
type DatabaseBackups []DatabaseBackup
DatabaseBackups is a slice of DatabaseBackup
type DatabaseConnection ¶ added in v1.15.0
type DatabaseConnection struct {
*godo.DatabaseConnection
}
DatabaseConnection is a wrapper for godo.DatabaseConnection
type DatabaseDB ¶ added in v1.15.0
type DatabaseDB struct {
*godo.DatabaseDB
}
DatabaseDB is a wrapper for godo.DatabaseDB
type DatabaseDBs ¶ added in v1.15.0
type DatabaseDBs []DatabaseDB
DatabaseDBs is a slice of DatabaseDB
type DatabaseFirewallRule ¶ added in v1.56.0
type DatabaseFirewallRule struct {
*godo.DatabaseFirewallRule
}
DatabaseFirewallRule is a wrapper for godo.DatabaseFirewallRule
type DatabaseFirewallRules ¶ added in v1.56.0
type DatabaseFirewallRules []DatabaseFirewallRule
DatabaseFirewallRules is a slice of DatabaseFirewallRule
type DatabaseLayout ¶ added in v1.79.0
type DatabaseLayout struct {
*godo.DatabaseLayout
}
DatabaseLayout is a wrapper for
type DatabaseMaintenanceWindow ¶ added in v1.15.0
type DatabaseMaintenanceWindow struct {
*godo.DatabaseMaintenanceWindow
}
DatabaseMaintenanceWindow is a wrapper for godo.DatabaseMaintenanceWindow
type DatabaseOptions ¶ added in v1.79.0
type DatabaseOptions struct {
*godo.DatabaseOptions
}
DatabaseOptions is a wrapper for
type DatabasePool ¶ added in v1.15.0
type DatabasePool struct {
*godo.DatabasePool
}
DatabasePool is a wrapper for godo.DatabasePool
type DatabasePools ¶ added in v1.15.0
type DatabasePools []DatabasePool
DatabasePools is a slice of DatabasePool
type DatabaseReplica ¶ added in v1.15.0
type DatabaseReplica struct {
*godo.DatabaseReplica
}
DatabaseReplica is a wrapper for godo.DatabaseReplica
type DatabaseReplicas ¶ added in v1.15.0
type DatabaseReplicas []DatabaseReplica
DatabaseReplicas is a slice of DatabaseReplica
type DatabaseTopic ¶ added in v1.101.0
type DatabaseTopic struct {
*godo.DatabaseTopic
}
DatabaseTopic is a wrapper for godo.DatabaseTopic
type DatabaseTopicPartitions ¶ added in v1.101.0
type DatabaseTopicPartitions struct {
Partitions []*godo.TopicPartition
}
DatabaseTopicPartitions is a slice of *godo.TopicPartition
type DatabaseTopics ¶ added in v1.101.0
type DatabaseTopics []DatabaseTopic
DatabaseTopics is a slice of DatabaseTopic
type DatabaseUser ¶ added in v1.15.0
type DatabaseUser struct {
*godo.DatabaseUser
}
DatabaseUser is a wrapper for godo.DatabaseUser
type DatabaseUsers ¶ added in v1.15.0
type DatabaseUsers []DatabaseUser
DatabaseUsers is a slice of DatabaseUser
type DatabasesService ¶ added in v1.15.0
type DatabasesService interface { List() (Databases, error) Get(string) (*Database, error) Create(*godo.DatabaseCreateRequest) (*Database, error) Delete(string) error GetConnection(string, bool) (*DatabaseConnection, error) ListBackups(string) (DatabaseBackups, error) Resize(string, *godo.DatabaseResizeRequest) error Migrate(string, *godo.DatabaseMigrateRequest) error GetMaintenance(string) (*DatabaseMaintenanceWindow, error) UpdateMaintenance(string, *godo.DatabaseUpdateMaintenanceRequest) error GetUser(string, string) (*DatabaseUser, error) ListUsers(string) (DatabaseUsers, error) CreateUser(string, *godo.DatabaseCreateUserRequest) (*DatabaseUser, error) DeleteUser(string, string) error ResetUserAuth(string, string, *godo.DatabaseResetUserAuthRequest) (*DatabaseUser, error) ListDBs(string) (DatabaseDBs, error) CreateDB(string, *godo.DatabaseCreateDBRequest) (*DatabaseDB, error) GetDB(string, string) (*DatabaseDB, error) DeleteDB(string, string) error ListPools(string) (DatabasePools, error) CreatePool(string, *godo.DatabaseCreatePoolRequest) (*DatabasePool, error) GetPool(string, string) (*DatabasePool, error) DeletePool(string, string) error GetReplica(string, string) (*DatabaseReplica, error) ListReplicas(string) (DatabaseReplicas, error) CreateReplica(string, *godo.DatabaseCreateReplicaRequest) (*DatabaseReplica, error) DeleteReplica(string, string) error PromoteReplica(string, string) error GetReplicaConnection(string, string) (*DatabaseConnection, error) GetSQLMode(string) ([]string, error) SetSQLMode(string, ...string) error GetFirewallRules(string) (DatabaseFirewallRules, error) UpdateFirewallRules(databaseID string, req *godo.DatabaseUpdateFirewallRulesRequest) error ListOptions() (*DatabaseOptions, error) GetMySQLConfiguration(databaseID string) (*MySQLConfig, error) GetPostgreSQLConfiguration(databaseID string) (*PostgreSQLConfig, error) GetRedisConfiguration(databaseID string) (*RedisConfig, error) UpdateMySQLConfiguration(databaseID string, confString string) error UpdatePostgreSQLConfiguration(databaseID string, confString string) error UpdateRedisConfiguration(databaseID string, confString string) error ListTopics(string) (DatabaseTopics, error) GetTopic(string, string) (*DatabaseTopic, error) CreateTopic(string, *godo.DatabaseCreateTopicRequest) (*DatabaseTopic, error) UpdateTopic(string, string, *godo.DatabaseUpdateTopicRequest) error DeleteTopic(string, string) error }
DatabasesService is an interface for interacting with DigitalOcean's Database API
func NewDatabasesService ¶ added in v1.15.0
func NewDatabasesService(client *godo.Client) DatabasesService
NewDatabasesService builds a DatabasesService instance.
type DomainRecord ¶
type DomainRecord struct {
*godo.DomainRecord
}
DomainRecord wraps a godo DomainRecord.
type DomainRecordEditRequest ¶ added in v1.34.0
type DomainRecordEditRequest struct { Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Data string `json:"data,omitempty"` Priority int `json:"priority"` Port *int `json:"port,omitempty"` TTL int `json:"ttl,omitempty"` Weight int `json:"weight"` Flags int `json:"flags"` Tag string `json:"tag,omitempty"` }
A DomainRecordEditRequest is used in place of godo's DomainRecordEditRequest in order to work around the fact that we cannot send a port value of 0 via godo due to Go's JSON encoding logic.
type DomainsService ¶
type DomainsService interface { List() (Domains, error) Get(string) (*Domain, error) Create(*godo.DomainCreateRequest) (*Domain, error) Delete(string) error Records(string) (DomainRecords, error) Record(string, int) (*DomainRecord, error) DeleteRecord(string, int) error EditRecord(string, int, *DomainRecordEditRequest) (*DomainRecord, error) CreateRecord(string, *DomainRecordEditRequest) (*DomainRecord, error) }
DomainsService is the godo DomainsService interface.
func NewDomainsService ¶
func NewDomainsService(client *godo.Client) DomainsService
NewDomainsService builds an instance of DomainsService.
type DropletActionsService ¶
type DropletActionsService interface { Shutdown(int) (*Action, error) ShutdownByTag(string) (Actions, error) PowerOff(int) (*Action, error) PowerOffByTag(string) (Actions, error) PowerOn(int) (*Action, error) PowerOnByTag(string) (Actions, error) PowerCycle(int) (*Action, error) PowerCycleByTag(string) (Actions, error) Reboot(int) (*Action, error) Restore(int, int) (*Action, error) Resize(int, string, bool) (*Action, error) Rename(int, string) (*Action, error) Snapshot(int, string) (*Action, error) SnapshotByTag(string, string) (Actions, error) EnableBackups(int) (*Action, error) EnableBackupsByTag(string) (Actions, error) DisableBackups(int) (*Action, error) DisableBackupsByTag(string) (Actions, error) PasswordReset(int) (*Action, error) RebuildByImageID(int, int) (*Action, error) RebuildByImageSlug(int, string) (*Action, error) ChangeKernel(int, int) (*Action, error) EnableIPv6(int) (*Action, error) EnableIPv6ByTag(string) (Actions, error) EnablePrivateNetworking(int) (*Action, error) EnablePrivateNetworkingByTag(string) (Actions, error) Get(int, int) (*Action, error) GetByURI(string) (*Action, error) }
DropletActionsService is an interface for interacting with DigitalOcean's droplet action api.
func NewDropletActionsService ¶
func NewDropletActionsService(godoClient *godo.Client) DropletActionsService
NewDropletActionsService builds an instance of DropletActionsService.
type DropletIPTable ¶
type DropletIPTable map[InterfaceType]string
DropletIPTable is a table of interface IPS.
type DropletsService ¶
type DropletsService interface { List() (Droplets, error) ListByTag(string) (Droplets, error) Get(int) (*Droplet, error) Create(*godo.DropletCreateRequest, bool) (*Droplet, error) CreateMultiple(*godo.DropletMultiCreateRequest) (Droplets, error) Delete(int) error DeleteByTag(string) error Kernels(int) (Kernels, error) Snapshots(int) (Images, error) Backups(int) (Images, error) Actions(int) (Actions, error) Neighbors(int) (Droplets, error) }
DropletsService is an interface for interacting with DigitalOcean's droplet api.
func NewDropletsService ¶
func NewDropletsService(client *godo.Client) DropletsService
NewDropletsService builds a DropletsService instance.
type FirewallsService ¶ added in v1.7.0
type FirewallsService interface { Get(fID string) (*Firewall, error) Create(fr *godo.FirewallRequest) (*Firewall, error) Update(fID string, fr *godo.FirewallRequest) (*Firewall, error) List() (Firewalls, error) ListByDroplet(dID int) (Firewalls, error) Delete(fID string) error AddDroplets(fID string, dIDs ...int) error RemoveDroplets(fID string, dIDs ...int) error AddTags(fID string, tags ...string) error RemoveTags(fID string, tags ...string) error AddRules(fID string, rr *godo.FirewallRulesRequest) error RemoveRules(fID string, rr *godo.FirewallRulesRequest) error }
FirewallsService is the godo FirewallsService interface.
func NewFirewallsService ¶ added in v1.7.0
func NewFirewallsService(client *godo.Client) FirewallsService
NewFirewallsService builds an instance of FirewallsService.
type FunctionParameter ¶ added in v1.80.0
type FunctionParameter struct { Key string `json:"key"` Value string `json:"value"` Init bool `json:"init"` Encryption string `json:"encryption"` }
FunctionParameter is the type of a parameter in the response body of action.get. We do our own JSON unmarshaling of these because the go OpenWhisk client doesn't include the "init" and "encryption" members, of which at least "init" is needed.
type FunctionParameterReparse ¶ added in v1.80.0
type FunctionParameterReparse struct {
Parameters []FunctionParameter `json:"parameters"`
}
FunctionParameterReparse is a partial remapping of whisk.Action so that the parameters are declared as FunctionParameter rather than whisk.KeyValue.
type GarbageCollection ¶ added in v1.50.0
type GarbageCollection struct {
*godo.GarbageCollection
}
GarbageCollection wraps a godo GarbageCollection
type ImageActionsService ¶
type ImageActionsService interface { Get(int, int) (*Action, error) Convert(int) (*Action, error) Transfer(int, *godo.ActionRequest) (*Action, error) }
ImageActionsService is an interface for interacting with DigitalOcean's image action api.
func NewImageActionsService ¶
func NewImageActionsService(client *godo.Client) ImageActionsService
NewImageActionsService builds an ImageActionsService instance.
type ImagesService ¶
type ImagesService interface { List(public bool) (Images, error) ListDistribution(public bool) (Images, error) ListApplication(public bool) (Images, error) ListUser(public bool) (Images, error) GetByID(id int) (*Image, error) GetBySlug(slug string) (*Image, error) Update(id int, iur *godo.ImageUpdateRequest) (*Image, error) Delete(id int) error Create(icr *godo.CustomImageCreateRequest) (*Image, error) }
ImagesService is the godo ImagesService interface.
func NewImagesService ¶
func NewImagesService(client *godo.Client) ImagesService
NewImagesService builds an instance of ImagesService.
type InterfaceType ¶
type InterfaceType string
InterfaceType is an interface type.
const ( // InterfacePublic is a public interface. InterfacePublic InterfaceType = "public" // InterfacePrivate is a private interface. InterfacePrivate InterfaceType = "private" )
type InvoiceItem ¶ added in v1.39.0
type InvoiceItem struct {
*godo.InvoiceItem
}
InvoiceItem is a wrapper for godo.InvoiceItem
type InvoiceList ¶ added in v1.39.0
type InvoiceList struct {
*godo.InvoiceList
}
InvoiceList is the results when listing invoices
type InvoiceSummary ¶ added in v1.39.0
type InvoiceSummary struct {
*godo.InvoiceSummary
}
InvoiceSummary is a wrapper for godo.InvoiceSummary
type InvoicesService ¶ added in v1.39.0
type InvoicesService interface { Get(string) (*Invoice, error) List() (*InvoiceList, error) GetSummary(string) (*InvoiceSummary, error) GetPDF(string) ([]byte, error) GetCSV(string) ([]byte, error) }
InvoicesService is an interface for interacting with DigitalOcean's invoices api.
func NewInvoicesService ¶ added in v1.39.0
func NewInvoicesService(client *godo.Client) InvoicesService
NewInvoicesService builds an InvoicesService instance.
type KeysService ¶
type KeysService interface { List() (SSHKeys, error) Get(id string) (*SSHKey, error) Create(kcr *godo.KeyCreateRequest) (*SSHKey, error) Update(id string, kur *godo.KeyUpdateRequest) (*SSHKey, error) Delete(id string) error }
KeysService is the godo KeysService interface.
func NewKeysService ¶
func NewKeysService(client *godo.Client) KeysService
NewKeysService builds an instance of KeysService.
type KubernetesAssociatedResources ¶ added in v1.56.0
type KubernetesAssociatedResources struct {
*godo.KubernetesAssociatedResources
}
KubernetesAssociatedResources wraps a godo KubernetesAssociatedResources
type KubernetesCluster ¶ added in v1.12.0
type KubernetesCluster struct {
*godo.KubernetesCluster
}
KubernetesCluster wraps a godo KubernetesCluster.
type KubernetesClusterCredentials ¶ added in v1.32.2
type KubernetesClusterCredentials struct {
*godo.KubernetesClusterCredentials
}
KubernetesClusterCredentials wraps a godo KubernetesClusterCredentials.
type KubernetesClusters ¶ added in v1.12.0
type KubernetesClusters []KubernetesCluster
KubernetesClusters is a slice of KubernetesCluster.
type KubernetesNodePool ¶ added in v1.12.0
type KubernetesNodePool struct {
*godo.KubernetesNodePool
}
KubernetesNodePool wraps a godo KubernetesNodePool.
type KubernetesNodePools ¶ added in v1.12.0
type KubernetesNodePools []KubernetesNodePool
KubernetesNodePools is a slice of KubernetesNodePool.
type KubernetesNodeSize ¶ added in v1.12.1
type KubernetesNodeSize struct {
*godo.KubernetesNodeSize
}
KubernetesNodeSize wraps a godo KubernetesNodeSize.
type KubernetesNodeSizes ¶ added in v1.12.1
type KubernetesNodeSizes []KubernetesNodeSize
KubernetesNodeSizes is a slice of KubernetesNodeSizes.
type KubernetesRegion ¶ added in v1.12.1
type KubernetesRegion struct {
*godo.KubernetesRegion
}
KubernetesRegion wraps a godo KubernetesRegion.
type KubernetesRegions ¶ added in v1.12.1
type KubernetesRegions []KubernetesRegion
KubernetesRegions is a slice of KubernetesRegions.
type KubernetesService ¶ added in v1.12.0
type KubernetesService interface { Get(clusterID string) (*KubernetesCluster, error) GetKubeConfig(clusterID string) ([]byte, error) GetKubeConfigWithExpiry(clusterID string, expirySeconds int64) ([]byte, error) GetCredentials(clusterID string) (*KubernetesClusterCredentials, error) GetUpgrades(clusterID string) (KubernetesVersions, error) List() (KubernetesClusters, error) ListAssociatedResourcesForDeletion(clusterID string) (*KubernetesAssociatedResources, error) Create(create *godo.KubernetesClusterCreateRequest) (*KubernetesCluster, error) Update(clusterID string, update *godo.KubernetesClusterUpdateRequest) (*KubernetesCluster, error) Upgrade(clusterID string, versionSlug string) error Delete(clusterID string) error DeleteDangerous(clusterID string) error DeleteSelective(clusterID string, deleteReq *godo.KubernetesClusterDeleteSelectiveRequest) error CreateNodePool(clusterID string, req *godo.KubernetesNodePoolCreateRequest) (*KubernetesNodePool, error) GetNodePool(clusterID, poolID string) (*KubernetesNodePool, error) ListNodePools(clusterID string) (KubernetesNodePools, error) UpdateNodePool(clusterID, poolID string, req *godo.KubernetesNodePoolUpdateRequest) (*KubernetesNodePool, error) // RecycleNodePoolNodes is DEPRECATED please use DeleteNode RecycleNodePoolNodes(clusterID, poolID string, req *godo.KubernetesNodePoolRecycleNodesRequest) error DeleteNodePool(clusterID, poolID string) error DeleteNode(clusterID, poolID, nodeID string, req *godo.KubernetesNodeDeleteRequest) error GetVersions() (KubernetesVersions, error) GetRegions() (KubernetesRegions, error) GetNodeSizes() (KubernetesNodeSizes, error) AddRegistry(req *godo.KubernetesClusterRegistryRequest) error RemoveRegistry(req *godo.KubernetesClusterRegistryRequest) error }
KubernetesService is the godo KubernetesService interface.
func NewKubernetesService ¶ added in v1.12.0
func NewKubernetesService(client *godo.Client) KubernetesService
NewKubernetesService builds an instance of KubernetesService.
type KubernetesVersion ¶ added in v1.12.0
type KubernetesVersion struct {
*godo.KubernetesVersion
}
KubernetesVersion wraps a godo KubernetesVersion.
type KubernetesVersions ¶ added in v1.12.0
type KubernetesVersions []KubernetesVersion
KubernetesVersions is a slice of KubernetesVersions.
type LoadBalancer ¶ added in v1.6.0
type LoadBalancer struct {
*godo.LoadBalancer
}
LoadBalancer wraps a godo LoadBalancer.
type LoadBalancers ¶ added in v1.6.0
type LoadBalancers []LoadBalancer
LoadBalancers is a slice of LoadBalancer.
type LoadBalancersService ¶ added in v1.6.0
type LoadBalancersService interface { Get(lbID string) (*LoadBalancer, error) List() (LoadBalancers, error) Create(lbr *godo.LoadBalancerRequest) (*LoadBalancer, error) Update(lbID string, lbr *godo.LoadBalancerRequest) (*LoadBalancer, error) Delete(lbID string) error AddDroplets(lbID string, dIDs ...int) error RemoveDroplets(lbID string, dIDs ...int) error AddForwardingRules(lbID string, rules ...godo.ForwardingRule) error RemoveForwardingRules(lbID string, rules ...godo.ForwardingRule) error }
LoadBalancersService is the godo LoadBalancersService interface.
func NewLoadBalancersService ¶ added in v1.6.0
func NewLoadBalancersService(client *godo.Client) LoadBalancersService
NewLoadBalancersService builds an instance of LoadBalancersService.
type MonitoringService ¶ added in v1.63.1
type MonitoringService interface { ListAlertPolicies() (AlertPolicies, error) GetAlertPolicy(string) (*AlertPolicy, error) CreateAlertPolicy(request *godo.AlertPolicyCreateRequest) (*AlertPolicy, error) UpdateAlertPolicy(uuid string, request *godo.AlertPolicyUpdateRequest) (*AlertPolicy, error) DeleteAlertPolicy(string) error }
MonitoringService is an interface for interacting with DigitalOcean's monitoring api.
func NewMonitoringService ¶ added in v1.63.1
func NewMonitoringService(godoClient *godo.Client) MonitoringService
NewMonitoringService builds a MonitoringService instance.
type MySQLConfig ¶ added in v1.100.0
type MySQLConfig struct {
*godo.MySQLConfig
}
MySQLConfig is a wrapper for godo.MySQLConfig
type NamespaceListResponse ¶ added in v1.80.0
type NamespaceListResponse struct {
Namespaces []OutputNamespace `json:"namespaces"`
}
NamespaceListResponse is the type of the response body for /api/v2/functions/namespaces (GET)
type NamespaceResponse ¶ added in v1.80.0
type NamespaceResponse struct {
Namespace OutputNamespace `json:"namespace"`
}
NamespaceResponse is the type of the response body for /api/v2/functions/sandbox (POST) and /api/v2/functions/namespaces/<nsName> (GET)
type OAuthApplication ¶ added in v1.91.0
type OAuthApplication struct {
UID string `json:"uid"`
}
OAuthApplication contains info about an OAuth application
type OAuthService ¶ added in v1.91.0
type OAuthService interface {
TokenInfo(string) (*OAuthTokenInfo, error)
}
OAuthService is an interface for interacting with DigitalOcean's account api.
func NewOAuthService ¶ added in v1.91.0
func NewOAuthService(godoClient *godo.Client) OAuthService
NewOAuthService builds an OAuthService instance.
type OAuthTokenInfo ¶ added in v1.91.0
type OAuthTokenInfo struct { ResourceOwnerID int `json:"resource_owner_id"` Scopes []string `json:"scopes"` ExpiresInSeconds int `json:"expires_in_seconds"` Application OAuthApplication `json:"application"` CreatedAt int `json:"created_at"` }
OAuthTokenInfo contains information about an OAuth token
type OneClickService ¶ added in v1.44.0
type OneClickService interface { List(string) (OneClicks, error) InstallKubernetes(string, []string) (string, error) }
OneClickService is the godo OneClickService interface.
func NewOneClickService ¶ added in v1.44.0
func NewOneClickService(client *godo.Client) OneClickService
NewOneClickService builds an instance of OneClickService.
type OutputNamespace ¶ added in v1.80.0
type OutputNamespace struct { Namespace string `json:"namespace"` APIHost string `json:"api_host"` UUID string `json:"uuid"` Key string `json:"key"` Label string `json:"label"` Region string `json:"Region"` }
OutputNamespace is the type of the "namespace" member of the response to /api/v2/functions/sandbox and /api/v2/functions/namespaces APIs. Only relevant fields unmarshalled
type PostgreSQLConfig ¶ added in v1.100.0
type PostgreSQLConfig struct {
*godo.PostgreSQLConfig
}
PostgreSQLConfig is a wrapper for godo.PostgreSQLConfig
type ProjectMetadata ¶ added in v1.80.0
type ProjectMetadata struct { ServerlessSpec UnresolvedVariables []string `json:"unresolvedVariables,omitempty"` }
ProjectMetadata describes the nim project:get-metadata output structure.
type ProjectResource ¶ added in v1.11.0
type ProjectResource struct {
*godo.ProjectResource
}
ProjectResource wraps a godo ProjectResource
type ProjectResources ¶ added in v1.11.0
type ProjectResources []ProjectResource
ProjectResources is a slice of ProjectResource.
type ProjectsService ¶ added in v1.11.0
type ProjectsService interface { List() (Projects, error) GetDefault() (*Project, error) Get(projectUUID string) (*Project, error) Create(*godo.CreateProjectRequest) (*Project, error) Update(projectUUID string, req *godo.UpdateProjectRequest) (*Project, error) Delete(projectUUID string) error ListResources(projectUUID string) (ProjectResources, error) AssignResources(projectUUID string, resources []string) (ProjectResources, error) }
ProjectsService is the godo ProjectsService interface.
func NewProjectsService ¶ added in v1.11.0
func NewProjectsService(client *godo.Client) ProjectsService
NewProjectsService builds an instance of ProjectsService.
type RedisConfig ¶ added in v1.100.0
type RedisConfig struct {
*godo.RedisConfig
}
RedisConfig is a wrapper for godo.RedisConfig
type RegionsService ¶
RegionsService is the godo RegionsService interface.
func NewRegionsService ¶
func NewRegionsService(client *godo.Client) RegionsService
NewRegionsService builds an instance of RegionsService.
type RegistryService ¶ added in v1.34.0
type RegistryService interface { Get() (*Registry, error) Create(*godo.RegistryCreateRequest) (*Registry, error) Delete() error DockerCredentials(*godo.RegistryDockerCredentialsRequest) (*godo.DockerCredentials, error) ListRepositoryTags(string, string) ([]RepositoryTag, error) ListRepositoryManifests(string, string) ([]RepositoryManifest, error) ListRepositories(string) ([]Repository, error) ListRepositoriesV2(string) ([]RepositoryV2, error) DeleteTag(string, string, string) error DeleteManifest(string, string, string) error Endpoint() string StartGarbageCollection(string, *godo.StartGarbageCollectionRequest) (*GarbageCollection, error) GetGarbageCollection(string) (*GarbageCollection, error) ListGarbageCollections(string) ([]GarbageCollection, error) CancelGarbageCollection(string, string) (*GarbageCollection, error) GetSubscriptionTiers() ([]RegistrySubscriptionTier, error) GetAvailableRegions() ([]string, error) RevokeOAuthToken(token string, endpoint string) error }
RegistryService is the godo RegistryService interface.
func NewRegistryService ¶ added in v1.34.0
func NewRegistryService(client *godo.Client) RegistryService
NewRegistryService builds an instance of RegistryService.
type RegistrySubscriptionTier ¶ added in v1.51.0
type RegistrySubscriptionTier struct {
*godo.RegistrySubscriptionTier
}
RegistrySubscriptionTier wraps a godo RegistrySubscriptionTier
type Repository ¶ added in v1.42.0
type Repository struct {
*godo.Repository
}
Repository wraps a godo Repository
type RepositoryManifest ¶ added in v1.68.0
type RepositoryManifest struct {
*godo.RepositoryManifest
}
RepositoryManifest wraps a godo RepositoryManifest
type RepositoryTag ¶ added in v1.42.0
type RepositoryTag struct {
*godo.RepositoryTag
}
RepositoryTag wraps a godo RepositoryTag
type RepositoryV2 ¶ added in v1.68.0
type RepositoryV2 struct {
*godo.RepositoryV2
}
RepositoryV2 wraps a godo RepositoryV2
type ReservedIP ¶ added in v1.77.0
type ReservedIP struct {
*godo.ReservedIP
}
ReservedIP wraps a godo ReservedIP.
type ReservedIPActionsService ¶ added in v1.77.0
type ReservedIPActionsService interface { Assign(ip string, dropletID int) (*Action, error) Unassign(ip string) (*Action, error) Get(ip string, actionID int) (*Action, error) List(ip string, opt *godo.ListOptions) ([]Action, error) }
ReservedIPActionsService is an interface for interacting with DigitalOcean's reserved ip action api.
func NewReservedIPActionsService ¶ added in v1.77.0
func NewReservedIPActionsService(godoClient *godo.Client) ReservedIPActionsService
NewReservedIPActionsService builds a ReservedIPActionsService instance.
type ReservedIPs ¶ added in v1.77.0
type ReservedIPs []ReservedIP
ReservedIPs is a slice of ReservedIP.
type ReservedIPsService ¶ added in v1.77.0
type ReservedIPsService interface { List() (ReservedIPs, error) Get(ip string) (*ReservedIP, error) Create(ficr *godo.ReservedIPCreateRequest) (*ReservedIP, error) Delete(ip string) error }
ReservedIPsService is the godo ReservedIPsService interface.
func NewReservedIPsService ¶ added in v1.77.0
func NewReservedIPsService(client *godo.Client) ReservedIPsService
NewReservedIPsService builds an instance of ReservedIPsService.
type ServerlessCredential ¶ added in v1.80.0
type ServerlessCredential struct {
Auth string `json:"api_key"`
}
ServerlessCredential is the type of an individual entry in ServerlessCredentials
type ServerlessCredentials ¶ added in v1.80.0
type ServerlessCredentials struct { APIHost string `json:"currentHost"` Namespace string `json:"currentNamespace"` Label string `json:"label"` Credentials map[string]map[string]ServerlessCredential `json:"credentials"` }
ServerlessCredentials models what is stored in credentials.json for use by the plugin and nim. It is also the type returned by the GetServerlessNamespace function.
type ServerlessFunction ¶ added in v1.85.0
type ServerlessFunction struct { Name string `json:"name,omitempty"` Binary bool `json:"binary,omitempty"` Main string `json:"main,omitempty"` Runtime string `json:"runtime,omitempty"` // `web` can be either true or "raw". We use interface{} to support both types. If we start consuming the value we // should probably define a custom type with proper validation. Web any `json:"web,omitempty"` WebSecure any `json:"webSecure,omitempty" yaml:"webSecure"` Parameters map[string]any `json:"parameters,omitempty"` Environment map[string]any `json:"environment,omitempty"` Annotations map[string]any `json:"annotations,omitempty"` Limits map[string]int `json:"limits,omitempty"` }
ServerlessFunction ...
type ServerlessHostInfo ¶ added in v1.75.0
type ServerlessHostInfo struct {
Runtimes map[string][]ServerlessRuntime `json:"runtimes"`
}
ServerlessHostInfo is the type of the host information return from the API host controller of the serverless cluster. Only relevant fields unmarshaled.
type ServerlessOutput ¶ added in v1.80.0
type ServerlessOutput struct { Table []map[string]any `json:"table,omitempty"` Captured []string `json:"captured,omitempty"` Formatted []string `json:"formatted,omitempty"` Entity any `json:"entity,omitempty"` Error string `json:"error,omitempty"` }
ServerlessOutput contains the output returned from calls to the sandbox plugin.
type ServerlessPackage ¶ added in v1.85.0
type ServerlessPackage struct { Name string `json:"name,omitempty"` Environment map[string]any `json:"environment,omitempty"` Parameters map[string]any `json:"parameters,omitempty"` Annotations map[string]any `json:"annotations,omitempty"` Functions []*ServerlessFunction `json:"functions,omitempty"` }
ServerlessPackage ...
type ServerlessProject ¶ added in v1.80.0
type ServerlessProject struct { ProjectPath string `json:"project_path"` ConfigPath string `json:"config"` Packages string `json:"packages"` Env string `json:"env"` Strays []string `json:"strays"` }
ServerlessProject ...
type ServerlessRuntime ¶ added in v1.75.0
type ServerlessRuntime struct { Default bool `json:"default"` Deprecated bool `json:"deprecated"` Kind string `json:"kind"` }
ServerlessRuntime is the type of a runtime entry returned by the API host controller of the serverless cluster. Only relevant fields unmarshalled
type ServerlessService ¶ added in v1.80.0
type ServerlessService interface { Cmd(string, []string) (*exec.Cmd, error) Exec(*exec.Cmd) (ServerlessOutput, error) Stream(*exec.Cmd) error GetServerlessNamespace(context.Context) (ServerlessCredentials, error) ListNamespaces(context.Context) (NamespaceListResponse, error) GetNamespace(context.Context, string) (ServerlessCredentials, error) GetNamespaceFromCluster(string, string) (string, error) CreateNamespace(context.Context, string, string) (ServerlessCredentials, error) DeleteNamespace(context.Context, string) error CleanNamespace() error ListTriggers(context.Context, string) ([]ServerlessTrigger, error) GetTrigger(context.Context, string) (ServerlessTrigger, error) UpdateTrigger(context.Context, string, *UpdateTriggerRequest) (ServerlessTrigger, error) DeleteTrigger(context.Context, string) error WriteCredentials(ServerlessCredentials) error ReadCredentials() (ServerlessCredentials, error) GetHostInfo(string) (ServerlessHostInfo, error) CheckServerlessStatus() error InstallServerless(string, bool) error ListPackages() ([]whisk.Package, error) DeletePackage(string, bool) error GetFunction(string, bool) (whisk.Action, []FunctionParameter, error) ListFunctions(string, int, int) ([]whisk.Action, error) DeleteFunction(string, bool) error InvokeFunction(string, any, bool, bool) (any, error) InvokeFunctionViaWeb(string, any) error ListActivations(whisk.ActivationListOptions) ([]whisk.Activation, error) GetActivationCount(whisk.ActivationCountOptions) (whisk.ActivationCount, error) GetActivation(string) (whisk.Activation, error) GetActivationLogs(string) (whisk.Activation, error) GetActivationResult(string) (whisk.Response, error) GetConnectedAPIHost() (string, error) ReadProject(*ServerlessProject, []string) (ServerlessOutput, error) WriteProject(ServerlessProject) (string, error) SetEffectiveCredentials(auth string, apihost string) CredentialsPath() string }
ServerlessService is an interface for interacting with the sandbox plugin, with the namespaces service, and with the serverless cluster controller.
func NewServerlessService ¶ added in v1.80.0
func NewServerlessService(client *godo.Client, usualServerlessDir string, accessToken string) ServerlessService
NewServerlessService returns a configured ServerlessService.
type ServerlessSpec ¶ added in v1.85.0
type ServerlessSpec struct { Parameters map[string]any `json:"parameters,omitempty"` Environment map[string]any `json:"environment,omitempty"` Packages []*ServerlessPackage `json:"packages,omitempty"` }
ServerlessSpec describes a project.yml spec reference: https://docs.nimbella.com/configuration/
type ServerlessTrigger ¶ added in v1.82.0
type ServerlessTrigger struct { Namespace string `json:"namespace,omitempty"` Function string `json:"function,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` IsEnabled bool `json:"is_enabled"` CreatedAt time.Time `json:"created_at,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` ScheduledDetails *TriggerScheduledDetails `json:"scheduled_details,omitempty"` ScheduledRuns *TriggerScheduledRuns `json:"scheduled_runs,omitempty"` }
ServerlessTrigger is the form used in list and get responses by the triggers API
type ServerlessTriggerGetResponse ¶ added in v1.82.0
type ServerlessTriggerGetResponse struct {
Trigger ServerlessTrigger `json:"Trigger,omitempty"`
}
ServerlessTriggerGetResponse is the form returned by the get trigger API
type ServerlessTriggerListResponse ¶ added in v1.82.0
type ServerlessTriggerListResponse struct {
Triggers []ServerlessTrigger `json:"Triggers,omitempty"`
}
ServerlessTriggerListResponse is the form returned by the list triggers API
type SizesService ¶
SizesService is the godo SizesService interface.
func NewSizesService ¶
func NewSizesService(client *godo.Client) SizesService
NewSizesService builds an instance of SizesService.
type SnapshotsService ¶ added in v1.6.0
type SnapshotsService interface { List() (Snapshots, error) ListVolume() (Snapshots, error) ListDroplet() (Snapshots, error) Get(string) (*Snapshot, error) Delete(string) error }
SnapshotsService is an interface for interacting with DigitalOcean's snapshot api.
func NewSnapshotsService ¶ added in v1.6.0
func NewSnapshotsService(client *godo.Client) SnapshotsService
NewSnapshotsService builds a SnapshotsService instance.
type TagsService ¶ added in v1.1.0
type TagsService interface { List() (Tags, error) Get(string) (*Tag, error) Create(*godo.TagCreateRequest) (*Tag, error) Delete(string) error TagResources(string, *godo.TagResourcesRequest) error UntagResources(string, *godo.UntagResourcesRequest) error }
TagsService is an interface for interacting with DigitalOcean's tags api.
func NewTagsService ¶ added in v1.1.0
func NewTagsService(godoClient *godo.Client) TagsService
NewTagsService builds a TagsService instance.
type TriggerScheduledDetails ¶ added in v1.86.0
type TriggerScheduledRuns ¶ added in v1.86.0
type UpdateTriggerRequest ¶ added in v1.89.0
type UpdateTriggerRequest struct { IsEnabled bool `json:"is_enabled"` ScheduledDetails *TriggerScheduledDetails `json:"scheduled_details,omitempty"` }
type UptimeAlert ¶ added in v1.100.0
type UptimeAlert struct {
*godo.UptimeAlert
}
UptimeAlert is a wrapper for godo.UptimeAlert.
type UptimeCheck ¶ added in v1.97.0
type UptimeCheck struct {
*godo.UptimeCheck
}
UptimeCheck is a wrapper for godo.UptimeCheck.
type UptimeCheckState ¶ added in v1.97.0
type UptimeCheckState struct {
*godo.UptimeCheckState
}
UptimeCheckState is a wrapper for godo.UptimeCheckState.
type UptimeChecksService ¶ added in v1.97.0
type UptimeChecksService interface { Create(*godo.CreateUptimeCheckRequest) (*UptimeCheck, error) List() ([]UptimeCheck, error) Get(string) (*UptimeCheck, error) GetState(string) (*UptimeCheckState, error) Update(string, *godo.UpdateUptimeCheckRequest) (*UptimeCheck, error) Delete(string) error CreateAlert(string, *godo.CreateUptimeAlertRequest) (*UptimeAlert, error) ListAlerts(string) ([]UptimeAlert, error) GetAlert(string, string) (*UptimeAlert, error) UpdateAlert(string, string, *godo.UpdateUptimeAlertRequest) (*UptimeAlert, error) DeleteAlert(string, string) error }
UptimeChecksService is an interface for interacting with DigitalOcean's uptime check api.
func NewUptimeChecksService ¶ added in v1.97.0
func NewUptimeChecksService(godoClient *godo.Client) UptimeChecksService
NewUptimeChecksService builds an NewUptimeChecksService instance.
type VPCsService ¶ added in v1.40.0
type VPCsService interface { Get(vpcUUID string) (*VPC, error) List() (VPCs, error) Create(vpcr *godo.VPCCreateRequest) (*VPC, error) Update(vpcUUID string, vpcr *godo.VPCUpdateRequest) (*VPC, error) PartialUpdate(vpcUUID string, options ...godo.VPCSetField) (*VPC, error) Delete(vpcUUID string) error }
VPCsService is the godo VPCsService interface.
func NewVPCsService ¶ added in v1.40.0
func NewVPCsService(client *godo.Client) VPCsService
NewVPCsService builds an instance of VPCsService.
type VolumeActionsService ¶ added in v1.3.0
type VolumeActionsService interface { Attach(string, int) (*Action, error) Detach(string, int) (*Action, error) Get(string, int) (*Action, error) List(string) ([]Action, error) Resize(string, int, string) (*Action, error) }
VolumeActionsService is an interface for interacting with DigitalOcean's volume-action api.
func NewVolumeActionsService ¶ added in v1.3.0
func NewVolumeActionsService(godoClient *godo.Client) VolumeActionsService
NewVolumeActionsService builds an VolumeActionsService instance.
type VolumesService ¶ added in v1.3.0
type VolumesService interface { List() ([]Volume, error) CreateVolume(*godo.VolumeCreateRequest) (*Volume, error) DeleteVolume(string) error Get(string) (*Volume, error) CreateSnapshot(*godo.SnapshotCreateRequest) (*Snapshot, error) GetSnapshot(string) (*Snapshot, error) DeleteSnapshot(string) error ListSnapshots(string, *godo.ListOptions) ([]Snapshot, error) }
VolumesService is an interface for interacting with DigitalOcean's volume api.
func NewVolumesService ¶ added in v1.3.0
func NewVolumesService(godoClient *godo.Client) VolumesService
NewVolumesService builds an NewVolumesService instance.
Source Files ¶
- 1_clicks.go
- account.go
- actions.go
- apps.go
- balance.go
- billing_history.go
- cdns.go
- certificates.go
- databases.go
- domains.go
- droplet_actions.go
- droplets.go
- firewalls.go
- image_actions.go
- images.go
- invoices.go
- kubernetes.go
- load_balancers.go
- monitoring.go
- oauth.go
- pagination.go
- projects.go
- regions.go
- registry.go
- reserved_ip_actions.go
- reserved_ips.go
- serverless.go
- sizes.go
- snapshots.go
- sshkeys.go
- tags.go
- uptime_checks.go
- volume_actions.go
- volumes.go
- vpcs.go