Documentation
¶
Overview ¶
Package godo is the DigtalOcean API v2 client for Go.
Index ¶
- Constants
- func Bool(v bool) *bool
- func CheckResponse(r *http.Response) error
- func DoRequest(ctx context.Context, req *http.Request) (*http.Response, error)
- func DoRequestWithClient(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)
- func Int(v int) *int
- func StreamToString(stream io.Reader) string
- func String(v string) *string
- func Stringify(message interface{}) string
- func ToURN(resourceType string, id interface{}) string
- type Account
- type AccountService
- type AccountServiceOp
- type Action
- type ActionRequest
- type ActionsService
- type ActionsServiceOp
- type Address
- type AlertDestinationUpdateRequest
- type AlertPolicy
- type AlertPolicyComp
- type AlertPolicyCreateRequest
- type AlertPolicyUpdateRequest
- type Alerts
- type App
- type AppAlert
- type AppAlertPhase
- type AppAlertProgress
- type AppAlertProgressStep
- type AppAlertProgressStepReason
- type AppAlertProgressStepStatus
- type AppAlertSlackWebhook
- type AppAlertSpec
- type AppAlertSpecOperator
- type AppAlertSpecRule
- type AppAlertSpecWindow
- type AppCORSPolicy
- type AppCreateRequest
- type AppDatabaseSpec
- type AppDatabaseSpecEngine
- type AppDomain
- type AppDomainPhase
- type AppDomainProgress
- type AppDomainProgressStep
- type AppDomainProgressStepReason
- type AppDomainProgressStepStatus
- type AppDomainSpec
- type AppDomainSpecType
- type AppInstanceSize
- type AppInstanceSizeCPUType
- type AppJobSpec
- type AppJobSpecKind
- type AppLogType
- type AppLogs
- type AppProposeRequest
- type AppProposeResponse
- type AppRegion
- type AppRouteSpec
- type AppServiceSpec
- type AppServiceSpecHealthCheck
- type AppSpec
- type AppStaticSiteSpec
- type AppStringMatch
- type AppTier
- type AppUpdateRequest
- type AppVariableDefinition
- type AppVariableScope
- type AppVariableType
- type AppWorkerSpec
- type AppsService
- type AppsServiceOp
- func (s *AppsServiceOp) Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error)
- func (s *AppsServiceOp) CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error)
- func (s *AppsServiceOp) Delete(ctx context.Context, appID string) (*Response, error)
- func (s *AppsServiceOp) Get(ctx context.Context, appID string) (*App, *Response, error)
- func (s *AppsServiceOp) GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error)
- func (s *AppsServiceOp) GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error)
- func (s *AppsServiceOp) GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, ...) (*AppLogs, *Response, error)
- func (s *AppsServiceOp) GetTier(ctx context.Context, slug string) (*AppTier, *Response, error)
- func (s *AppsServiceOp) List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error)
- func (s *AppsServiceOp) ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error)
- func (s *AppsServiceOp) ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error)
- func (s *AppsServiceOp) ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error)
- func (s *AppsServiceOp) ListRegions(ctx context.Context) ([]*AppRegion, *Response, error)
- func (s *AppsServiceOp) ListTiers(ctx context.Context) ([]*AppTier, *Response, error)
- func (s *AppsServiceOp) Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error)
- func (s *AppsServiceOp) Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error)
- func (s *AppsServiceOp) UpdateAlertDestinations(ctx context.Context, appID, alertID string, ...) (*AppAlert, *Response, error)
- type ArgError
- type AssociatedResource
- type BackupWindow
- type Balance
- type BalanceService
- type BalanceServiceOp
- type BillingHistory
- type BillingHistoryEntry
- type BillingHistoryService
- type BillingHistoryServiceOp
- type CDN
- type CDNCreateRequest
- type CDNFlushCacheRequest
- type CDNService
- type CDNServiceOp
- func (c CDNServiceOp) Create(ctx context.Context, createRequest *CDNCreateRequest) (*CDN, *Response, error)
- func (c CDNServiceOp) Delete(ctx context.Context, id string) (*Response, error)
- func (c CDNServiceOp) FlushCache(ctx context.Context, id string, flushCacheRequest *CDNFlushCacheRequest) (*Response, error)
- func (c CDNServiceOp) Get(ctx context.Context, id string) (*CDN, *Response, error)
- func (c CDNServiceOp) List(ctx context.Context, opt *ListOptions) ([]CDN, *Response, error)
- func (c CDNServiceOp) UpdateCustomDomain(ctx context.Context, id string, updateRequest *CDNUpdateCustomDomainRequest) (*CDN, *Response, error)
- func (c CDNServiceOp) UpdateTTL(ctx context.Context, id string, updateRequest *CDNUpdateTTLRequest) (*CDN, *Response, error)
- type CDNUpdateCustomDomainRequest
- type CDNUpdateTTLRequest
- type Certificate
- type CertificateRequest
- type CertificatesService
- type CertificatesServiceOp
- func (c *CertificatesServiceOp) Create(ctx context.Context, cr *CertificateRequest) (*Certificate, *Response, error)
- func (c *CertificatesServiceOp) Delete(ctx context.Context, cID string) (*Response, error)
- func (c *CertificatesServiceOp) Get(ctx context.Context, cID string) (*Certificate, *Response, error)
- func (c *CertificatesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Certificate, *Response, error)
- type Client
- func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)
- func (c *Client) GetRate() Rate
- func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
- func (c *Client) OnRequestCompleted(rc RequestCompletionCallback)
- type ClientOpt
- type ClusterlintDiagnostic
- type ClusterlintObject
- type ClusterlintOwner
- type CreateProjectRequest
- type CustomImageCreateRequest
- type Database
- type DatabaseBackup
- type DatabaseBackupRestore
- type DatabaseCA
- type DatabaseConnection
- type DatabaseCreateDBRequest
- type DatabaseCreatePoolRequest
- type DatabaseCreateReplicaRequest
- type DatabaseCreateRequest
- type DatabaseCreateUserRequest
- type DatabaseDB
- type DatabaseFirewallRule
- type DatabaseMaintenanceWindow
- type DatabaseMigrateRequest
- type DatabaseMySQLUserSettings
- type DatabasePool
- type DatabaseReplica
- type DatabaseResetUserAuthRequest
- type DatabaseResizeRequest
- type DatabaseUpdateFirewallRulesRequest
- type DatabaseUpdateMaintenanceRequest
- type DatabaseUser
- type DatabasesService
- type DatabasesServiceOp
- func (svc *DatabasesServiceOp) Create(ctx context.Context, create *DatabaseCreateRequest) (*Database, *Response, error)
- func (svc *DatabasesServiceOp) CreateDB(ctx context.Context, databaseID string, createDB *DatabaseCreateDBRequest) (*DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) CreatePool(ctx context.Context, databaseID string, createPool *DatabaseCreatePoolRequest) (*DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) CreateReplica(ctx context.Context, databaseID string, ...) (*DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) CreateUser(ctx context.Context, databaseID string, createUser *DatabaseCreateUserRequest) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Delete(ctx context.Context, databaseID string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteDB(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeletePool(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteReplica(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteUser(ctx context.Context, databaseID, userID string) (*Response, error)
- func (svc *DatabasesServiceOp) Get(ctx context.Context, databaseID string) (*Database, *Response, error)
- func (svc *DatabasesServiceOp) GetCA(ctx context.Context, databaseID string) (*DatabaseCA, *Response, error)
- func (svc *DatabasesServiceOp) GetDB(ctx context.Context, databaseID, name string) (*DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) GetEvictionPolicy(ctx context.Context, databaseID string) (string, *Response, error)
- func (svc *DatabasesServiceOp) GetFirewallRules(ctx context.Context, databaseID string) ([]DatabaseFirewallRule, *Response, error)
- func (svc *DatabasesServiceOp) GetPool(ctx context.Context, databaseID, name string) (*DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) GetReplica(ctx context.Context, databaseID, name string) (*DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) GetSQLMode(ctx context.Context, databaseID string) (string, *Response, error)
- func (svc *DatabasesServiceOp) GetUser(ctx context.Context, databaseID, userID string) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) List(ctx context.Context, opts *ListOptions) ([]Database, *Response, error)
- func (svc *DatabasesServiceOp) ListBackups(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseBackup, *Response, error)
- func (svc *DatabasesServiceOp) ListDBs(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) ListPools(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) ListReplicas(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) ListUsers(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Migrate(ctx context.Context, databaseID string, migrate *DatabaseMigrateRequest) (*Response, error)
- func (svc *DatabasesServiceOp) ResetUserAuth(ctx context.Context, databaseID, userID string, ...) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Resize(ctx context.Context, databaseID string, resize *DatabaseResizeRequest) (*Response, error)
- func (svc *DatabasesServiceOp) SetEvictionPolicy(ctx context.Context, databaseID, policy string) (*Response, error)
- func (svc *DatabasesServiceOp) SetSQLMode(ctx context.Context, databaseID string, sqlModes ...string) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateFirewallRules(ctx context.Context, databaseID string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateMaintenance(ctx context.Context, databaseID string, ...) (*Response, error)
- type Deployment
- type DeploymentCauseDetails
- type DeploymentCauseDetailsDigitalOceanUser
- type DeploymentCauseDetailsDigitalOceanUserAction
- type DeploymentCauseDetailsDigitalOceanUserActionName
- type DeploymentCauseDetailsGitPush
- type DeploymentCauseDetailsType
- type DeploymentCreateRequest
- type DeploymentJob
- type DeploymentPhase
- type DeploymentProgress
- type DeploymentProgressStep
- type DeploymentProgressStepReason
- type DeploymentProgressStepStatus
- type DeploymentService
- type DeploymentStaticSite
- type DeploymentWorker
- type Destinations
- type DockerCredentials
- type Domain
- type DomainCreateRequest
- type DomainRecord
- type DomainRecordEditRequest
- type DomainsService
- type DomainsServiceOp
- func (s *DomainsServiceOp) Create(ctx context.Context, createRequest *DomainCreateRequest) (*Domain, *Response, error)
- func (s *DomainsServiceOp) CreateRecord(ctx context.Context, domain string, createRequest *DomainRecordEditRequest) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Delete(ctx context.Context, name string) (*Response, error)
- func (s *DomainsServiceOp) DeleteRecord(ctx context.Context, domain string, id int) (*Response, error)
- func (s *DomainsServiceOp) EditRecord(ctx context.Context, domain string, id int, ...) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Get(ctx context.Context, name string) (*Domain, *Response, error)
- func (s DomainsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Domain, *Response, error)
- func (s *DomainsServiceOp) Record(ctx context.Context, domain string, id int) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Records(ctx context.Context, domain string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByName(ctx context.Context, domain, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByType(ctx context.Context, domain, ofType string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByTypeAndName(ctx context.Context, domain, ofType, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
- type Droplet
- type DropletActionsService
- type DropletActionsServiceOp
- func (s *DropletActionsServiceOp) ChangeKernel(ctx context.Context, id, kernelID int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) DisableBackups(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) DisableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) EnableBackups(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) EnableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) EnableIPv6(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) EnableIPv6ByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) EnablePrivateNetworking(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) EnablePrivateNetworkingByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) Get(ctx context.Context, dropletID, actionID int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) GetByURI(ctx context.Context, rawurl string) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) PasswordReset(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerCycle(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerCycleByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerOff(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerOffByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerOn(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) PowerOnByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) Reboot(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) RebuildByImageID(ctx context.Context, id, imageID int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) RebuildByImageSlug(ctx context.Context, id int, slug string) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) Rename(ctx context.Context, id int, name string) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) Resize(ctx context.Context, id int, sizeSlug string, resizeDisk bool) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) Restore(ctx context.Context, id, imageID int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) Shutdown(ctx context.Context, id int) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) ShutdownByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *DropletActionsServiceOp) Snapshot(ctx context.Context, id int, name string) (*Action, *Response, error)
- func (s *DropletActionsServiceOp) SnapshotByTag(ctx context.Context, tag string, name string) ([]Action, *Response, error)
- type DropletCreateImage
- type DropletCreateRequest
- type DropletCreateSSHKey
- type DropletCreateVolume
- type DropletMultiCreateRequest
- type DropletsService
- type DropletsServiceOp
- func (s *DropletsServiceOp) Actions(ctx context.Context, dropletID int, opt *ListOptions) ([]Action, *Response, error)
- func (s *DropletsServiceOp) Backups(ctx context.Context, dropletID int, opt *ListOptions) ([]Image, *Response, error)
- func (s *DropletsServiceOp) Create(ctx context.Context, createRequest *DropletCreateRequest) (*Droplet, *Response, error)
- func (s *DropletsServiceOp) CreateMultiple(ctx context.Context, createRequest *DropletMultiCreateRequest) ([]Droplet, *Response, error)
- func (s *DropletsServiceOp) Delete(ctx context.Context, dropletID int) (*Response, error)
- func (s *DropletsServiceOp) DeleteByTag(ctx context.Context, tag string) (*Response, error)
- func (s *DropletsServiceOp) Get(ctx context.Context, dropletID int) (*Droplet, *Response, error)
- func (s *DropletsServiceOp) Kernels(ctx context.Context, dropletID int, opt *ListOptions) ([]Kernel, *Response, error)
- func (s *DropletsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Droplet, *Response, error)
- func (s *DropletsServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Droplet, *Response, error)
- func (s *DropletsServiceOp) Neighbors(ctx context.Context, dropletID int) ([]Droplet, *Response, error)
- func (s *DropletsServiceOp) Snapshots(ctx context.Context, dropletID int, opt *ListOptions) ([]Image, *Response, error)
- type ErrorResponse
- type Firewall
- type FirewallRequest
- type FirewallRulesRequest
- type FirewallsService
- type FirewallsServiceOp
- func (fw *FirewallsServiceOp) AddDroplets(ctx context.Context, fID string, dropletIDs ...int) (*Response, error)
- func (fw *FirewallsServiceOp) AddRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
- func (fw *FirewallsServiceOp) AddTags(ctx context.Context, fID string, tags ...string) (*Response, error)
- func (fw *FirewallsServiceOp) Create(ctx context.Context, fr *FirewallRequest) (*Firewall, *Response, error)
- func (fw *FirewallsServiceOp) Delete(ctx context.Context, fID string) (*Response, error)
- func (fw *FirewallsServiceOp) Get(ctx context.Context, fID string) (*Firewall, *Response, error)
- func (fw *FirewallsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Firewall, *Response, error)
- func (fw *FirewallsServiceOp) ListByDroplet(ctx context.Context, dID int, opt *ListOptions) ([]Firewall, *Response, error)
- func (fw *FirewallsServiceOp) RemoveDroplets(ctx context.Context, fID string, dropletIDs ...int) (*Response, error)
- func (fw *FirewallsServiceOp) RemoveRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
- func (fw *FirewallsServiceOp) RemoveTags(ctx context.Context, fID string, tags ...string) (*Response, error)
- func (fw *FirewallsServiceOp) Update(ctx context.Context, fID string, fr *FirewallRequest) (*Firewall, *Response, error)
- type FloatingIP
- type FloatingIPActionsService
- type FloatingIPActionsServiceOp
- func (s *FloatingIPActionsServiceOp) Assign(ctx context.Context, ip string, dropletID int) (*Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) Get(ctx context.Context, ip string, actionID int) (*Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) List(ctx context.Context, ip string, opt *ListOptions) ([]Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) Unassign(ctx context.Context, ip string) (*Action, *Response, error)
- type FloatingIPCreateRequest
- type FloatingIPsService
- type FloatingIPsServiceOp
- func (f *FloatingIPsServiceOp) Create(ctx context.Context, createRequest *FloatingIPCreateRequest) (*FloatingIP, *Response, error)
- func (f *FloatingIPsServiceOp) Delete(ctx context.Context, ip string) (*Response, error)
- func (f *FloatingIPsServiceOp) Get(ctx context.Context, ip string) (*FloatingIP, *Response, error)
- func (f *FloatingIPsServiceOp) List(ctx context.Context, opt *ListOptions) ([]FloatingIP, *Response, error)
- type ForwardingRule
- type GarbageCollection
- type GarbageCollectionType
- type GitHubSourceSpec
- type GitLabSourceSpec
- type GitSourceSpec
- type HealthCheck
- type Image
- type ImageActionsService
- type ImageActionsServiceOp
- func (i *ImageActionsServiceOp) Convert(ctx context.Context, imageID int) (*Action, *Response, error)
- func (i *ImageActionsServiceOp) Get(ctx context.Context, imageID, actionID int) (*Action, *Response, error)
- func (i *ImageActionsServiceOp) Transfer(ctx context.Context, imageID int, transferRequest *ActionRequest) (*Action, *Response, error)
- type ImageSourceSpec
- type ImageSourceSpecRegistryType
- type ImageUpdateRequest
- type ImagesService
- type ImagesServiceOp
- func (s *ImagesServiceOp) Create(ctx context.Context, createRequest *CustomImageCreateRequest) (*Image, *Response, error)
- func (s *ImagesServiceOp) Delete(ctx context.Context, imageID int) (*Response, error)
- func (s *ImagesServiceOp) GetByID(ctx context.Context, imageID int) (*Image, *Response, error)
- func (s *ImagesServiceOp) GetBySlug(ctx context.Context, slug string) (*Image, *Response, error)
- func (s *ImagesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListApplication(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListDistribution(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListUser(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) Update(ctx context.Context, imageID int, updateRequest *ImageUpdateRequest) (*Image, *Response, error)
- type InboundRule
- type InstallKubernetesAppsRequest
- type InstallKubernetesAppsResponse
- type Invoice
- type InvoiceItem
- type InvoiceList
- type InvoiceListItem
- type InvoiceSummary
- type InvoiceSummaryBreakdown
- type InvoiceSummaryBreakdownItem
- type InvoicesService
- type InvoicesServiceOp
- func (s *InvoicesServiceOp) Get(ctx context.Context, invoiceUUID string, opt *ListOptions) (*Invoice, *Response, error)
- func (s *InvoicesServiceOp) GetCSV(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
- func (s *InvoicesServiceOp) GetPDF(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
- func (s *InvoicesServiceOp) GetSummary(ctx context.Context, invoiceUUID string) (*InvoiceSummary, *Response, error)
- func (s *InvoicesServiceOp) List(ctx context.Context, opt *ListOptions) (*InvoiceList, *Response, error)
- type Kernel
- type Key
- type KeyCreateRequest
- type KeyUpdateRequest
- type KeysService
- type KeysServiceOp
- func (s *KeysServiceOp) Create(ctx context.Context, createRequest *KeyCreateRequest) (*Key, *Response, error)
- func (s *KeysServiceOp) DeleteByFingerprint(ctx context.Context, fingerprint string) (*Response, error)
- func (s *KeysServiceOp) DeleteByID(ctx context.Context, keyID int) (*Response, error)
- func (s *KeysServiceOp) GetByFingerprint(ctx context.Context, fingerprint string) (*Key, *Response, error)
- func (s *KeysServiceOp) GetByID(ctx context.Context, keyID int) (*Key, *Response, error)
- func (s *KeysServiceOp) List(ctx context.Context, opt *ListOptions) ([]Key, *Response, error)
- func (s *KeysServiceOp) UpdateByFingerprint(ctx context.Context, fingerprint string, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
- func (s *KeysServiceOp) UpdateByID(ctx context.Context, keyID int, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
- type KubernetesAssociatedResources
- type KubernetesCluster
- type KubernetesClusterConfig
- type KubernetesClusterCreateRequest
- type KubernetesClusterCredentials
- type KubernetesClusterCredentialsGetRequest
- type KubernetesClusterDeleteSelectiveRequest
- type KubernetesClusterRegistryRequest
- type KubernetesClusterStatus
- type KubernetesClusterStatusState
- type KubernetesClusterUpdateRequest
- type KubernetesClusterUpgradeRequest
- type KubernetesClusterUser
- type KubernetesGetClusterlintRequest
- type KubernetesMaintenancePolicy
- type KubernetesMaintenancePolicyDay
- type KubernetesNode
- type KubernetesNodeDeleteRequest
- type KubernetesNodePool
- type KubernetesNodePoolCreateRequest
- type KubernetesNodePoolRecycleNodesRequest
- type KubernetesNodePoolUpdateRequest
- type KubernetesNodeSize
- type KubernetesNodeStatus
- type KubernetesOptions
- type KubernetesRegion
- type KubernetesRunClusterlintRequest
- type KubernetesService
- type KubernetesServiceOp
- func (svc *KubernetesServiceOp) AddRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
- func (svc *KubernetesServiceOp) Create(ctx context.Context, create *KubernetesClusterCreateRequest) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) CreateNodePool(ctx context.Context, clusterID string, create *KubernetesNodePoolCreateRequest) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) Delete(ctx context.Context, clusterID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteDangerous(ctx context.Context, clusterID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteNode(ctx context.Context, clusterID, poolID, nodeID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteNodePool(ctx context.Context, clusterID, poolID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteSelective(ctx context.Context, clusterID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) Get(ctx context.Context, clusterID string) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) GetClusterlintResults(ctx context.Context, clusterID string, req *KubernetesGetClusterlintRequest) ([]*ClusterlintDiagnostic, *Response, error)
- func (svc *KubernetesServiceOp) GetCredentials(ctx context.Context, clusterID string, ...) (*KubernetesClusterCredentials, *Response, error)
- func (svc *KubernetesServiceOp) GetKubeConfig(ctx context.Context, clusterID string) (*KubernetesClusterConfig, *Response, error)
- func (svc *KubernetesServiceOp) GetKubeConfigWithExpiry(ctx context.Context, clusterID string, expirySeconds int64) (*KubernetesClusterConfig, *Response, error)
- func (svc *KubernetesServiceOp) GetNodePool(ctx context.Context, clusterID, poolID string) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) GetOptions(ctx context.Context) (*KubernetesOptions, *Response, error)
- func (svc *KubernetesServiceOp) GetUpgrades(ctx context.Context, clusterID string) ([]*KubernetesVersion, *Response, error)
- func (svc *KubernetesServiceOp) GetUser(ctx context.Context, clusterID string) (*KubernetesClusterUser, *Response, error)
- func (svc *KubernetesServiceOp) List(ctx context.Context, opts *ListOptions) ([]*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) ListAssociatedResourcesForDeletion(ctx context.Context, clusterID string) (*KubernetesAssociatedResources, *Response, error)
- func (svc *KubernetesServiceOp) ListNodePools(ctx context.Context, clusterID string, opts *ListOptions) ([]*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) RecycleNodePoolNodes(ctx context.Context, clusterID, poolID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) RemoveRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
- func (svc *KubernetesServiceOp) RunClusterlint(ctx context.Context, clusterID string, req *KubernetesRunClusterlintRequest) (string, *Response, error)
- func (svc *KubernetesServiceOp) Update(ctx context.Context, clusterID string, update *KubernetesClusterUpdateRequest) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) UpdateNodePool(ctx context.Context, clusterID, poolID string, ...) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) Upgrade(ctx context.Context, clusterID string, ...) (*Response, error)
- type KubernetesVersion
- type LinkAction
- type Links
- type ListOptions
- type ListVolumeParams
- type LoadBalancer
- type LoadBalancerRequest
- type LoadBalancersService
- type LoadBalancersServiceOp
- func (l *LoadBalancersServiceOp) AddDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error)
- func (l *LoadBalancersServiceOp) AddForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
- func (l *LoadBalancersServiceOp) Create(ctx context.Context, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) Delete(ctx context.Context, ldID string) (*Response, error)
- func (l *LoadBalancersServiceOp) Get(ctx context.Context, lbID string) (*LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) List(ctx context.Context, opt *ListOptions) ([]LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) RemoveDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error)
- func (l *LoadBalancersServiceOp) RemoveForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
- func (l *LoadBalancersServiceOp) Update(ctx context.Context, lbID string, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
- type Meta
- type MonitoringService
- type MonitoringServiceOp
- func (s *MonitoringServiceOp) CreateAlertPolicy(ctx context.Context, createRequest *AlertPolicyCreateRequest) (*AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) DeleteAlertPolicy(ctx context.Context, uuid string) (*Response, error)
- func (s *MonitoringServiceOp) GetAlertPolicy(ctx context.Context, uuid string) (*AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) ListAlertPolicies(ctx context.Context, opt *ListOptions) ([]AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) UpdateAlertPolicy(ctx context.Context, uuid string, updateRequest *AlertPolicyUpdateRequest) (*AlertPolicy, *Response, error)
- type NetworkV4
- type NetworkV6
- type Networks
- type OneClick
- type OneClickService
- type OneClickServiceOp
- type OneClicksRoot
- type OutboundRule
- type Pages
- type PendingChange
- type Project
- type ProjectResource
- type ProjectResourceLinks
- type ProjectsService
- type ProjectsServiceOp
- func (p *ProjectsServiceOp) AssignResources(ctx context.Context, projectID string, resources ...interface{}) ([]ProjectResource, *Response, error)
- func (p *ProjectsServiceOp) Create(ctx context.Context, cr *CreateProjectRequest) (*Project, *Response, error)
- func (p *ProjectsServiceOp) Delete(ctx context.Context, projectID string) (*Response, error)
- func (p *ProjectsServiceOp) Get(ctx context.Context, projectID string) (*Project, *Response, error)
- func (p *ProjectsServiceOp) GetDefault(ctx context.Context) (*Project, *Response, error)
- func (p *ProjectsServiceOp) List(ctx context.Context, opts *ListOptions) ([]Project, *Response, error)
- func (p *ProjectsServiceOp) ListResources(ctx context.Context, projectID string, opts *ListOptions) ([]ProjectResource, *Response, error)
- func (p *ProjectsServiceOp) Update(ctx context.Context, projectID string, ur *UpdateProjectRequest) (*Project, *Response, error)
- type Rate
- type Region
- type RegionsService
- type RegionsServiceOp
- type Registry
- type RegistryCreateRequest
- type RegistryDockerCredentialsRequest
- type RegistryOptions
- type RegistryService
- type RegistryServiceOp
- func (svc *RegistryServiceOp) Create(ctx context.Context, create *RegistryCreateRequest) (*Registry, *Response, error)
- func (svc *RegistryServiceOp) Delete(ctx context.Context) (*Response, error)
- func (svc *RegistryServiceOp) DeleteManifest(ctx context.Context, registry, repository, digest string) (*Response, error)
- func (svc *RegistryServiceOp) DeleteTag(ctx context.Context, registry, repository, tag string) (*Response, error)
- func (svc *RegistryServiceOp) DockerCredentials(ctx context.Context, request *RegistryDockerCredentialsRequest) (*DockerCredentials, *Response, error)
- func (svc *RegistryServiceOp) Get(ctx context.Context) (*Registry, *Response, error)
- func (svc *RegistryServiceOp) GetGarbageCollection(ctx context.Context, registry string) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) GetOptions(ctx context.Context) (*RegistryOptions, *Response, error)
- func (svc *RegistryServiceOp) GetSubscription(ctx context.Context) (*RegistrySubscription, *Response, error)
- func (svc *RegistryServiceOp) ListGarbageCollections(ctx context.Context, registry string, opts *ListOptions) ([]*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) ListRepositories(ctx context.Context, registry string, opts *ListOptions) ([]*Repository, *Response, error)
- func (svc *RegistryServiceOp) ListRepositoryTags(ctx context.Context, registry, repository string, opts *ListOptions) ([]*RepositoryTag, *Response, error)
- func (svc *RegistryServiceOp) StartGarbageCollection(ctx context.Context, registry string, ...) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) UpdateGarbageCollection(ctx context.Context, registry, gcUUID string, ...) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) UpdateSubscription(ctx context.Context, request *RegistrySubscriptionUpdateRequest) (*RegistrySubscription, *Response, error)
- type RegistrySubscription
- type RegistrySubscriptionTier
- type RegistrySubscriptionUpdateRequest
- type Repository
- type RepositoryTag
- type RequestCompletionCallback
- type Resource
- type ResourceType
- type ResourceWithURN
- type Response
- type Size
- type SizesService
- type SizesServiceOp
- type SlackDetails
- type Snapshot
- type SnapshotCreateRequest
- type SnapshotsService
- type SnapshotsServiceOp
- func (s *SnapshotsServiceOp) Delete(ctx context.Context, snapshotID string) (*Response, error)
- func (s *SnapshotsServiceOp) Get(ctx context.Context, snapshotID string) (*Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) ListDroplet(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) ListVolume(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- type Sources
- type StartGarbageCollectionRequest
- type StickySessions
- type StorageActionsService
- type StorageActionsServiceOp
- func (s *StorageActionsServiceOp) Attach(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) DetachByDropletID(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) Get(ctx context.Context, volumeID string, actionID int) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) List(ctx context.Context, volumeID string, opt *ListOptions) ([]Action, *Response, error)
- func (s *StorageActionsServiceOp) Resize(ctx context.Context, volumeID string, sizeGigabytes int, regionSlug string) (*Action, *Response, error)
- type StorageAttachment
- type StorageService
- type StorageServiceOp
- func (svc *StorageServiceOp) CreateSnapshot(ctx context.Context, createRequest *SnapshotCreateRequest) (*Snapshot, *Response, error)
- func (svc *StorageServiceOp) CreateVolume(ctx context.Context, createRequest *VolumeCreateRequest) (*Volume, *Response, error)
- func (svc *StorageServiceOp) DeleteSnapshot(ctx context.Context, id string) (*Response, error)
- func (svc *StorageServiceOp) DeleteVolume(ctx context.Context, id string) (*Response, error)
- func (svc *StorageServiceOp) GetSnapshot(ctx context.Context, id string) (*Snapshot, *Response, error)
- func (svc *StorageServiceOp) GetVolume(ctx context.Context, id string) (*Volume, *Response, error)
- func (svc *StorageServiceOp) ListSnapshots(ctx context.Context, volumeID string, opt *ListOptions) ([]Snapshot, *Response, error)
- func (svc *StorageServiceOp) ListVolumes(ctx context.Context, params *ListVolumeParams) ([]Volume, *Response, error)
- type Tag
- type TagCreateRequest
- type TagResourcesRequest
- type TaggedDatabasesResources
- type TaggedDropletsResources
- type TaggedImagesResources
- type TaggedResources
- type TaggedResourcesData
- type TaggedVolumeSnapshotsResources
- type TaggedVolumesResources
- type TagsService
- type TagsServiceOp
- func (s *TagsServiceOp) Create(ctx context.Context, createRequest *TagCreateRequest) (*Tag, *Response, error)
- func (s *TagsServiceOp) Delete(ctx context.Context, name string) (*Response, error)
- func (s *TagsServiceOp) Get(ctx context.Context, name string) (*Tag, *Response, error)
- func (s *TagsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Tag, *Response, error)
- func (s *TagsServiceOp) TagResources(ctx context.Context, name string, tagRequest *TagResourcesRequest) (*Response, error)
- func (s *TagsServiceOp) UntagResources(ctx context.Context, name string, untagRequest *UntagResourcesRequest) (*Response, error)
- type Taint
- type Timestamp
- type UntagResourcesRequest
- type UpdateGarbageCollectionRequest
- type UpdateProjectRequest
- type VPC
- type VPCCreateRequest
- type VPCListMembersRequest
- type VPCMember
- type VPCSetDescription
- type VPCSetField
- type VPCSetName
- type VPCUpdateRequest
- type VPCsService
- type VPCsServiceOp
- func (v *VPCsServiceOp) Create(ctx context.Context, create *VPCCreateRequest) (*VPC, *Response, error)
- func (v *VPCsServiceOp) Delete(ctx context.Context, id string) (*Response, error)
- func (v *VPCsServiceOp) Get(ctx context.Context, id string) (*VPC, *Response, error)
- func (v *VPCsServiceOp) List(ctx context.Context, opt *ListOptions) ([]*VPC, *Response, error)
- func (v *VPCsServiceOp) ListMembers(ctx context.Context, id string, request *VPCListMembersRequest, ...) ([]*VPCMember, *Response, error)
- func (v *VPCsServiceOp) Set(ctx context.Context, id string, fields ...VPCSetField) (*VPC, *Response, error)
- func (v *VPCsServiceOp) Update(ctx context.Context, id string, update *VPCUpdateRequest) (*VPC, *Response, error)
- type Volume
- type VolumeCreateRequest
Constants ¶
const ( // ActionInProgress is an in progress action status ActionInProgress = "in-progress" //ActionCompleted is a completed action status ActionCompleted = "completed" )
const ( SQLModeAllowInvalidDates = "ALLOW_INVALID_DATES" SQLModeANSIQuotes = "ANSI_QUOTES" SQLModeHighNotPrecedence = "HIGH_NOT_PRECEDENCE" SQLModeIgnoreSpace = "IGNORE_SPACE" SQLModeNoAuthCreateUser = "NO_AUTO_CREATE_USER" SQLModeNoAutoValueOnZero = "NO_AUTO_VALUE_ON_ZERO" SQLModeNoBackslashEscapes = "NO_BACKSLASH_ESCAPES" SQLModeNoDirInCreate = "NO_DIR_IN_CREATE" SQLModeNoEngineSubstitution = "NO_ENGINE_SUBSTITUTION" SQLModeNoFieldOptions = "NO_FIELD_OPTIONS" SQLModeNoKeyOptions = "NO_KEY_OPTIONS" SQLModeNoTableOptions = "NO_TABLE_OPTIONS" SQLModeNoUnsignedSubtraction = "NO_UNSIGNED_SUBTRACTION" SQLModeNoZeroDate = "NO_ZERO_DATE" SQLModeNoZeroInDate = "NO_ZERO_IN_DATE" SQLModeOnlyFullGroupBy = "ONLY_FULL_GROUP_BY" SQLModePadCharToFullLength = "PAD_CHAR_TO_FULL_LENGTH" SQLModePipesAsConcat = "PIPES_AS_CONCAT" SQLModeRealAsFloat = "REAL_AS_FLOAT" SQLModeStrictAllTables = "STRICT_ALL_TABLES" SQLModeStrictTransTables = "STRICT_TRANS_TABLES" SQLModeANSI = "ANSI" SQLModeDB2 = "DB2" SQLModeMaxDB = "MAXDB" SQLModeMSSQL = "MSSQL" SQLModeMYSQL323 = "MYSQL323" SQLModeMYSQL40 = "MYSQL40" SQLModeOracle = "ORACLE" SQLModePostgreSQL = "POSTGRESQL" SQLModeTraditional = "TRADITIONAL" )
SQL Mode constants allow for MySQL-specific SQL flavor configuration.
const ( SQLAuthPluginNative = "mysql_native_password" SQLAuthPluginCachingSHA2 = "caching_sha2_password" )
SQL Auth constants allow for MySQL-specific user auth plugins
const ( EvictionPolicyNoEviction = "noeviction" EvictionPolicyAllKeysLRU = "allkeys_lru" EvictionPolicyAllKeysRandom = "allkeys_random" EvictionPolicyVolatileLRU = "volatile_lru" EvictionPolicyVolatileRandom = "volatile_random" EvictionPolicyVolatileTTL = "volatile_ttl" )
Redis eviction policies supported by the managed Redis product.
const ( KubernetesClusterStatusProvisioning = KubernetesClusterStatusState("provisioning") KubernetesClusterStatusRunning = KubernetesClusterStatusState("running") KubernetesClusterStatusDegraded = KubernetesClusterStatusState("degraded") KubernetesClusterStatusError = KubernetesClusterStatusState("error") KubernetesClusterStatusDeleted = KubernetesClusterStatusState("deleted") KubernetesClusterStatusUpgrading = KubernetesClusterStatusState("upgrading") KubernetesClusterStatusInvalid = KubernetesClusterStatusState("invalid") )
Possible states for a cluster.
const ( DropletCPUUtilizationPercent = "v1/insights/droplet/cpu" DropletMemoryUtilizationPercent = "v1/insights/droplet/memory_utilization_percent" DropletDiskUtilizationPercent = "v1/insights/droplet/disk_utilization_percent" DropletPublicOutboundBandwidthRate = "v1/insights/droplet/public_outbound_bandwidth" DropletPublicInboundBandwidthRate = "v1/insights/droplet/public_inbound_bandwidth" DropletPrivateOutboundBandwidthRate = "v1/insights/droplet/private_outbound_bandwidth" DropletPrivateInboundBandwidthRate = "v1/insights/droplet/private_inbound_bandwidth" DropletDiskReadRate = "v1/insights/droplet/disk_read" DropletDiskWriteRate = "v1/insights/droplet/disk_write" DropletOneMinuteLoadAverage = "v1/insights/droplet/load_1" DropletFiveMinuteLoadAverage = "v1/insights/droplet/load_5" DropletFifteenMinuteLoadAverage = "v1/insights/droplet/load_15" )
const ( // GCTypeUntaggedManifestsOnly indicates that a garbage collection should // only delete untagged manifests. GCTypeUntaggedManifestsOnly = GarbageCollectionType("untagged manifests only") // GCTypeUnreferencedBlobsOnly indicates that a garbage collection should // only delete unreferenced blobs. GCTypeUnreferencedBlobsOnly = GarbageCollectionType("unreferenced blobs only") // GCTypeUntaggedManifestsAndUnreferencedBlobs indicates that a garbage // collection should delete both untagged manifests and unreferenced blobs. GCTypeUntaggedManifestsAndUnreferencedBlobs = GarbageCollectionType("untagged manifests and unreferenced blobs") )
const ( // DefaultProject is the ID you should use if you are working with your // default project. DefaultProject = "default" )
const (
// RegistryServer is the hostname of the DigitalOcean registry service
RegistryServer = "registry.digitalocean.com"
)
Variables ¶
This section is empty.
Functions ¶
func Bool ¶
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
func CheckResponse ¶
CheckResponse checks the API response for errors, and returns them if present. A response is considered an error if it has a status code outside the 200 range. API error responses are expected to have either no response body, or a JSON response body that maps to ErrorResponse. Any other response body will be silently ignored. If the API error response does not include the request ID in its body, the one from its header will be used.
func DoRequestWithClient ¶ added in v1.2.0
func DoRequestWithClient( ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)
DoRequestWithClient submits an HTTP request using the specified client.
func Int ¶
Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.
func StreamToString ¶
StreamToString converts a reader to a string
func String ¶
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
Types ¶
type Account ¶ added in v0.9.0
type Account struct { DropletLimit int `json:"droplet_limit,omitempty"` FloatingIPLimit int `json:"floating_ip_limit,omitempty"` VolumeLimit int `json:"volume_limit,omitempty"` Email string `json:"email,omitempty"` UUID string `json:"uuid,omitempty"` EmailVerified bool `json:"email_verified,omitempty"` Status string `json:"status,omitempty"` StatusMessage string `json:"status_message,omitempty"` }
Account represents a DigitalOcean Account
type AccountService ¶ added in v0.9.0
AccountService is an interface for interfacing with the Account endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Account
type AccountServiceOp ¶ added in v0.9.0
type AccountServiceOp struct {
// contains filtered or unexported fields
}
AccountServiceOp handles communication with the Account related methods of the DigitalOcean API.
type Action ¶
type Action struct { ID int `json:"id"` Status string `json:"status"` Type string `json:"type"` StartedAt *Timestamp `json:"started_at"` CompletedAt *Timestamp `json:"completed_at"` ResourceID int `json:"resource_id"` ResourceType string `json:"resource_type"` Region *Region `json:"region,omitempty"` RegionSlug string `json:"region_slug,omitempty"` }
Action represents a DigitalOcean Action
type ActionRequest ¶
type ActionRequest map[string]interface{}
ActionRequest reprents DigitalOcean Action Request
type ActionsService ¶
type ActionsService interface { List(context.Context, *ListOptions) ([]Action, *Response, error) Get(context.Context, int) (*Action, *Response, error) }
ActionsService handles communction with action related methods of the DigitalOcean API: https://docs.digitalocean.com/reference/api/api-reference/#tag/Actions
type ActionsServiceOp ¶ added in v0.3.0
type ActionsServiceOp struct {
// contains filtered or unexported fields
}
ActionsServiceOp handles communition with the image action related methods of the DigitalOcean API.
func (*ActionsServiceOp) List ¶ added in v0.3.0
func (s *ActionsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Action, *Response, error)
List all actions
type Address ¶ added in v1.67.0
type Address struct { AddressLine1 string `json:"address_line1"` AddressLine2 string `json:"address_line2"` City string `json:"city"` Region string `json:"region"` PostalCode string `json:"postal_code"` CountryISO2Code string `json:"country_iso2_code"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` }
Address represents the billing address of a customer
type AlertDestinationUpdateRequest ¶ added in v1.67.0
type AlertDestinationUpdateRequest struct { Emails []string `json:"emails"` SlackWebhooks []*AppAlertSlackWebhook `json:"slack_webhooks"` }
AlertDestinationUpdateRequest represents a request to update alert destinations.
type AlertPolicy ¶ added in v1.67.0
type AlertPolicy struct { UUID string `json:"uuid"` Type string `json:"type"` Description string `json:"description"` Compare AlertPolicyComp `json:"compare"` Value float32 `json:"value"` Window string `json:"window"` Entities []string `json:"entities"` Tags []string `json:"tags"` Alerts Alerts `json:"alerts"` Enabled bool `json:"enabled"` }
AlertPolicy represents a DigitalOcean alert policy
type AlertPolicyComp ¶ added in v1.67.0
type AlertPolicyComp string
AlertPolicyComp represents an alert policy comparison operation
const ( // GreaterThan is the comparison > GreaterThan AlertPolicyComp = "GreaterThan" // LessThan is the comparison < LessThan AlertPolicyComp = "LessThan" )
type AlertPolicyCreateRequest ¶ added in v1.67.0
type AlertPolicyCreateRequest struct { Type string `json:"type"` Description string `json:"description"` Compare AlertPolicyComp `json:"compare"` Value float32 `json:"value"` Window string `json:"window"` Entities []string `json:"entities"` Tags []string `json:"tags"` Alerts Alerts `json:"alerts"` Enabled *bool `json:"enabled"` }
AlertPolicyCreateRequest holds the info for creating a new alert policy
type AlertPolicyUpdateRequest ¶ added in v1.67.0
type AlertPolicyUpdateRequest struct { Type string `json:"type"` Description string `json:"description"` Compare AlertPolicyComp `json:"compare"` Value float32 `json:"value"` Window string `json:"window"` Entities []string `json:"entities"` Tags []string `json:"tags"` Alerts Alerts `json:"alerts"` Enabled *bool `json:"enabled"` }
AlertPolicyUpdateRequest holds the info for updating an existing alert policy
type Alerts ¶ added in v1.67.0
type Alerts struct { Slack []SlackDetails `json:"slack"` Email []string `json:"email"` }
Alerts represents the alerts section of an alert policy
type App ¶ added in v1.67.0
type App struct { ID string `json:"id,omitempty"` OwnerUUID string `json:"owner_uuid,omitempty"` Spec *AppSpec `json:"spec"` LastDeploymentActiveAt time.Time `json:"last_deployment_active_at,omitempty"` DefaultIngress string `json:"default_ingress,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` ActiveDeployment *Deployment `json:"active_deployment,omitempty"` InProgressDeployment *Deployment `json:"in_progress_deployment,omitempty"` LastDeploymentCreatedAt time.Time `json:"last_deployment_created_at,omitempty"` LiveURL string `json:"live_url,omitempty"` Region *AppRegion `json:"region,omitempty"` TierSlug string `json:"tier_slug,omitempty"` LiveURLBase string `json:"live_url_base,omitempty"` LiveDomain string `json:"live_domain,omitempty"` Domains []*AppDomain `json:"domains,omitempty"` }
App An application's configuration and status.
type AppAlert ¶ added in v1.67.0
type AppAlert struct { ID string `json:"id,omitempty"` ComponentName string `json:"component_name,omitempty"` Spec *AppAlertSpec `json:"spec,omitempty"` Emails []string `json:"emails,omitempty"` SlackWebhooks []*AppAlertSlackWebhook `json:"slack_webhooks,omitempty"` Phase AppAlertPhase `json:"phase,omitempty"` Progress *AppAlertProgress `json:"progress,omitempty"` }
AppAlert struct for AppAlert
type AppAlertPhase ¶ added in v1.67.0
type AppAlertPhase string
AppAlertPhase the model 'AppAlertPhase'
const ( AppAlertPhase_Unknown AppAlertPhase = "UNKNOWN" AppAlertPhase_Pending AppAlertPhase = "PENDING" AppAlertPhase_Configuring AppAlertPhase = "CONFIGURING" AppAlertPhase_Active AppAlertPhase = "ACTIVE" AppAlertPhase_Error AppAlertPhase = "ERROR" )
List of AppAlertPhase
type AppAlertProgress ¶ added in v1.67.0
type AppAlertProgress struct {
Steps []*AppAlertProgressStep `json:"steps,omitempty"`
}
AppAlertProgress struct for AppAlertProgress
type AppAlertProgressStep ¶ added in v1.67.0
type AppAlertProgressStep struct { Name string `json:"name,omitempty"` Status AppAlertProgressStepStatus `json:"status,omitempty"` Steps []*AppAlertProgressStep `json:"steps,omitempty"` StartedAt time.Time `json:"started_at,omitempty"` EndedAt time.Time `json:"ended_at,omitempty"` Reason *AppAlertProgressStepReason `json:"reason,omitempty"` }
AppAlertProgressStep struct for AppAlertProgressStep
type AppAlertProgressStepReason ¶ added in v1.67.0
type AppAlertProgressStepReason struct { Code string `json:"code,omitempty"` Message string `json:"message,omitempty"` }
AppAlertProgressStepReason struct for AppAlertProgressStepReason
type AppAlertProgressStepStatus ¶ added in v1.67.0
type AppAlertProgressStepStatus string
AppAlertProgressStepStatus the model 'AppAlertProgressStepStatus'
const ( AppAlertProgressStepStatus_Unknown AppAlertProgressStepStatus = "UNKNOWN" AppAlertProgressStepStatus_Pending AppAlertProgressStepStatus = "PENDING" AppAlertProgressStepStatus_Running AppAlertProgressStepStatus = "RUNNING" AppAlertProgressStepStatus_Error AppAlertProgressStepStatus = "ERROR" AppAlertProgressStepStatus_Success AppAlertProgressStepStatus = "SUCCESS" )
List of AppAlertProgressStepStatus
type AppAlertSlackWebhook ¶ added in v1.67.0
type AppAlertSlackWebhook struct { URL string `json:"url,omitempty"` Channel string `json:"channel,omitempty"` }
AppAlertSlackWebhook struct for AppAlertSlackWebhook
type AppAlertSpec ¶ added in v1.67.0
type AppAlertSpec struct { Rule AppAlertSpecRule `json:"rule,omitempty"` Disabled bool `json:"disabled,omitempty"` Operator AppAlertSpecOperator `json:"operator,omitempty"` Value float32 `json:"value,omitempty"` Window AppAlertSpecWindow `json:"window,omitempty"` }
AppAlertSpec struct for AppAlertSpec
type AppAlertSpecOperator ¶ added in v1.67.0
type AppAlertSpecOperator string
AppAlertSpecOperator the model 'AppAlertSpecOperator'
const ( AppAlertSpecOperator_UnspecifiedOperator AppAlertSpecOperator = "UNSPECIFIED_OPERATOR" AppAlertSpecOperator_GreaterThan AppAlertSpecOperator = "GREATER_THAN" AppAlertSpecOperator_LessThan AppAlertSpecOperator = "LESS_THAN" )
List of AppAlertSpecOperator
type AppAlertSpecRule ¶ added in v1.67.0
type AppAlertSpecRule string
AppAlertSpecRule the model 'AppAlertSpecRule'
const ( AppAlertSpecRule_UnspecifiedRule AppAlertSpecRule = "UNSPECIFIED_RULE" AppAlertSpecRule_CPUUtilization AppAlertSpecRule = "CPU_UTILIZATION" AppAlertSpecRule_MemUtilization AppAlertSpecRule = "MEM_UTILIZATION" AppAlertSpecRule_RestartCount AppAlertSpecRule = "RESTART_COUNT" AppAlertSpecRule_DeploymentFailed AppAlertSpecRule = "DEPLOYMENT_FAILED" AppAlertSpecRule_DeploymentLive AppAlertSpecRule = "DEPLOYMENT_LIVE" AppAlertSpecRule_DomainFailed AppAlertSpecRule = "DOMAIN_FAILED" AppAlertSpecRule_DomainLive AppAlertSpecRule = "DOMAIN_LIVE" )
List of AppAlertSpecRule
type AppAlertSpecWindow ¶ added in v1.67.0
type AppAlertSpecWindow string
AppAlertSpecWindow the model 'AppAlertSpecWindow'
const ( AppAlertSpecWindow_UnspecifiedWindow AppAlertSpecWindow = "UNSPECIFIED_WINDOW" AppAlertSpecWindow_FiveMinutes AppAlertSpecWindow = "FIVE_MINUTES" AppAlertSpecWindow_TenMinutes AppAlertSpecWindow = "TEN_MINUTES" AppAlertSpecWindow_ThirtyMinutes AppAlertSpecWindow = "THIRTY_MINUTES" AppAlertSpecWindow_OneHour AppAlertSpecWindow = "ONE_HOUR" )
List of AppAlertSpecWindow
type AppCORSPolicy ¶ added in v1.67.0
type AppCORSPolicy struct { // The set of allowed CORS origins. This configures the Access-Control-Allow-Origin header. AllowOrigins []*AppStringMatch `json:"allow_origins,omitempty"` // The set of allowed HTTP methods. This configures the Access-Control-Allow-Methods header. AllowMethods []string `json:"allow_methods,omitempty"` // The set of allowed HTTP request headers. This configures the Access-Control-Allow-Headers header. AllowHeaders []string `json:"allow_headers,omitempty"` // The set of HTTP response headers that browsers are allowed to access. This configures the Access-Control-Expose-Headers header. ExposeHeaders []string `json:"expose_headers,omitempty"` // An optional duration specifiying how long browsers can cache the results of a preflight request. This configures the Access-Control-Max-Age header. Example: `5h30m`. MaxAge string `json:"max_age,omitempty"` // Whether browsers should expose the response to the client-side JavaScript code when the request's credentials mode is `include`. This configures the Access-Control-Allow-Credentials header. AllowCredentials bool `json:"allow_credentials,omitempty"` }
AppCORSPolicy struct for AppCORSPolicy
type AppCreateRequest ¶ added in v1.67.0
type AppCreateRequest struct {
Spec *AppSpec `json:"spec"`
}
AppCreateRequest struct for AppCreateRequest
type AppDatabaseSpec ¶ added in v1.67.0
type AppDatabaseSpec struct { // The name. Must be unique across all components within the same app. Name string `json:"name"` Engine AppDatabaseSpecEngine `json:"engine,omitempty"` Version string `json:"version,omitempty"` // Deprecated. Size string `json:"size,omitempty"` // Deprecated. NumNodes int64 `json:"num_nodes,omitempty"` // Whether this is a production or dev database. Production bool `json:"production,omitempty"` // The name of the underlying DigitalOcean DBaaS cluster. This is required for production databases. For dev databases, if cluster_name is not set, a new cluster will be provisioned. ClusterName string `json:"cluster_name,omitempty"` // The name of the MySQL or PostgreSQL database to configure. DBName string `json:"db_name,omitempty"` // The name of the MySQL or PostgreSQL user to configure. DBUser string `json:"db_user,omitempty"` }
AppDatabaseSpec struct for AppDatabaseSpec
type AppDatabaseSpecEngine ¶ added in v1.67.0
type AppDatabaseSpecEngine string
AppDatabaseSpecEngine the model 'AppDatabaseSpecEngine'
const ( AppDatabaseSpecEngine_Unset AppDatabaseSpecEngine = "UNSET" AppDatabaseSpecEngine_MySQL AppDatabaseSpecEngine = "MYSQL" AppDatabaseSpecEngine_PG AppDatabaseSpecEngine = "PG" AppDatabaseSpecEngine_Redis AppDatabaseSpecEngine = "REDIS" AppDatabaseSpecEngine_MongoDB AppDatabaseSpecEngine = "MONGODB" )
List of AppDatabaseSpecEngine
type AppDomain ¶ added in v1.67.0
type AppDomain struct { ID string `json:"id,omitempty"` Spec *AppDomainSpec `json:"spec,omitempty"` Phase AppDomainPhase `json:"phase,omitempty"` Progress *AppDomainProgress `json:"progress,omitempty"` }
AppDomain struct for AppDomain
type AppDomainPhase ¶ added in v1.67.0
type AppDomainPhase string
AppDomainPhase the model 'AppDomainPhase'
const ( AppJobSpecKindPHASE_Unknown AppDomainPhase = "UNKNOWN" AppJobSpecKindPHASE_Pending AppDomainPhase = "PENDING" AppJobSpecKindPHASE_Configuring AppDomainPhase = "CONFIGURING" AppJobSpecKindPHASE_Active AppDomainPhase = "ACTIVE" AppJobSpecKindPHASE_Error AppDomainPhase = "ERROR" )
List of AppDomainPhase
type AppDomainProgress ¶ added in v1.67.0
type AppDomainProgress struct {
Steps []*AppDomainProgressStep `json:"steps,omitempty"`
}
AppDomainProgress struct for AppDomainProgress
type AppDomainProgressStep ¶ added in v1.67.0
type AppDomainProgressStep struct { Name string `json:"name,omitempty"` Status AppDomainProgressStepStatus `json:"status,omitempty"` Steps []*AppDomainProgressStep `json:"steps,omitempty"` StartedAt time.Time `json:"started_at,omitempty"` EndedAt time.Time `json:"ended_at,omitempty"` Reason *AppDomainProgressStepReason `json:"reason,omitempty"` }
AppDomainProgressStep struct for AppDomainProgressStep
type AppDomainProgressStepReason ¶ added in v1.67.0
type AppDomainProgressStepReason struct { Code string `json:"code,omitempty"` Message string `json:"message,omitempty"` }
AppDomainProgressStepReason struct for AppDomainProgressStepReason
type AppDomainProgressStepStatus ¶ added in v1.67.0
type AppDomainProgressStepStatus string
AppDomainProgressStepStatus the model 'AppDomainProgressStepStatus'
const ( AppJobSpecKindProgressStepStatus_Unknown AppDomainProgressStepStatus = "UNKNOWN" AppJobSpecKindProgressStepStatus_Pending AppDomainProgressStepStatus = "PENDING" AppJobSpecKindProgressStepStatus_Running AppDomainProgressStepStatus = "RUNNING" AppJobSpecKindProgressStepStatus_Error AppDomainProgressStepStatus = "ERROR" AppJobSpecKindProgressStepStatus_Success AppDomainProgressStepStatus = "SUCCESS" )
List of AppDomainProgressStepStatus
type AppDomainSpec ¶ added in v1.67.0
type AppDomainSpec struct { Domain string `json:"domain"` Type AppDomainSpecType `json:"type,omitempty"` Wildcard bool `json:"wildcard,omitempty"` // Optional. If the domain uses DigitalOcean DNS and you would like App Platform to automatically manage it for you, set this to the name of the domain on your account. For example, If the domain you are adding is `app.domain.com`, the zone could be `domain.com`. Zone string `json:"zone,omitempty"` }
AppDomainSpec struct for AppDomainSpec
type AppDomainSpecType ¶ added in v1.67.0
type AppDomainSpecType string
AppDomainSpecType the model 'AppDomainSpecType'
const ( AppDomainSpecType_Unspecified AppDomainSpecType = "UNSPECIFIED" AppDomainSpecType_Default AppDomainSpecType = "DEFAULT" AppDomainSpecType_Primary AppDomainSpecType = "PRIMARY" AppDomainSpecType_Alias AppDomainSpecType = "ALIAS" )
List of AppDomainSpecType
type AppInstanceSize ¶ added in v1.67.0
type AppInstanceSize struct { Name string `json:"name,omitempty"` Slug string `json:"slug,omitempty"` CPUType AppInstanceSizeCPUType `json:"cpu_type,omitempty"` CPUs string `json:"cpus,omitempty"` MemoryBytes string `json:"memory_bytes,omitempty"` USDPerMonth string `json:"usd_per_month,omitempty"` USDPerSecond string `json:"usd_per_second,omitempty"` TierSlug string `json:"tier_slug,omitempty"` TierUpgradeTo string `json:"tier_upgrade_to,omitempty"` TierDowngradeTo string `json:"tier_downgrade_to,omitempty"` }
AppInstanceSize struct for AppInstanceSize
type AppInstanceSizeCPUType ¶ added in v1.67.0
type AppInstanceSizeCPUType string
AppInstanceSizeCPUType the model 'AppInstanceSizeCPUType'
const ( AppInstanceSizeCPUType_Unspecified AppInstanceSizeCPUType = "UNSPECIFIED" AppInstanceSizeCPUType_Dedicated AppInstanceSizeCPUType = "DEDICATED" )
List of AppInstanceSizeCPUType
type AppJobSpec ¶ added in v1.67.0
type AppJobSpec struct { // The name. Must be unique across all components within the same app. Name string `json:"name"` Git *GitSourceSpec `json:"git,omitempty"` GitHub *GitHubSourceSpec `json:"github,omitempty"` Image *ImageSourceSpec `json:"image,omitempty"` GitLab *GitLabSourceSpec `json:"gitlab,omitempty"` // The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks. DockerfilePath string `json:"dockerfile_path,omitempty"` // An optional build command to run while building this component from source. BuildCommand string `json:"build_command,omitempty"` // An optional run command to override the component's default. RunCommand string `json:"run_command,omitempty"` // An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo. SourceDir string `json:"source_dir,omitempty"` // An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). EnvironmentSlug string `json:"environment_slug,omitempty"` // A list of environment variables made available to the component. Envs []*AppVariableDefinition `json:"envs,omitempty"` // The instance size to use for this component. InstanceSizeSlug string `json:"instance_size_slug,omitempty"` InstanceCount int64 `json:"instance_count,omitempty"` Kind AppJobSpecKind `json:"kind,omitempty"` Alerts []*AppAlertSpec `json:"alerts,omitempty"` }
AppJobSpec struct for AppJobSpec
type AppJobSpecKind ¶ added in v1.67.0
type AppJobSpecKind string
AppJobSpecKind - UNSPECIFIED: Default job type, will auto-complete to POST_DEPLOY kind. - PRE_DEPLOY: Indicates a job that runs before an app deployment. - POST_DEPLOY: Indicates a job that runs after an app deployment. - FAILED_DEPLOY: Indicates a job that runs after a component fails to deploy.
const ( AppJobSpecKind_Unspecified AppJobSpecKind = "UNSPECIFIED" AppJobSpecKind_PreDeploy AppJobSpecKind = "PRE_DEPLOY" AppJobSpecKind_PostDeploy AppJobSpecKind = "POST_DEPLOY" AppJobSpecKind_FailedDeploy AppJobSpecKind = "FAILED_DEPLOY" )
List of AppJobSpecKind
type AppLogType ¶ added in v1.67.0
type AppLogType string
AppLogType is the type of app logs.
const ( // AppLogTypeBuild represents build logs. AppLogTypeBuild AppLogType = "BUILD" // AppLogTypeDeploy represents deploy logs. AppLogTypeDeploy AppLogType = "DEPLOY" // AppLogTypeRun represents run logs. AppLogTypeRun AppLogType = "RUN" )
type AppLogs ¶ added in v1.67.0
type AppLogs struct { LiveURL string `json:"live_url"` HistoricURLs []string `json:"historic_urls"` }
AppLogs represent app logs.
type AppProposeRequest ¶ added in v1.67.0
type AppProposeRequest struct { Spec *AppSpec `json:"spec"` // An optional ID of an existing app. If set, the spec will be treated as a proposed update to the specified app. The existing app is not modified using this method. AppID string `json:"app_id,omitempty"` }
AppProposeRequest struct for AppProposeRequest
type AppProposeResponse ¶ added in v1.67.0
type AppProposeResponse struct { AppIsStatic bool `json:"app_is_static,omitempty"` AppNameAvailable bool `json:"app_name_available,omitempty"` // If the app name is unavailable, this will be set to a suggested available name. AppNameSuggestion string `json:"app_name_suggestion,omitempty"` // The number of existing static apps the account has. ExistingStaticApps string `json:"existing_static_apps,omitempty"` // The maximum number of free static apps the account can have. Any additional static apps will be charged for. MaxFreeStaticApps string `json:"max_free_static_apps,omitempty"` Spec *AppSpec `json:"spec,omitempty"` AppCost float32 `json:"app_cost,omitempty"` // The monthly cost of the proposed app in USD using the next pricing plan tier. For example, if you propose an app that uses the Basic tier, the `app_tier_upgrade_cost` field displays the monthly cost of the app if it were to use the Professional tier. If the proposed app already uses the most expensive tier, the field is empty. AppTierUpgradeCost float32 `json:"app_tier_upgrade_cost,omitempty"` // The monthly cost of the proposed app in USD using the previous pricing plan tier. For example, if you propose an app that uses the Professional tier, the `app_tier_downgrade_cost` field displays the monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty. AppTierDowngradeCost float32 `json:"app_tier_downgrade_cost,omitempty"` }
AppProposeResponse struct for AppProposeResponse
type AppRegion ¶ added in v1.67.0
type AppRegion struct { Slug string `json:"slug,omitempty"` Label string `json:"label,omitempty"` Flag string `json:"flag,omitempty"` Continent string `json:"continent,omitempty"` Disabled bool `json:"disabled,omitempty"` DataCenters []string `json:"data_centers,omitempty"` Reason string `json:"reason,omitempty"` // Whether or not the region is presented as the default. Default bool `json:"default,omitempty"` }
AppRegion struct for AppRegion
type AppRouteSpec ¶ added in v1.67.0
type AppRouteSpec struct { // An HTTP path prefix. Paths must start with / and must be unique across all components within an app. Path string `json:"path,omitempty"` }
AppRouteSpec struct for AppRouteSpec
type AppServiceSpec ¶ added in v1.67.0
type AppServiceSpec struct { // The name. Must be unique across all components within the same app. Name string `json:"name"` Git *GitSourceSpec `json:"git,omitempty"` GitHub *GitHubSourceSpec `json:"github,omitempty"` Image *ImageSourceSpec `json:"image,omitempty"` GitLab *GitLabSourceSpec `json:"gitlab,omitempty"` // The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks. DockerfilePath string `json:"dockerfile_path,omitempty"` // An optional build command to run while building this component from source. BuildCommand string `json:"build_command,omitempty"` // An optional run command to override the component's default. RunCommand string `json:"run_command,omitempty"` // An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo. SourceDir string `json:"source_dir,omitempty"` // An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). EnvironmentSlug string `json:"environment_slug,omitempty"` // A list of environment variables made available to the component. Envs []*AppVariableDefinition `json:"envs,omitempty"` InstanceSizeSlug string `json:"instance_size_slug,omitempty"` InstanceCount int64 `json:"instance_count,omitempty"` // The internal port on which this service's run command will listen. Default: 8080 If there is not an environment variable with the name `PORT`, one will be automatically added with its value set to the value of this field. HTTPPort int64 `json:"http_port,omitempty"` // A list of HTTP routes that should be routed to this component. Routes []*AppRouteSpec `json:"routes,omitempty"` HealthCheck *AppServiceSpecHealthCheck `json:"health_check,omitempty"` CORS *AppCORSPolicy `json:"cors,omitempty"` // The ports on which this service will listen for internal traffic. InternalPorts []int64 `json:"internal_ports,omitempty"` Alerts []*AppAlertSpec `json:"alerts,omitempty"` }
AppServiceSpec struct for AppServiceSpec
type AppServiceSpecHealthCheck ¶ added in v1.67.0
type AppServiceSpecHealthCheck struct { // Deprecated. Use http_path instead. Path string `json:"path,omitempty"` // The number of seconds to wait before beginning health checks. InitialDelaySeconds int32 `json:"initial_delay_seconds,omitempty"` // The number of seconds to wait between health checks. PeriodSeconds int32 `json:"period_seconds,omitempty"` // The number of seconds after which the check times out. TimeoutSeconds int32 `json:"timeout_seconds,omitempty"` // The number of successful health checks before considered healthy. SuccessThreshold int32 `json:"success_threshold,omitempty"` // The number of failed health checks before considered unhealthy. FailureThreshold int32 `json:"failure_threshold,omitempty"` // The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead. HTTPPath string `json:"http_path,omitempty"` }
AppServiceSpecHealthCheck struct for AppServiceSpecHealthCheck
type AppSpec ¶ added in v1.67.0
type AppSpec struct { // The name of the app. Must be unique across all apps in the same account. Name string `json:"name"` // Workloads which expose publicy-accessible HTTP services. Services []*AppServiceSpec `json:"services,omitempty"` // Content which can be rendered to static web assets. StaticSites []*AppStaticSiteSpec `json:"static_sites,omitempty"` // Workloads which do not expose publicly-accessible HTTP services. Workers []*AppWorkerSpec `json:"workers,omitempty"` // Pre and post deployment workloads which do not expose publicly-accessible HTTP routes. Jobs []*AppJobSpec `json:"jobs,omitempty"` // Database instances which can provide persistence to workloads within the application. Databases []*AppDatabaseSpec `json:"databases,omitempty"` // A set of hostnames where the application will be available. Domains []*AppDomainSpec `json:"domains,omitempty"` Region string `json:"region,omitempty"` // A list of environment variables made available to all components in the app. Envs []*AppVariableDefinition `json:"envs,omitempty"` Alerts []*AppAlertSpec `json:"alerts,omitempty"` }
AppSpec The desired configuration of an application.
type AppStaticSiteSpec ¶ added in v1.67.0
type AppStaticSiteSpec struct { // The name. Must be unique across all components within the same app. Name string `json:"name"` Git *GitSourceSpec `json:"git,omitempty"` GitHub *GitHubSourceSpec `json:"github,omitempty"` GitLab *GitLabSourceSpec `json:"gitlab,omitempty"` // The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks. DockerfilePath string `json:"dockerfile_path,omitempty"` // An optional build command to run while building this component from source. BuildCommand string `json:"build_command,omitempty"` // An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo. SourceDir string `json:"source_dir,omitempty"` // An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). EnvironmentSlug string `json:"environment_slug,omitempty"` // An optional path to where the built assets will be located, relative to the build context. If not set, App Platform will automatically scan for these directory names: `_static`, `dist`, `public`, `build`. OutputDir string `json:"output_dir,omitempty"` IndexDocument string `json:"index_document,omitempty"` // The name of the error document to use when serving this static site. Default: 404.html. If no such file exists within the built assets, App Platform will supply one. ErrorDocument string `json:"error_document,omitempty"` // A list of environment variables made available to the component. Envs []*AppVariableDefinition `json:"envs,omitempty"` // A list of HTTP routes that should be routed to this component. Routes []*AppRouteSpec `json:"routes,omitempty"` CORS *AppCORSPolicy `json:"cors,omitempty"` // The name of the document to use as the fallback for any requests to documents that are not found when serving this static site. Only 1 of `catchall_document` or `error_document` can be set. CatchallDocument string `json:"catchall_document,omitempty"` }
AppStaticSiteSpec struct for AppStaticSiteSpec
type AppStringMatch ¶ added in v1.67.0
type AppStringMatch struct { // Exact string match. Only 1 of `exact`, `prefix`, or `regex` must be set. Exact string `json:"exact,omitempty"` // Prefix-based match. Only 1 of `exact`, `prefix`, or `regex` must be set. Prefix string `json:"prefix,omitempty"` Regex string `json:"regex,omitempty"` }
AppStringMatch struct for AppStringMatch
type AppTier ¶ added in v1.67.0
type AppTier struct { Name string `json:"name,omitempty"` Slug string `json:"slug,omitempty"` EgressBandwidthBytes string `json:"egress_bandwidth_bytes,omitempty"` BuildSeconds string `json:"build_seconds,omitempty"` }
AppTier struct for AppTier
type AppUpdateRequest ¶ added in v1.67.0
type AppUpdateRequest struct {
Spec *AppSpec `json:"spec"`
}
AppUpdateRequest represents a request to update an app.
type AppVariableDefinition ¶ added in v1.67.0
type AppVariableDefinition struct { // The name Key string `json:"key"` // The value. If the type is `SECRET`, the value will be encrypted on first submission. On following submissions, the encrypted value should be used. Value string `json:"value,omitempty"` Scope AppVariableScope `json:"scope,omitempty"` Type AppVariableType `json:"type,omitempty"` }
AppVariableDefinition struct for AppVariableDefinition
type AppVariableScope ¶ added in v1.67.0
type AppVariableScope string
AppVariableScope the model 'AppVariableScope'
const ( AppVariableScope_Unset AppVariableScope = "UNSET" AppVariableScope_RunTime AppVariableScope = "RUN_TIME" AppVariableScope_BuildTime AppVariableScope = "BUILD_TIME" AppVariableScope_RunAndBuildTime AppVariableScope = "RUN_AND_BUILD_TIME" )
List of AppVariableScope
type AppVariableType ¶ added in v1.67.0
type AppVariableType string
AppVariableType the model 'AppVariableType'
const ( AppVariableType_General AppVariableType = "GENERAL" AppVariableType_Secret AppVariableType = "SECRET" )
List of AppVariableType
type AppWorkerSpec ¶ added in v1.67.0
type AppWorkerSpec struct { // The name. Must be unique across all components within the same app. Name string `json:"name"` Git *GitSourceSpec `json:"git,omitempty"` GitHub *GitHubSourceSpec `json:"github,omitempty"` Image *ImageSourceSpec `json:"image,omitempty"` GitLab *GitLabSourceSpec `json:"gitlab,omitempty"` // The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks. DockerfilePath string `json:"dockerfile_path,omitempty"` // An optional build command to run while building this component from source. BuildCommand string `json:"build_command,omitempty"` // An optional run command to override the component's default. RunCommand string `json:"run_command,omitempty"` // An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo. SourceDir string `json:"source_dir,omitempty"` // An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). EnvironmentSlug string `json:"environment_slug,omitempty"` // A list of environment variables made available to the component. Envs []*AppVariableDefinition `json:"envs,omitempty"` // The instance size to use for this component. InstanceSizeSlug string `json:"instance_size_slug,omitempty"` InstanceCount int64 `json:"instance_count,omitempty"` Alerts []*AppAlertSpec `json:"alerts,omitempty"` }
AppWorkerSpec struct for AppWorkerSpec
type AppsService ¶ added in v1.67.0
type AppsService interface { Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error) Get(ctx context.Context, appID string) (*App, *Response, error) List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error) Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error) Delete(ctx context.Context, appID string) (*Response, error) Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error) GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error) ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error) CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error) GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, follow bool, tailLines int) (*AppLogs, *Response, error) ListRegions(ctx context.Context) ([]*AppRegion, *Response, error) ListTiers(ctx context.Context) ([]*AppTier, *Response, error) GetTier(ctx context.Context, slug string) (*AppTier, *Response, error) ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error) GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error) ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error) UpdateAlertDestinations(ctx context.Context, appID, alertID string, update *AlertDestinationUpdateRequest) (*AppAlert, *Response, error) }
AppsService is an interface for interfacing with the App Platform endpoints of the DigitalOcean API.
type AppsServiceOp ¶ added in v1.67.0
type AppsServiceOp struct {
// contains filtered or unexported fields
}
AppsServiceOp handles communication with Apps methods of the DigitalOcean API.
func (*AppsServiceOp) Create ¶ added in v1.67.0
func (s *AppsServiceOp) Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error)
Create an app.
func (*AppsServiceOp) CreateDeployment ¶ added in v1.67.0
func (s *AppsServiceOp) CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error)
CreateDeployment creates an app deployment.
func (*AppsServiceOp) GetDeployment ¶ added in v1.67.0
func (s *AppsServiceOp) GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error)
GetDeployment gets an app deployment.
func (*AppsServiceOp) GetInstanceSize ¶ added in v1.67.0
func (s *AppsServiceOp) GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error)
GetInstanceSize retreives information about a specific instance size for service, worker, and job components.
func (*AppsServiceOp) GetLogs ¶ added in v1.67.0
func (s *AppsServiceOp) GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, follow bool, tailLines int) (*AppLogs, *Response, error)
GetLogs retrieves app logs.
func (*AppsServiceOp) GetTier ¶ added in v1.67.0
GetTier retrieves information about a specific app tier.
func (*AppsServiceOp) List ¶ added in v1.67.0
func (s *AppsServiceOp) List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error)
List apps.
func (*AppsServiceOp) ListAlerts ¶ added in v1.67.0
func (s *AppsServiceOp) ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error)
ListAlerts retrieves a list of alerts on an app
func (*AppsServiceOp) ListDeployments ¶ added in v1.67.0
func (s *AppsServiceOp) ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error)
ListDeployments lists an app deployments.
func (*AppsServiceOp) ListInstanceSizes ¶ added in v1.67.0
func (s *AppsServiceOp) ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error)
ListInstanceSizes lists available instance sizes for service, worker, and job components.
func (*AppsServiceOp) ListRegions ¶ added in v1.67.0
ListRegions lists all regions supported by App Platform.
func (*AppsServiceOp) Propose ¶ added in v1.67.0
func (s *AppsServiceOp) Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error)
Propose an app.
func (*AppsServiceOp) Update ¶ added in v1.67.0
func (s *AppsServiceOp) Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error)
Update an app.
func (*AppsServiceOp) UpdateAlertDestinations ¶ added in v1.67.0
func (s *AppsServiceOp) UpdateAlertDestinations(ctx context.Context, appID, alertID string, update *AlertDestinationUpdateRequest) (*AppAlert, *Response, error)
UpdateAlertDestinations updates the alert destinations of an app's alert
type ArgError ¶ added in v0.9.0
type ArgError struct {
// contains filtered or unexported fields
}
ArgError is an error that represents an error with an input to godo. It identifies the argument and the cause (if possible).
func NewArgError ¶ added in v0.9.0
NewArgError creates an InputError.
type AssociatedResource ¶ added in v1.67.0
AssociatedResource is the object to represent a Kubernetes cluster associated resource's Id and Name.
type BackupWindow ¶ added in v1.0.0
type BackupWindow struct { Start *Timestamp `json:"start,omitempty"` End *Timestamp `json:"end,omitempty"` }
BackupWindow object
type Balance ¶ added in v1.67.0
type Balance struct { MonthToDateBalance string `json:"month_to_date_balance"` AccountBalance string `json:"account_balance"` MonthToDateUsage string `json:"month_to_date_usage"` GeneratedAt time.Time `json:"generated_at"` }
Balance represents a DigitalOcean Balance
type BalanceService ¶ added in v1.67.0
BalanceService is an interface for interfacing with the Balance endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#operation/get_customer_balance
type BalanceServiceOp ¶ added in v1.67.0
type BalanceServiceOp struct {
// contains filtered or unexported fields
}
BalanceServiceOp handles communication with the Balance related methods of the DigitalOcean API.
type BillingHistory ¶ added in v1.67.0
type BillingHistory struct { BillingHistory []BillingHistoryEntry `json:"billing_history"` Links *Links `json:"links"` Meta *Meta `json:"meta"` }
BillingHistory represents a DigitalOcean Billing History
func (BillingHistory) String ¶ added in v1.67.0
func (b BillingHistory) String() string
type BillingHistoryEntry ¶ added in v1.67.0
type BillingHistoryEntry struct { Description string `json:"description"` Amount string `json:"amount"` InvoiceID *string `json:"invoice_id"` InvoiceUUID *string `json:"invoice_uuid"` Date time.Time `json:"date"` Type string `json:"type"` }
BillingHistoryEntry represents an entry in a customer's Billing History
type BillingHistoryService ¶ added in v1.67.0
type BillingHistoryService interface {
List(context.Context, *ListOptions) (*BillingHistory, *Response, error)
}
BillingHistoryService is an interface for interfacing with the BillingHistory endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#operation/list_billing_history
type BillingHistoryServiceOp ¶ added in v1.67.0
type BillingHistoryServiceOp struct {
// contains filtered or unexported fields
}
BillingHistoryServiceOp handles communication with the BillingHistory related methods of the DigitalOcean API.
func (*BillingHistoryServiceOp) List ¶ added in v1.67.0
func (s *BillingHistoryServiceOp) List(ctx context.Context, opt *ListOptions) (*BillingHistory, *Response, error)
List the Billing History for a customer
type CDN ¶ added in v1.4.0
type CDN struct { ID string `json:"id"` Origin string `json:"origin"` Endpoint string `json:"endpoint"` CreatedAt time.Time `json:"created_at"` TTL uint32 `json:"ttl"` CertificateID string `json:"certificate_id,omitempty"` CustomDomain string `json:"custom_domain,omitempty"` }
CDN represents a DigitalOcean CDN
type CDNCreateRequest ¶ added in v1.4.0
type CDNCreateRequest struct { Origin string `json:"origin"` TTL uint32 `json:"ttl"` CustomDomain string `json:"custom_domain,omitempty"` CertificateID string `json:"certificate_id,omitempty"` }
CDNCreateRequest represents a request to create a CDN.
type CDNFlushCacheRequest ¶ added in v1.4.0
type CDNFlushCacheRequest struct {
Files []string `json:"files"`
}
CDNFlushCacheRequest represents a request to flush cache of a CDN.
type CDNService ¶ added in v1.4.0
type CDNService interface { List(context.Context, *ListOptions) ([]CDN, *Response, error) Get(context.Context, string) (*CDN, *Response, error) Create(context.Context, *CDNCreateRequest) (*CDN, *Response, error) UpdateTTL(context.Context, string, *CDNUpdateTTLRequest) (*CDN, *Response, error) UpdateCustomDomain(context.Context, string, *CDNUpdateCustomDomainRequest) (*CDN, *Response, error) FlushCache(context.Context, string, *CDNFlushCacheRequest) (*Response, error) Delete(context.Context, string) (*Response, error) }
CDNService is an interface for managing Spaces CDN with the DigitalOcean API.
type CDNServiceOp ¶ added in v1.4.0
type CDNServiceOp struct {
// contains filtered or unexported fields
}
CDNServiceOp handles communication with the CDN related methods of the DigitalOcean API.
func (CDNServiceOp) Create ¶ added in v1.4.0
func (c CDNServiceOp) Create(ctx context.Context, createRequest *CDNCreateRequest) (*CDN, *Response, error)
Create a new CDN
func (CDNServiceOp) FlushCache ¶ added in v1.4.0
func (c CDNServiceOp) FlushCache(ctx context.Context, id string, flushCacheRequest *CDNFlushCacheRequest) (*Response, error)
FlushCache flushes the cache of an individual CDN. Requires a non-empty slice of file paths and/or wildcards
func (CDNServiceOp) List ¶ added in v1.4.0
func (c CDNServiceOp) List(ctx context.Context, opt *ListOptions) ([]CDN, *Response, error)
List all CDN endpoints
func (CDNServiceOp) UpdateCustomDomain ¶ added in v1.7.5
func (c CDNServiceOp) UpdateCustomDomain(ctx context.Context, id string, updateRequest *CDNUpdateCustomDomainRequest) (*CDN, *Response, error)
UpdateCustomDomain sets or removes the custom domain of an individual CDN
func (CDNServiceOp) UpdateTTL ¶ added in v1.4.0
func (c CDNServiceOp) UpdateTTL(ctx context.Context, id string, updateRequest *CDNUpdateTTLRequest) (*CDN, *Response, error)
UpdateTTL updates the ttl of an individual CDN
type CDNUpdateCustomDomainRequest ¶ added in v1.7.5
type CDNUpdateCustomDomainRequest struct { CustomDomain string `json:"custom_domain"` CertificateID string `json:"certificate_id"` }
CDNUpdateCustomDomainRequest represents a request to update the custom domain of a CDN.
type CDNUpdateTTLRequest ¶ added in v1.7.5
type CDNUpdateTTLRequest struct {
TTL uint32 `json:"ttl"`
}
CDNUpdateTTLRequest represents a request to update the ttl of a CDN.
type Certificate ¶ added in v1.0.0
type Certificate struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` DNSNames []string `json:"dns_names,omitempty"` NotAfter string `json:"not_after,omitempty"` SHA1Fingerprint string `json:"sha1_fingerprint,omitempty"` Created string `json:"created_at,omitempty"` State string `json:"state,omitempty"` Type string `json:"type,omitempty"` }
Certificate represents a DigitalOcean certificate configuration.
type CertificateRequest ¶ added in v1.0.0
type CertificateRequest struct { Name string `json:"name,omitempty"` DNSNames []string `json:"dns_names,omitempty"` PrivateKey string `json:"private_key,omitempty"` LeafCertificate string `json:"leaf_certificate,omitempty"` CertificateChain string `json:"certificate_chain,omitempty"` Type string `json:"type,omitempty"` }
CertificateRequest represents configuration for a new certificate.
type CertificatesService ¶ added in v1.0.0
type CertificatesService interface { Get(context.Context, string) (*Certificate, *Response, error) List(context.Context, *ListOptions) ([]Certificate, *Response, error) Create(context.Context, *CertificateRequest) (*Certificate, *Response, error) Delete(context.Context, string) (*Response, error) }
CertificatesService is an interface for managing certificates with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Certificates
type CertificatesServiceOp ¶ added in v1.0.0
type CertificatesServiceOp struct {
// contains filtered or unexported fields
}
CertificatesServiceOp handles communication with certificates methods of the DigitalOcean API.
func (*CertificatesServiceOp) Create ¶ added in v1.0.0
func (c *CertificatesServiceOp) Create(ctx context.Context, cr *CertificateRequest) (*Certificate, *Response, error)
Create a new certificate with provided configuration.
func (*CertificatesServiceOp) Get ¶ added in v1.0.0
func (c *CertificatesServiceOp) Get(ctx context.Context, cID string) (*Certificate, *Response, error)
Get an existing certificate by its identifier.
func (*CertificatesServiceOp) List ¶ added in v1.0.0
func (c *CertificatesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Certificate, *Response, error)
List all certificates.
type Client ¶
type Client struct { // Base URL for API requests. BaseURL *url.URL // User agent for client UserAgent string // Rate contains the current rate limit for the client as determined by the most recent // API call. It is not thread-safe. Please consider using GetRate() instead. Rate Rate // Services used for communicating with the API Account AccountService Actions ActionsService Apps AppsService Balance BalanceService BillingHistory BillingHistoryService CDNs CDNService Domains DomainsService Droplets DropletsService DropletActions DropletActionsService Images ImagesService ImageActions ImageActionsService Invoices InvoicesService Keys KeysService Regions RegionsService Sizes SizesService FloatingIPs FloatingIPsService FloatingIPActions FloatingIPActionsService Snapshots SnapshotsService Storage StorageService StorageActions StorageActionsService Tags TagsService LoadBalancers LoadBalancersService Certificates CertificatesService Firewalls FirewallsService Projects ProjectsService Kubernetes KubernetesService Registry RegistryService Databases DatabasesService VPCs VPCsService OneClick OneClickService Monitoring MonitoringService // contains filtered or unexported fields }
Client manages communication with DigitalOcean V2 API.
func NewClient ¶
NewClient returns a new DigitalOcean API client, using the given http.Client to perform all requests.
Users who wish to pass their own http.Client should use this method. If you're in need of further customization, the godo.New method allows more options, such as setting a custom URL or a custom user agent string.
func NewFromToken ¶ added in v1.67.0
NewFromToken returns a new DigitalOcean API client with the given API token.
func (*Client) Do ¶
Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response will be written to v, without attempting to decode it.
func (*Client) GetRate ¶ added in v1.67.0
GetRate returns the current rate limit for the client as determined by the most recent API call. It is thread-safe.
func (*Client) NewRequest ¶
func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
NewRequest creates an API request. A relative URL can be provided in urlStr, which will be resolved to the BaseURL of the Client. Relative URLS should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included in as the request body.
func (*Client) OnRequestCompleted ¶ added in v0.9.0
func (c *Client) OnRequestCompleted(rc RequestCompletionCallback)
OnRequestCompleted sets the DO API request completion callback
type ClientOpt ¶ added in v1.0.0
ClientOpt are options for New.
func SetBaseURL ¶ added in v1.0.0
SetBaseURL is a client option for setting the base URL.
func SetRequestHeaders ¶ added in v1.67.0
SetRequestHeaders sets optional HTTP headers on the client that are sent on each HTTP request.
func SetUserAgent ¶ added in v1.0.0
SetUserAgent is a client option for setting the user agent.
type ClusterlintDiagnostic ¶ added in v1.67.0
type ClusterlintDiagnostic struct { CheckName string `json:"check_name"` Severity string `json:"severity"` Message string `json:"message"` Object *ClusterlintObject `json:"object"` }
ClusterlintDiagnostic is a diagnostic returned from clusterlint.
type ClusterlintObject ¶ added in v1.67.0
type ClusterlintObject struct { Kind string `json:"kind"` Name string `json:"name"` Namespace string `json:"namespace"` Owners []*ClusterlintOwner `json:"owners,omitempty"` }
ClusterlintObject is the object a clusterlint diagnostic refers to.
type ClusterlintOwner ¶ added in v1.67.0
ClusterlintOwner indicates the resource that owns the offending object.
type CreateProjectRequest ¶ added in v1.6.0
type CreateProjectRequest struct { Name string `json:"name"` Description string `json:"description"` Purpose string `json:"purpose"` Environment string `json:"environment"` }
CreateProjectRequest represents the request to create a new project.
type CustomImageCreateRequest ¶ added in v1.7.1
type CustomImageCreateRequest struct { Name string `json:"name"` Url string `json:"url"` Region string `json:"region"` Distribution string `json:"distribution,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` }
CustomImageCreateRequest represents a request to create a custom image.
type Database ¶ added in v1.10.0
type Database struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` EngineSlug string `json:"engine,omitempty"` VersionSlug string `json:"version,omitempty"` Connection *DatabaseConnection `json:"connection,omitempty"` PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"` Users []DatabaseUser `json:"users,omitempty"` NumNodes int `json:"num_nodes,omitempty"` SizeSlug string `json:"size,omitempty"` DBNames []string `json:"db_names,omitempty"` RegionSlug string `json:"region,omitempty"` Status string `json:"status,omitempty"` MaintenanceWindow *DatabaseMaintenanceWindow `json:"maintenance_window,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` PrivateNetworkUUID string `json:"private_network_uuid,omitempty"` Tags []string `json:"tags,omitempty"` }
Database represents a DigitalOcean managed database product. These managed databases are usually comprised of a cluster of database nodes, a primary and 0 or more replicas. The EngineSlug is a string which indicates the type of database service. Some examples are "pg", "mysql" or "redis". A Database also includes connection information and other properties of the service like region, size and current status.
type DatabaseBackup ¶ added in v1.10.0
type DatabaseBackup struct { CreatedAt time.Time `json:"created_at,omitempty"` SizeGigabytes float64 `json:"size_gigabytes,omitempty"` }
DatabaseBackup represents a database backup.
type DatabaseBackupRestore ¶ added in v1.67.0
type DatabaseBackupRestore struct { DatabaseName string `json:"database_name,omitempty"` BackupCreatedAt string `json:"backup_created_at,omitempty"` }
DatabaseBackupRestore contains information needed to restore a backup.
type DatabaseCA ¶ added in v1.67.0
type DatabaseCA struct {
Certificate []byte `json:"certificate"`
}
DatabaseCA represents a database ca.
type DatabaseConnection ¶ added in v1.10.0
type DatabaseConnection struct { URI string `json:"uri,omitempty"` Database string `json:"database,omitempty"` Host string `json:"host,omitempty"` Port int `json:"port,omitempty"` User string `json:"user,omitempty"` Password string `json:"password,omitempty"` SSL bool `json:"ssl,omitempty"` }
DatabaseConnection represents a database connection
type DatabaseCreateDBRequest ¶ added in v1.10.0
type DatabaseCreateDBRequest struct {
Name string `json:"name"`
}
DatabaseCreateDBRequest is used to create a new engine-specific database within the cluster
type DatabaseCreatePoolRequest ¶ added in v1.10.0
type DatabaseCreatePoolRequest struct { User string `json:"user"` Name string `json:"name"` Size int `json:"size"` Database string `json:"db"` Mode string `json:"mode"` }
DatabaseCreatePoolRequest is used to create a new database connection pool
type DatabaseCreateReplicaRequest ¶ added in v1.10.0
type DatabaseCreateReplicaRequest struct { Name string `json:"name"` Region string `json:"region"` Size string `json:"size"` PrivateNetworkUUID string `json:"private_network_uuid"` Tags []string `json:"tags,omitempty"` }
DatabaseCreateReplicaRequest is used to create a new read-only replica
type DatabaseCreateRequest ¶ added in v1.10.0
type DatabaseCreateRequest struct { Name string `json:"name,omitempty"` EngineSlug string `json:"engine,omitempty"` Version string `json:"version,omitempty"` SizeSlug string `json:"size,omitempty"` Region string `json:"region,omitempty"` NumNodes int `json:"num_nodes,omitempty"` PrivateNetworkUUID string `json:"private_network_uuid"` Tags []string `json:"tags,omitempty"` BackupRestore *DatabaseBackupRestore `json:"backup_restore,omitempty"` }
DatabaseCreateRequest represents a request to create a database cluster
type DatabaseCreateUserRequest ¶ added in v1.10.0
type DatabaseCreateUserRequest struct { Name string `json:"name"` MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"` }
DatabaseCreateUserRequest is used to create a new database user
type DatabaseDB ¶ added in v1.10.0
type DatabaseDB struct {
Name string `json:"name"`
}
DatabaseDB represents an engine-specific database created within a database cluster. For SQL databases like PostgreSQL or MySQL, a "DB" refers to a database created on the RDBMS. For instance, a PostgreSQL database server can contain many database schemas, each with it's own settings, access permissions and data. ListDBs will return all databases present on the server.
type DatabaseFirewallRule ¶ added in v1.67.0
type DatabaseFirewallRule struct { UUID string `json:"uuid"` ClusterUUID string `json:"cluster_uuid"` Type string `json:"type"` Value string `json:"value"` CreatedAt time.Time `json:"created_at"` }
DatabaseFirewallRule is a rule describing an inbound source to a database
type DatabaseMaintenanceWindow ¶ added in v1.10.0
type DatabaseMaintenanceWindow struct { Day string `json:"day,omitempty"` Hour string `json:"hour,omitempty"` Pending bool `json:"pending,omitempty"` Description []string `json:"description,omitempty"` }
DatabaseMaintenanceWindow represents the maintenance_window of a database cluster
type DatabaseMigrateRequest ¶ added in v1.10.0
type DatabaseMigrateRequest struct { Region string `json:"region,omitempty"` PrivateNetworkUUID string `json:"private_network_uuid"` }
DatabaseMigrateRequest can be used to initiate a database migrate operation.
type DatabaseMySQLUserSettings ¶ added in v1.67.0
type DatabaseMySQLUserSettings struct {
AuthPlugin string `json:"auth_plugin"`
}
DatabaseMySQLUserSettings contains MySQL-specific user settings
type DatabasePool ¶ added in v1.10.0
type DatabasePool struct { User string `json:"user"` Name string `json:"name"` Size int `json:"size"` Database string `json:"db"` Mode string `json:"mode"` Connection *DatabaseConnection `json:"connection"` PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"` }
DatabasePool represents a database connection pool
type DatabaseReplica ¶ added in v1.10.0
type DatabaseReplica struct { Name string `json:"name"` Connection *DatabaseConnection `json:"connection"` PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"` Region string `json:"region"` Status string `json:"status"` CreatedAt time.Time `json:"created_at"` PrivateNetworkUUID string `json:"private_network_uuid,omitempty"` Tags []string `json:"tags,omitempty"` }
DatabaseReplica represents a read-only replica of a particular database
type DatabaseResetUserAuthRequest ¶ added in v1.67.0
type DatabaseResetUserAuthRequest struct {
MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"`
}
DatabaseResetUserAuthRequest is used to reset a users DB auth
type DatabaseResizeRequest ¶ added in v1.10.0
type DatabaseResizeRequest struct { SizeSlug string `json:"size,omitempty"` NumNodes int `json:"num_nodes,omitempty"` }
DatabaseResizeRequest can be used to initiate a database resize operation.
type DatabaseUpdateFirewallRulesRequest ¶ added in v1.67.0
type DatabaseUpdateFirewallRulesRequest struct {
Rules []*DatabaseFirewallRule `json:"rules"`
}
DatabaseUpdateFirewallRulesRequest is used to set the firewall rules for a database
type DatabaseUpdateMaintenanceRequest ¶ added in v1.10.0
type DatabaseUpdateMaintenanceRequest struct { Day string `json:"day,omitempty"` Hour string `json:"hour,omitempty"` }
DatabaseUpdateMaintenanceRequest can be used to update the database's maintenance window.
type DatabaseUser ¶ added in v1.10.0
type DatabaseUser struct { Name string `json:"name,omitempty"` Role string `json:"role,omitempty"` Password string `json:"password,omitempty"` MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"` }
DatabaseUser represents a user in the database
type DatabasesService ¶ added in v1.10.0
type DatabasesService interface { List(context.Context, *ListOptions) ([]Database, *Response, error) Get(context.Context, string) (*Database, *Response, error) GetCA(context.Context, string) (*DatabaseCA, *Response, error) Create(context.Context, *DatabaseCreateRequest) (*Database, *Response, error) Delete(context.Context, string) (*Response, error) Resize(context.Context, string, *DatabaseResizeRequest) (*Response, error) Migrate(context.Context, string, *DatabaseMigrateRequest) (*Response, error) UpdateMaintenance(context.Context, string, *DatabaseUpdateMaintenanceRequest) (*Response, error) ListBackups(context.Context, string, *ListOptions) ([]DatabaseBackup, *Response, error) GetUser(context.Context, string, string) (*DatabaseUser, *Response, error) ListUsers(context.Context, string, *ListOptions) ([]DatabaseUser, *Response, error) CreateUser(context.Context, string, *DatabaseCreateUserRequest) (*DatabaseUser, *Response, error) DeleteUser(context.Context, string, string) (*Response, error) ResetUserAuth(context.Context, string, string, *DatabaseResetUserAuthRequest) (*DatabaseUser, *Response, error) ListDBs(context.Context, string, *ListOptions) ([]DatabaseDB, *Response, error) CreateDB(context.Context, string, *DatabaseCreateDBRequest) (*DatabaseDB, *Response, error) GetDB(context.Context, string, string) (*DatabaseDB, *Response, error) DeleteDB(context.Context, string, string) (*Response, error) ListPools(context.Context, string, *ListOptions) ([]DatabasePool, *Response, error) CreatePool(context.Context, string, *DatabaseCreatePoolRequest) (*DatabasePool, *Response, error) GetPool(context.Context, string, string) (*DatabasePool, *Response, error) DeletePool(context.Context, string, string) (*Response, error) GetReplica(context.Context, string, string) (*DatabaseReplica, *Response, error) ListReplicas(context.Context, string, *ListOptions) ([]DatabaseReplica, *Response, error) CreateReplica(context.Context, string, *DatabaseCreateReplicaRequest) (*DatabaseReplica, *Response, error) DeleteReplica(context.Context, string, string) (*Response, error) GetEvictionPolicy(context.Context, string) (string, *Response, error) SetEvictionPolicy(context.Context, string, string) (*Response, error) GetSQLMode(context.Context, string) (string, *Response, error) SetSQLMode(context.Context, string, ...string) (*Response, error) GetFirewallRules(context.Context, string) ([]DatabaseFirewallRule, *Response, error) UpdateFirewallRules(context.Context, string, *DatabaseUpdateFirewallRulesRequest) (*Response, error) }
The DatabasesService provides access to the DigitalOcean managed database suite of products through the public API. Customers can create new database clusters, migrate them between regions, create replicas and interact with their configurations. Each database service is referred to as a Database. A SQL database service can have multiple databases residing in the system. To help make these entities distinct from Databases in godo, we refer to them here as DatabaseDBs.
See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Databases
type DatabasesServiceOp ¶ added in v1.10.0
type DatabasesServiceOp struct {
// contains filtered or unexported fields
}
DatabasesServiceOp handles communication with the Databases related methods of the DigitalOcean API.
func (*DatabasesServiceOp) Create ¶ added in v1.10.0
func (svc *DatabasesServiceOp) Create(ctx context.Context, create *DatabaseCreateRequest) (*Database, *Response, error)
Create creates a database cluster
func (*DatabasesServiceOp) CreateDB ¶ added in v1.10.0
func (svc *DatabasesServiceOp) CreateDB(ctx context.Context, databaseID string, createDB *DatabaseCreateDBRequest) (*DatabaseDB, *Response, error)
CreateDB will create a new database
func (*DatabasesServiceOp) CreatePool ¶ added in v1.10.0
func (svc *DatabasesServiceOp) CreatePool(ctx context.Context, databaseID string, createPool *DatabaseCreatePoolRequest) (*DatabasePool, *Response, error)
CreatePool will create a new database connection pool
func (*DatabasesServiceOp) CreateReplica ¶ added in v1.10.0
func (svc *DatabasesServiceOp) CreateReplica(ctx context.Context, databaseID string, createReplica *DatabaseCreateReplicaRequest) (*DatabaseReplica, *Response, error)
CreateReplica will create a new database connection pool
func (*DatabasesServiceOp) CreateUser ¶ added in v1.10.0
func (svc *DatabasesServiceOp) CreateUser(ctx context.Context, databaseID string, createUser *DatabaseCreateUserRequest) (*DatabaseUser, *Response, error)
CreateUser will create a new database user
func (*DatabasesServiceOp) Delete ¶ added in v1.10.0
Delete deletes a database cluster. There is no way to recover a cluster once it has been destroyed.
func (*DatabasesServiceOp) DeleteDB ¶ added in v1.10.0
func (svc *DatabasesServiceOp) DeleteDB(ctx context.Context, databaseID, name string) (*Response, error)
DeleteDB will delete an existing database
func (*DatabasesServiceOp) DeletePool ¶ added in v1.10.0
func (svc *DatabasesServiceOp) DeletePool(ctx context.Context, databaseID, name string) (*Response, error)
DeletePool will delete an existing database connection pool
func (*DatabasesServiceOp) DeleteReplica ¶ added in v1.10.0
func (svc *DatabasesServiceOp) DeleteReplica(ctx context.Context, databaseID, name string) (*Response, error)
DeleteReplica will delete an existing database replica
func (*DatabasesServiceOp) DeleteUser ¶ added in v1.10.0
func (svc *DatabasesServiceOp) DeleteUser(ctx context.Context, databaseID, userID string) (*Response, error)
DeleteUser will delete an existing database user
func (*DatabasesServiceOp) Get ¶ added in v1.10.0
func (svc *DatabasesServiceOp) Get(ctx context.Context, databaseID string) (*Database, *Response, error)
Get retrieves the details of a database cluster
func (*DatabasesServiceOp) GetCA ¶ added in v1.67.0
func (svc *DatabasesServiceOp) GetCA(ctx context.Context, databaseID string) (*DatabaseCA, *Response, error)
GetCA retrieves the CA of a database cluster.
func (*DatabasesServiceOp) GetDB ¶ added in v1.10.0
func (svc *DatabasesServiceOp) GetDB(ctx context.Context, databaseID, name string) (*DatabaseDB, *Response, error)
GetDB returns a single database by name
func (*DatabasesServiceOp) GetEvictionPolicy ¶ added in v1.67.0
func (svc *DatabasesServiceOp) GetEvictionPolicy(ctx context.Context, databaseID string) (string, *Response, error)
GetEvictionPolicy loads the eviction policy for a given Redis cluster.
func (*DatabasesServiceOp) GetFirewallRules ¶ added in v1.67.0
func (svc *DatabasesServiceOp) GetFirewallRules(ctx context.Context, databaseID string) ([]DatabaseFirewallRule, *Response, error)
GetFirewallRules loads the inbound sources for a given cluster.
func (*DatabasesServiceOp) GetPool ¶ added in v1.10.0
func (svc *DatabasesServiceOp) GetPool(ctx context.Context, databaseID, name string) (*DatabasePool, *Response, error)
GetPool returns a single database connection pool by name
func (*DatabasesServiceOp) GetReplica ¶ added in v1.10.0
func (svc *DatabasesServiceOp) GetReplica(ctx context.Context, databaseID, name string) (*DatabaseReplica, *Response, error)
GetReplica returns a single database replica
func (*DatabasesServiceOp) GetSQLMode ¶ added in v1.67.0
func (svc *DatabasesServiceOp) GetSQLMode(ctx context.Context, databaseID string) (string, *Response, error)
GetSQLMode loads the SQL Mode settings for a given MySQL cluster.
func (*DatabasesServiceOp) GetUser ¶ added in v1.10.0
func (svc *DatabasesServiceOp) GetUser(ctx context.Context, databaseID, userID string) (*DatabaseUser, *Response, error)
GetUser returns the database user identified by userID
func (*DatabasesServiceOp) List ¶ added in v1.10.0
func (svc *DatabasesServiceOp) List(ctx context.Context, opts *ListOptions) ([]Database, *Response, error)
List returns a list of the Databases visible with the caller's API token
func (*DatabasesServiceOp) ListBackups ¶ added in v1.10.0
func (svc *DatabasesServiceOp) ListBackups(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseBackup, *Response, error)
ListBackups returns a list of the current backups of a database
func (*DatabasesServiceOp) ListDBs ¶ added in v1.10.0
func (svc *DatabasesServiceOp) ListDBs(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseDB, *Response, error)
ListDBs returns all databases for a given database cluster
func (*DatabasesServiceOp) ListPools ¶ added in v1.10.0
func (svc *DatabasesServiceOp) ListPools(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabasePool, *Response, error)
ListPools returns all connection pools for a given database cluster
func (*DatabasesServiceOp) ListReplicas ¶ added in v1.10.0
func (svc *DatabasesServiceOp) ListReplicas(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseReplica, *Response, error)
ListReplicas returns all read-only replicas for a given database cluster
func (*DatabasesServiceOp) ListUsers ¶ added in v1.10.0
func (svc *DatabasesServiceOp) ListUsers(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseUser, *Response, error)
ListUsers returns all database users for the database
func (*DatabasesServiceOp) Migrate ¶ added in v1.10.0
func (svc *DatabasesServiceOp) Migrate(ctx context.Context, databaseID string, migrate *DatabaseMigrateRequest) (*Response, error)
Migrate migrates a database cluster to a new region
func (*DatabasesServiceOp) ResetUserAuth ¶ added in v1.67.0
func (svc *DatabasesServiceOp) ResetUserAuth(ctx context.Context, databaseID, userID string, resetAuth *DatabaseResetUserAuthRequest) (*DatabaseUser, *Response, error)
ResetUserAuth will reset user authentication
func (*DatabasesServiceOp) Resize ¶ added in v1.10.0
func (svc *DatabasesServiceOp) Resize(ctx context.Context, databaseID string, resize *DatabaseResizeRequest) (*Response, error)
Resize resizes a database cluster by number of nodes or size
func (*DatabasesServiceOp) SetEvictionPolicy ¶ added in v1.67.0
func (svc *DatabasesServiceOp) SetEvictionPolicy(ctx context.Context, databaseID, policy string) (*Response, error)
SetEvictionPolicy updates the eviction policy for a given Redis cluster.
The valid eviction policies are documented by the exported string constants with the prefix `EvictionPolicy`.
func (*DatabasesServiceOp) SetSQLMode ¶ added in v1.67.0
func (svc *DatabasesServiceOp) SetSQLMode(ctx context.Context, databaseID string, sqlModes ...string) (*Response, error)
SetSQLMode updates the SQL Mode settings for a given MySQL cluster.
func (*DatabasesServiceOp) UpdateFirewallRules ¶ added in v1.67.0
func (svc *DatabasesServiceOp) UpdateFirewallRules(ctx context.Context, databaseID string, firewallRulesReq *DatabaseUpdateFirewallRulesRequest) (*Response, error)
UpdateFirewallRules sets the inbound sources for a given cluster.
func (*DatabasesServiceOp) UpdateMaintenance ¶ added in v1.10.0
func (svc *DatabasesServiceOp) UpdateMaintenance(ctx context.Context, databaseID string, maintenance *DatabaseUpdateMaintenanceRequest) (*Response, error)
UpdateMaintenance updates the maintenance window on a cluster
type Deployment ¶ added in v1.67.0
type Deployment struct { ID string `json:"id,omitempty"` Spec *AppSpec `json:"spec,omitempty"` Services []*DeploymentService `json:"services,omitempty"` StaticSites []*DeploymentStaticSite `json:"static_sites,omitempty"` Workers []*DeploymentWorker `json:"workers,omitempty"` Jobs []*DeploymentJob `json:"jobs,omitempty"` PhaseLastUpdatedAt time.Time `json:"phase_last_updated_at,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` Cause string `json:"cause,omitempty"` ClonedFrom string `json:"cloned_from,omitempty"` Progress *DeploymentProgress `json:"progress,omitempty"` Phase DeploymentPhase `json:"phase,omitempty"` TierSlug string `json:"tier_slug,omitempty"` PreviousDeploymentID string `json:"previous_deployment_id,omitempty"` CauseDetails *DeploymentCauseDetails `json:"cause_details,omitempty"` }
Deployment struct for Deployment
type DeploymentCauseDetails ¶ added in v1.67.0
type DeploymentCauseDetails struct { DigitalOceanUserAction *DeploymentCauseDetailsDigitalOceanUserAction `json:"digitalocean_user_action,omitempty"` GitPush *DeploymentCauseDetailsGitPush `json:"git_push,omitempty"` Internal bool `json:"internal,omitempty"` Type DeploymentCauseDetailsType `json:"type,omitempty"` }
DeploymentCauseDetails struct for DeploymentCauseDetails
type DeploymentCauseDetailsDigitalOceanUser ¶ added in v1.67.0
type DeploymentCauseDetailsDigitalOceanUser struct { UUID string `json:"uuid,omitempty"` Email string `json:"email,omitempty"` FullName string `json:"full_name,omitempty"` }
DeploymentCauseDetailsDigitalOceanUser struct for DeploymentCauseDetailsDigitalOceanUser
type DeploymentCauseDetailsDigitalOceanUserAction ¶ added in v1.67.0
type DeploymentCauseDetailsDigitalOceanUserAction struct { User *DeploymentCauseDetailsDigitalOceanUser `json:"user,omitempty"` Name DeploymentCauseDetailsDigitalOceanUserActionName `json:"name,omitempty"` }
DeploymentCauseDetailsDigitalOceanUserAction struct for DeploymentCauseDetailsDigitalOceanUserAction
type DeploymentCauseDetailsDigitalOceanUserActionName ¶ added in v1.67.0
type DeploymentCauseDetailsDigitalOceanUserActionName string
DeploymentCauseDetailsDigitalOceanUserActionName the model 'CauseDetailsDigitalOceanUserActionName'
const ( DeploymentCauseDetailsDigitalOceanUserActionName_Unknown DeploymentCauseDetailsDigitalOceanUserActionName = "UNKNOWN" DeploymentCauseDetailsDigitalOceanUserActionName_CreateDeployment DeploymentCauseDetailsDigitalOceanUserActionName = "CREATE_DEPLOYMENT" DeploymentCauseDetailsDigitalOceanUserActionName_UpdateSpec DeploymentCauseDetailsDigitalOceanUserActionName = "UPDATE_SPEC" )
List of DeploymentCauseDetailsDigitalOceanUserActionName
type DeploymentCauseDetailsGitPush ¶ added in v1.67.0
type DeploymentCauseDetailsGitPush struct { GitHub *GitHubSourceSpec `json:"github,omitempty"` GitLab *GitLabSourceSpec `json:"gitlab,omitempty"` Username string `json:"username,omitempty"` CommitAuthor string `json:"commit_author,omitempty"` CommitSHA string `json:"commit_sha,omitempty"` }
DeploymentCauseDetailsGitPush struct for DeploymentCauseDetailsGitPush
type DeploymentCauseDetailsType ¶ added in v1.67.0
type DeploymentCauseDetailsType string
DeploymentCauseDetailsType - MANUAL: A deployment that was manually created - DEPLOY_ON_PUSH: A deployment that was automatically created by a Deploy on Push hook - MAINTENANCE: A deployment created for App Platform maintenance - AUTO_ROLLBACK: An automatic rollback deployment created as a result of a previous deployment failing
const ( DeploymentCauseDetailsType_Unknown DeploymentCauseDetailsType = "UNKNOWN" DeploymentCauseDetailsType_Manual DeploymentCauseDetailsType = "MANUAL" DeploymentCauseDetailsType_DeployOnPush DeploymentCauseDetailsType = "DEPLOY_ON_PUSH" DeploymentCauseDetailsType_Maintenance DeploymentCauseDetailsType = "MAINTENANCE" DeploymentCauseDetailsType_AutoRollback DeploymentCauseDetailsType = "AUTO_ROLLBACK" )
List of DeploymentCauseDetailsType
type DeploymentCreateRequest ¶ added in v1.67.0
type DeploymentCreateRequest struct {
ForceBuild bool `json:"force_build"`
}
DeploymentCreateRequest represents a request to create a deployment.
type DeploymentJob ¶ added in v1.67.0
type DeploymentJob struct { Name string `json:"name,omitempty"` SourceCommitHash string `json:"source_commit_hash,omitempty"` }
DeploymentJob struct for DeploymentJob
type DeploymentPhase ¶ added in v1.67.0
type DeploymentPhase string
DeploymentPhase the model 'DeploymentPhase'
const ( DeploymentPhase_Unknown DeploymentPhase = "UNKNOWN" DeploymentPhase_PendingBuild DeploymentPhase = "PENDING_BUILD" DeploymentPhase_Building DeploymentPhase = "BUILDING" DeploymentPhase_PendingDeploy DeploymentPhase = "PENDING_DEPLOY" DeploymentPhase_Deploying DeploymentPhase = "DEPLOYING" DeploymentPhase_Active DeploymentPhase = "ACTIVE" DeploymentPhase_Superseded DeploymentPhase = "SUPERSEDED" DeploymentPhase_Error DeploymentPhase = "ERROR" DeploymentPhase_Canceled DeploymentPhase = "CANCELED" )
List of DeploymentPhase
type DeploymentProgress ¶ added in v1.67.0
type DeploymentProgress struct { PendingSteps int32 `json:"pending_steps,omitempty"` RunningSteps int32 `json:"running_steps,omitempty"` SuccessSteps int32 `json:"success_steps,omitempty"` ErrorSteps int32 `json:"error_steps,omitempty"` TotalSteps int32 `json:"total_steps,omitempty"` Steps []*DeploymentProgressStep `json:"steps,omitempty"` SummarySteps []*DeploymentProgressStep `json:"summary_steps,omitempty"` }
DeploymentProgress struct for DeploymentProgress
type DeploymentProgressStep ¶ added in v1.67.0
type DeploymentProgressStep struct { Name string `json:"name,omitempty"` Status DeploymentProgressStepStatus `json:"status,omitempty"` Steps []*DeploymentProgressStep `json:"steps,omitempty"` StartedAt time.Time `json:"started_at,omitempty"` EndedAt time.Time `json:"ended_at,omitempty"` Reason *DeploymentProgressStepReason `json:"reason,omitempty"` ComponentName string `json:"component_name,omitempty"` // The base of a human-readable description of the step intended to be combined with the component name for presentation. For example: `message_base` = \"Building service\" `component_name` = \"api\" MessageBase string `json:"message_base,omitempty"` }
DeploymentProgressStep struct for DeploymentProgressStep
type DeploymentProgressStepReason ¶ added in v1.67.0
type DeploymentProgressStepReason struct { Code string `json:"code,omitempty"` Message string `json:"message,omitempty"` }
DeploymentProgressStepReason struct for DeploymentProgressStepReason
type DeploymentProgressStepStatus ¶ added in v1.67.0
type DeploymentProgressStepStatus string
DeploymentProgressStepStatus the model 'DeploymentProgressStepStatus'
const ( DeploymentProgressStepStatus_Unknown DeploymentProgressStepStatus = "UNKNOWN" DeploymentProgressStepStatus_Pending DeploymentProgressStepStatus = "PENDING" DeploymentProgressStepStatus_Running DeploymentProgressStepStatus = "RUNNING" DeploymentProgressStepStatus_Error DeploymentProgressStepStatus = "ERROR" DeploymentProgressStepStatus_Success DeploymentProgressStepStatus = "SUCCESS" )
List of DeploymentProgressStepStatus
type DeploymentService ¶ added in v1.67.0
type DeploymentService struct { Name string `json:"name,omitempty"` SourceCommitHash string `json:"source_commit_hash,omitempty"` }
DeploymentService struct for DeploymentService
type DeploymentStaticSite ¶ added in v1.67.0
type DeploymentStaticSite struct { Name string `json:"name,omitempty"` SourceCommitHash string `json:"source_commit_hash,omitempty"` }
DeploymentStaticSite struct for DeploymentStaticSite
type DeploymentWorker ¶ added in v1.67.0
type DeploymentWorker struct { Name string `json:"name,omitempty"` SourceCommitHash string `json:"source_commit_hash,omitempty"` }
DeploymentWorker struct for DeploymentWorker
type Destinations ¶ added in v1.1.0
type Destinations struct { Addresses []string `json:"addresses,omitempty"` Tags []string `json:"tags,omitempty"` DropletIDs []int `json:"droplet_ids,omitempty"` LoadBalancerUIDs []string `json:"load_balancer_uids,omitempty"` KubernetesIDs []string `json:"kubernetes_ids,omitempty"` }
Destinations represents a DigitalOcean Firewall OutboundRule destinations.
type DockerCredentials ¶ added in v1.67.0
type DockerCredentials struct {
DockerConfigJSON []byte
}
DockerCredentials is the content of a Docker config file that is used by the docker CLI See: https://docs.docker.com/engine/reference/commandline/cli/#configjson-properties
type Domain ¶ added in v0.3.0
type Domain struct { Name string `json:"name"` TTL int `json:"ttl"` ZoneFile string `json:"zone_file"` }
Domain represents a DigitalOcean domain
type DomainCreateRequest ¶ added in v0.3.0
type DomainCreateRequest struct { Name string `json:"name"` IPAddress string `json:"ip_address,omitempty"` }
DomainCreateRequest respresents a request to create a domain.
type DomainRecord ¶
type DomainRecord struct { ID int `json:"id,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Data string `json:"data,omitempty"` Priority int `json:"priority"` Port int `json:"port"` TTL int `json:"ttl,omitempty"` Weight int `json:"weight"` Flags int `json:"flags"` Tag string `json:"tag,omitempty"` }
DomainRecord represents a DigitalOcean DomainRecord
func (DomainRecord) String ¶
func (d DomainRecord) String() string
Converts a DomainRecord to a string.
type DomainRecordEditRequest ¶
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"` TTL int `json:"ttl,omitempty"` Weight int `json:"weight"` Flags int `json:"flags"` Tag string `json:"tag,omitempty"` }
DomainRecordEditRequest represents a request to update a domain record.
func (DomainRecordEditRequest) String ¶
func (d DomainRecordEditRequest) String() string
Converts a DomainRecordEditRequest to a string.
type DomainsService ¶
type DomainsService interface { List(context.Context, *ListOptions) ([]Domain, *Response, error) Get(context.Context, string) (*Domain, *Response, error) Create(context.Context, *DomainCreateRequest) (*Domain, *Response, error) Delete(context.Context, string) (*Response, error) Records(context.Context, string, *ListOptions) ([]DomainRecord, *Response, error) RecordsByType(context.Context, string, string, *ListOptions) ([]DomainRecord, *Response, error) RecordsByName(context.Context, string, string, *ListOptions) ([]DomainRecord, *Response, error) RecordsByTypeAndName(context.Context, string, string, string, *ListOptions) ([]DomainRecord, *Response, error) Record(context.Context, string, int) (*DomainRecord, *Response, error) DeleteRecord(context.Context, string, int) (*Response, error) EditRecord(context.Context, string, int, *DomainRecordEditRequest) (*DomainRecord, *Response, error) CreateRecord(context.Context, string, *DomainRecordEditRequest) (*DomainRecord, *Response, error) }
DomainsService is an interface for managing DNS with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Domains and https://docs.digitalocean.com/reference/api/api-reference/#tag/Domain-Records
type DomainsServiceOp ¶ added in v0.3.0
type DomainsServiceOp struct {
// contains filtered or unexported fields
}
DomainsServiceOp handles communication with the domain related methods of the DigitalOcean API.
func (*DomainsServiceOp) Create ¶ added in v0.3.0
func (s *DomainsServiceOp) Create(ctx context.Context, createRequest *DomainCreateRequest) (*Domain, *Response, error)
Create a new domain
func (*DomainsServiceOp) CreateRecord ¶ added in v0.3.0
func (s *DomainsServiceOp) CreateRecord(ctx context.Context, domain string, createRequest *DomainRecordEditRequest) (*DomainRecord, *Response, error)
CreateRecord creates a record using a DomainRecordEditRequest
func (*DomainsServiceOp) DeleteRecord ¶ added in v0.3.0
func (s *DomainsServiceOp) DeleteRecord(ctx context.Context, domain string, id int) (*Response, error)
DeleteRecord deletes a record from a domain identified by id
func (*DomainsServiceOp) EditRecord ¶ added in v0.3.0
func (s *DomainsServiceOp) EditRecord(ctx context.Context, domain string, id int, editRequest *DomainRecordEditRequest, ) (*DomainRecord, *Response, error)
EditRecord edits a record using a DomainRecordEditRequest
func (*DomainsServiceOp) Get ¶ added in v0.3.0
Get individual domain. It requires a non-empty domain name.
func (DomainsServiceOp) List ¶ added in v0.3.0
func (s DomainsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Domain, *Response, error)
List all domains.
func (*DomainsServiceOp) Record ¶ added in v0.3.0
func (s *DomainsServiceOp) Record(ctx context.Context, domain string, id int) (*DomainRecord, *Response, error)
Record returns the record id from a domain
func (*DomainsServiceOp) Records ¶ added in v0.3.0
func (s *DomainsServiceOp) Records(ctx context.Context, domain string, opt *ListOptions) ([]DomainRecord, *Response, error)
Records returns a slice of DomainRecord for a domain.
func (*DomainsServiceOp) RecordsByName ¶ added in v1.67.0
func (s *DomainsServiceOp) RecordsByName(ctx context.Context, domain, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
RecordsByName returns a slice of DomainRecord for a domain matched by record name.
func (*DomainsServiceOp) RecordsByType ¶ added in v1.67.0
func (s *DomainsServiceOp) RecordsByType(ctx context.Context, domain, ofType string, opt *ListOptions) ([]DomainRecord, *Response, error)
RecordsByType returns a slice of DomainRecord for a domain matched by record type.
func (*DomainsServiceOp) RecordsByTypeAndName ¶ added in v1.67.0
func (s *DomainsServiceOp) RecordsByTypeAndName(ctx context.Context, domain, ofType, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
RecordsByTypeAndName returns a slice of DomainRecord for a domain matched by record type and name.
type Droplet ¶
type Droplet struct { ID int `json:"id,float64,omitempty"` Name string `json:"name,omitempty"` Memory int `json:"memory,omitempty"` Vcpus int `json:"vcpus,omitempty"` Disk int `json:"disk,omitempty"` Region *Region `json:"region,omitempty"` Image *Image `json:"image,omitempty"` Size *Size `json:"size,omitempty"` SizeSlug string `json:"size_slug,omitempty"` BackupIDs []int `json:"backup_ids,omitempty"` NextBackupWindow *BackupWindow `json:"next_backup_window,omitempty"` SnapshotIDs []int `json:"snapshot_ids,omitempty"` Features []string `json:"features,omitempty"` Locked bool `json:"locked,bool,omitempty"` Status string `json:"status,omitempty"` Networks *Networks `json:"networks,omitempty"` Created string `json:"created_at,omitempty"` Kernel *Kernel `json:"kernel,omitempty"` Tags []string `json:"tags,omitempty"` VolumeIDs []string `json:"volume_ids"` VPCUUID string `json:"vpc_uuid,omitempty"` }
Droplet represents a DigitalOcean Droplet
func (*Droplet) PrivateIPv4 ¶ added in v1.0.0
PrivateIPv4 returns the private IPv4 address for the Droplet.
func (*Droplet) PublicIPv4 ¶ added in v1.0.0
PublicIPv4 returns the public IPv4 address for the Droplet.
func (*Droplet) PublicIPv6 ¶ added in v1.0.0
PublicIPv6 returns the public IPv6 address for the Droplet.
type DropletActionsService ¶
type DropletActionsService interface { Shutdown(context.Context, int) (*Action, *Response, error) ShutdownByTag(context.Context, string) ([]Action, *Response, error) PowerOff(context.Context, int) (*Action, *Response, error) PowerOffByTag(context.Context, string) ([]Action, *Response, error) PowerOn(context.Context, int) (*Action, *Response, error) PowerOnByTag(context.Context, string) ([]Action, *Response, error) PowerCycle(context.Context, int) (*Action, *Response, error) PowerCycleByTag(context.Context, string) ([]Action, *Response, error) Reboot(context.Context, int) (*Action, *Response, error) Restore(context.Context, int, int) (*Action, *Response, error) Resize(context.Context, int, string, bool) (*Action, *Response, error) Rename(context.Context, int, string) (*Action, *Response, error) Snapshot(context.Context, int, string) (*Action, *Response, error) SnapshotByTag(context.Context, string, string) ([]Action, *Response, error) EnableBackups(context.Context, int) (*Action, *Response, error) EnableBackupsByTag(context.Context, string) ([]Action, *Response, error) DisableBackups(context.Context, int) (*Action, *Response, error) DisableBackupsByTag(context.Context, string) ([]Action, *Response, error) PasswordReset(context.Context, int) (*Action, *Response, error) RebuildByImageID(context.Context, int, int) (*Action, *Response, error) RebuildByImageSlug(context.Context, int, string) (*Action, *Response, error) ChangeKernel(context.Context, int, int) (*Action, *Response, error) EnableIPv6(context.Context, int) (*Action, *Response, error) EnableIPv6ByTag(context.Context, string) ([]Action, *Response, error) EnablePrivateNetworking(context.Context, int) (*Action, *Response, error) EnablePrivateNetworkingByTag(context.Context, string) ([]Action, *Response, error) Get(context.Context, int, int) (*Action, *Response, error) GetByURI(context.Context, string) (*Action, *Response, error) }
DropletActionsService is an interface for interfacing with the Droplet actions endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Actions
type DropletActionsServiceOp ¶ added in v0.3.0
type DropletActionsServiceOp struct {
// contains filtered or unexported fields
}
DropletActionsServiceOp handles communication with the Droplet action related methods of the DigitalOcean API.
func (*DropletActionsServiceOp) ChangeKernel ¶ added in v0.9.0
func (s *DropletActionsServiceOp) ChangeKernel(ctx context.Context, id, kernelID int) (*Action, *Response, error)
ChangeKernel changes the kernel for a Droplet.
func (*DropletActionsServiceOp) DisableBackups ¶ added in v0.9.0
func (s *DropletActionsServiceOp) DisableBackups(ctx context.Context, id int) (*Action, *Response, error)
DisableBackups disables backups for a Droplet.
func (*DropletActionsServiceOp) DisableBackupsByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) DisableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
DisableBackupsByTag disables backups for Droplet matched by a Tag.
func (*DropletActionsServiceOp) EnableBackups ¶ added in v1.0.0
func (s *DropletActionsServiceOp) EnableBackups(ctx context.Context, id int) (*Action, *Response, error)
EnableBackups enables backups for a Droplet.
func (*DropletActionsServiceOp) EnableBackupsByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) EnableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
EnableBackupsByTag enables backups for Droplets matched by a Tag.
func (*DropletActionsServiceOp) EnableIPv6 ¶ added in v0.9.0
func (s *DropletActionsServiceOp) EnableIPv6(ctx context.Context, id int) (*Action, *Response, error)
EnableIPv6 enables IPv6 for a Droplet.
func (*DropletActionsServiceOp) EnableIPv6ByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) EnableIPv6ByTag(ctx context.Context, tag string) ([]Action, *Response, error)
EnableIPv6ByTag enables IPv6 for Droplets matched by a Tag.
func (*DropletActionsServiceOp) EnablePrivateNetworking ¶ added in v0.9.0
func (s *DropletActionsServiceOp) EnablePrivateNetworking(ctx context.Context, id int) (*Action, *Response, error)
EnablePrivateNetworking enables private networking for a Droplet.
func (*DropletActionsServiceOp) EnablePrivateNetworkingByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) EnablePrivateNetworkingByTag(ctx context.Context, tag string) ([]Action, *Response, error)
EnablePrivateNetworkingByTag enables private networking for Droplets matched by a Tag.
func (*DropletActionsServiceOp) Get ¶ added in v0.3.0
func (s *DropletActionsServiceOp) Get(ctx context.Context, dropletID, actionID int) (*Action, *Response, error)
Get an action for a particular Droplet by id.
func (*DropletActionsServiceOp) GetByURI ¶ added in v0.3.0
func (s *DropletActionsServiceOp) GetByURI(ctx context.Context, rawurl string) (*Action, *Response, error)
GetByURI gets an action for a particular Droplet by id.
func (*DropletActionsServiceOp) PasswordReset ¶ added in v0.9.0
func (s *DropletActionsServiceOp) PasswordReset(ctx context.Context, id int) (*Action, *Response, error)
PasswordReset resets the password for a Droplet.
func (*DropletActionsServiceOp) PowerCycle ¶ added in v0.3.0
func (s *DropletActionsServiceOp) PowerCycle(ctx context.Context, id int) (*Action, *Response, error)
PowerCycle a Droplet
func (*DropletActionsServiceOp) PowerCycleByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) PowerCycleByTag(ctx context.Context, tag string) ([]Action, *Response, error)
PowerCycleByTag power cycles Droplets matched by a Tag.
func (*DropletActionsServiceOp) PowerOffByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) PowerOffByTag(ctx context.Context, tag string) ([]Action, *Response, error)
PowerOffByTag powers off Droplets matched by a Tag.
func (*DropletActionsServiceOp) PowerOnByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) PowerOnByTag(ctx context.Context, tag string) ([]Action, *Response, error)
PowerOnByTag powers on Droplets matched by a Tag.
func (*DropletActionsServiceOp) RebuildByImageID ¶ added in v0.9.0
func (s *DropletActionsServiceOp) RebuildByImageID(ctx context.Context, id, imageID int) (*Action, *Response, error)
RebuildByImageID rebuilds a Droplet from an image with a given id.
func (*DropletActionsServiceOp) RebuildByImageSlug ¶ added in v0.9.0
func (s *DropletActionsServiceOp) RebuildByImageSlug(ctx context.Context, id int, slug string) (*Action, *Response, error)
RebuildByImageSlug rebuilds a Droplet from an Image matched by a given Slug.
func (*DropletActionsServiceOp) Rename ¶ added in v0.3.0
func (s *DropletActionsServiceOp) Rename(ctx context.Context, id int, name string) (*Action, *Response, error)
Rename a Droplet
func (*DropletActionsServiceOp) Resize ¶ added in v0.3.0
func (s *DropletActionsServiceOp) Resize(ctx context.Context, id int, sizeSlug string, resizeDisk bool) (*Action, *Response, error)
Resize a Droplet
func (*DropletActionsServiceOp) Restore ¶ added in v0.3.0
func (s *DropletActionsServiceOp) Restore(ctx context.Context, id, imageID int) (*Action, *Response, error)
Restore an image to a Droplet
func (*DropletActionsServiceOp) ShutdownByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) ShutdownByTag(ctx context.Context, tag string) ([]Action, *Response, error)
ShutdownByTag shuts down Droplets matched by a Tag.
func (*DropletActionsServiceOp) Snapshot ¶ added in v0.6.0
func (s *DropletActionsServiceOp) Snapshot(ctx context.Context, id int, name string) (*Action, *Response, error)
Snapshot a Droplet.
func (*DropletActionsServiceOp) SnapshotByTag ¶ added in v1.0.0
func (s *DropletActionsServiceOp) SnapshotByTag(ctx context.Context, tag string, name string) ([]Action, *Response, error)
SnapshotByTag snapshots Droplets matched by a Tag.
type DropletCreateImage ¶ added in v0.9.0
DropletCreateImage identifies an image for the create request. It prefers slug over ID.
func (DropletCreateImage) MarshalJSON ¶ added in v0.9.0
func (d DropletCreateImage) MarshalJSON() ([]byte, error)
MarshalJSON returns either the slug or id of the image. It returns the id if the slug is empty.
type DropletCreateRequest ¶
type DropletCreateRequest struct { Name string `json:"name"` Region string `json:"region"` Size string `json:"size"` Image DropletCreateImage `json:"image"` SSHKeys []DropletCreateSSHKey `json:"ssh_keys"` Backups bool `json:"backups"` IPv6 bool `json:"ipv6"` PrivateNetworking bool `json:"private_networking"` Monitoring bool `json:"monitoring"` UserData string `json:"user_data,omitempty"` Volumes []DropletCreateVolume `json:"volumes,omitempty"` Tags []string `json:"tags"` VPCUUID string `json:"vpc_uuid,omitempty"` WithDropletAgent *bool `json:"with_droplet_agent,omitempty"` }
DropletCreateRequest represents a request to create a Droplet.
func (DropletCreateRequest) String ¶
func (d DropletCreateRequest) String() string
type DropletCreateSSHKey ¶ added in v0.9.0
DropletCreateSSHKey identifies a SSH Key for the create request. It prefers fingerprint over ID.
func (DropletCreateSSHKey) MarshalJSON ¶ added in v0.9.0
func (d DropletCreateSSHKey) MarshalJSON() ([]byte, error)
MarshalJSON returns either the fingerprint or id of the ssh key. It returns the id if the fingerprint is empty.
type DropletCreateVolume ¶ added in v1.0.0
type DropletCreateVolume struct { ID string // Deprecated: You must pass a the volume's ID when creating a Droplet. Name string }
DropletCreateVolume identifies a volume to attach for the create request.
func (DropletCreateVolume) MarshalJSON ¶ added in v1.0.0
func (d DropletCreateVolume) MarshalJSON() ([]byte, error)
MarshalJSON returns an object with either the ID or name of the volume. It prefers the ID over the name.
type DropletMultiCreateRequest ¶ added in v1.0.0
type DropletMultiCreateRequest struct { Names []string `json:"names"` Region string `json:"region"` Size string `json:"size"` Image DropletCreateImage `json:"image"` SSHKeys []DropletCreateSSHKey `json:"ssh_keys"` Backups bool `json:"backups"` IPv6 bool `json:"ipv6"` PrivateNetworking bool `json:"private_networking"` Monitoring bool `json:"monitoring"` UserData string `json:"user_data,omitempty"` Tags []string `json:"tags"` VPCUUID string `json:"vpc_uuid,omitempty"` WithDropletAgent *bool `json:"with_droplet_agent,omitempty"` }
DropletMultiCreateRequest is a request to create multiple Droplets.
func (DropletMultiCreateRequest) String ¶ added in v1.0.0
func (d DropletMultiCreateRequest) String() string
type DropletsService ¶
type DropletsService interface { List(context.Context, *ListOptions) ([]Droplet, *Response, error) ListByTag(context.Context, string, *ListOptions) ([]Droplet, *Response, error) Get(context.Context, int) (*Droplet, *Response, error) Create(context.Context, *DropletCreateRequest) (*Droplet, *Response, error) CreateMultiple(context.Context, *DropletMultiCreateRequest) ([]Droplet, *Response, error) Delete(context.Context, int) (*Response, error) DeleteByTag(context.Context, string) (*Response, error) Kernels(context.Context, int, *ListOptions) ([]Kernel, *Response, error) Snapshots(context.Context, int, *ListOptions) ([]Image, *Response, error) Backups(context.Context, int, *ListOptions) ([]Image, *Response, error) Actions(context.Context, int, *ListOptions) ([]Action, *Response, error) Neighbors(context.Context, int) ([]Droplet, *Response, error) }
DropletsService is an interface for interfacing with the Droplet endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplets
type DropletsServiceOp ¶ added in v0.3.0
type DropletsServiceOp struct {
// contains filtered or unexported fields
}
DropletsServiceOp handles communication with the Droplet related methods of the DigitalOcean API.
func (*DropletsServiceOp) Actions ¶ added in v0.9.0
func (s *DropletsServiceOp) Actions(ctx context.Context, dropletID int, opt *ListOptions) ([]Action, *Response, error)
Actions lists the actions for a Droplet.
func (*DropletsServiceOp) Backups ¶ added in v0.9.0
func (s *DropletsServiceOp) Backups(ctx context.Context, dropletID int, opt *ListOptions) ([]Image, *Response, error)
Backups lists the backups for a Droplet.
func (*DropletsServiceOp) Create ¶ added in v0.3.0
func (s *DropletsServiceOp) Create(ctx context.Context, createRequest *DropletCreateRequest) (*Droplet, *Response, error)
Create Droplet
func (*DropletsServiceOp) CreateMultiple ¶ added in v1.0.0
func (s *DropletsServiceOp) CreateMultiple(ctx context.Context, createRequest *DropletMultiCreateRequest) ([]Droplet, *Response, error)
CreateMultiple creates multiple Droplets.
func (*DropletsServiceOp) DeleteByTag ¶ added in v1.0.0
DeleteByTag deletes Droplets matched by a Tag.
func (*DropletsServiceOp) Kernels ¶ added in v0.9.0
func (s *DropletsServiceOp) Kernels(ctx context.Context, dropletID int, opt *ListOptions) ([]Kernel, *Response, error)
Kernels lists kernels available for a Droplet.
func (*DropletsServiceOp) List ¶ added in v0.3.0
func (s *DropletsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Droplet, *Response, error)
List all Droplets.
func (*DropletsServiceOp) ListByTag ¶ added in v1.0.0
func (s *DropletsServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Droplet, *Response, error)
ListByTag lists all Droplets matched by a Tag.
func (*DropletsServiceOp) Neighbors ¶ added in v0.9.0
func (s *DropletsServiceOp) Neighbors(ctx context.Context, dropletID int) ([]Droplet, *Response, error)
Neighbors lists the neighbors for a Droplet.
func (*DropletsServiceOp) Snapshots ¶ added in v0.9.0
func (s *DropletsServiceOp) Snapshots(ctx context.Context, dropletID int, opt *ListOptions) ([]Image, *Response, error)
Snapshots lists the snapshots available for a Droplet.
type ErrorResponse ¶
type ErrorResponse struct { // HTTP response that caused this error Response *http.Response // Error message Message string `json:"message"` // RequestID returned from the API, useful to contact support. RequestID string `json:"request_id"` }
An ErrorResponse reports the error caused by an API request
func (*ErrorResponse) Error ¶
func (r *ErrorResponse) Error() string
type Firewall ¶ added in v1.1.0
type Firewall struct { ID string `json:"id"` Name string `json:"name"` Status string `json:"status"` InboundRules []InboundRule `json:"inbound_rules"` OutboundRules []OutboundRule `json:"outbound_rules"` DropletIDs []int `json:"droplet_ids"` Tags []string `json:"tags"` Created string `json:"created_at"` PendingChanges []PendingChange `json:"pending_changes"` }
Firewall represents a DigitalOcean Firewall configuration.
type FirewallRequest ¶ added in v1.1.0
type FirewallRequest struct { Name string `json:"name"` InboundRules []InboundRule `json:"inbound_rules"` OutboundRules []OutboundRule `json:"outbound_rules"` DropletIDs []int `json:"droplet_ids"` Tags []string `json:"tags"` }
FirewallRequest represents the configuration to be applied to an existing or a new Firewall.
type FirewallRulesRequest ¶ added in v1.1.0
type FirewallRulesRequest struct { InboundRules []InboundRule `json:"inbound_rules"` OutboundRules []OutboundRule `json:"outbound_rules"` }
FirewallRulesRequest represents rules configuration to be applied to an existing Firewall.
type FirewallsService ¶ added in v1.1.0
type FirewallsService interface { Get(context.Context, string) (*Firewall, *Response, error) Create(context.Context, *FirewallRequest) (*Firewall, *Response, error) Update(context.Context, string, *FirewallRequest) (*Firewall, *Response, error) Delete(context.Context, string) (*Response, error) List(context.Context, *ListOptions) ([]Firewall, *Response, error) ListByDroplet(context.Context, int, *ListOptions) ([]Firewall, *Response, error) AddDroplets(context.Context, string, ...int) (*Response, error) RemoveDroplets(context.Context, string, ...int) (*Response, error) AddTags(context.Context, string, ...string) (*Response, error) RemoveTags(context.Context, string, ...string) (*Response, error) AddRules(context.Context, string, *FirewallRulesRequest) (*Response, error) RemoveRules(context.Context, string, *FirewallRulesRequest) (*Response, error) }
FirewallsService is an interface for managing Firewalls with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Firewalls
type FirewallsServiceOp ¶ added in v1.1.0
type FirewallsServiceOp struct {
// contains filtered or unexported fields
}
FirewallsServiceOp handles communication with Firewalls methods of the DigitalOcean API.
func (*FirewallsServiceOp) AddDroplets ¶ added in v1.1.0
func (fw *FirewallsServiceOp) AddDroplets(ctx context.Context, fID string, dropletIDs ...int) (*Response, error)
AddDroplets to a Firewall.
func (*FirewallsServiceOp) AddRules ¶ added in v1.1.0
func (fw *FirewallsServiceOp) AddRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
AddRules to a Firewall.
func (*FirewallsServiceOp) AddTags ¶ added in v1.1.0
func (fw *FirewallsServiceOp) AddTags(ctx context.Context, fID string, tags ...string) (*Response, error)
AddTags to a Firewall.
func (*FirewallsServiceOp) Create ¶ added in v1.1.0
func (fw *FirewallsServiceOp) Create(ctx context.Context, fr *FirewallRequest) (*Firewall, *Response, error)
Create a new Firewall with a given configuration.
func (*FirewallsServiceOp) List ¶ added in v1.1.0
func (fw *FirewallsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Firewall, *Response, error)
List Firewalls.
func (*FirewallsServiceOp) ListByDroplet ¶ added in v1.1.0
func (fw *FirewallsServiceOp) ListByDroplet(ctx context.Context, dID int, opt *ListOptions) ([]Firewall, *Response, error)
ListByDroplet Firewalls.
func (*FirewallsServiceOp) RemoveDroplets ¶ added in v1.1.0
func (fw *FirewallsServiceOp) RemoveDroplets(ctx context.Context, fID string, dropletIDs ...int) (*Response, error)
RemoveDroplets from a Firewall.
func (*FirewallsServiceOp) RemoveRules ¶ added in v1.1.0
func (fw *FirewallsServiceOp) RemoveRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
RemoveRules from a Firewall.
func (*FirewallsServiceOp) RemoveTags ¶ added in v1.1.0
func (fw *FirewallsServiceOp) RemoveTags(ctx context.Context, fID string, tags ...string) (*Response, error)
RemoveTags from a Firewall.
func (*FirewallsServiceOp) Update ¶ added in v1.1.0
func (fw *FirewallsServiceOp) Update(ctx context.Context, fID string, fr *FirewallRequest) (*Firewall, *Response, error)
Update an existing Firewall with new configuration.
type FloatingIP ¶ added in v1.0.0
type FloatingIP struct { Region *Region `json:"region"` Droplet *Droplet `json:"droplet"` IP string `json:"ip"` }
FloatingIP represents a Digital Ocean floating IP.
func (FloatingIP) String ¶ added in v1.0.0
func (f FloatingIP) String() string
func (FloatingIP) URN ¶ added in v1.6.0
func (f FloatingIP) URN() string
URN returns the floating IP in a valid DO API URN form.
type FloatingIPActionsService ¶ added in v1.0.0
type FloatingIPActionsService interface { Assign(ctx context.Context, ip string, dropletID int) (*Action, *Response, error) Unassign(ctx context.Context, ip string) (*Action, *Response, error) Get(ctx context.Context, ip string, actionID int) (*Action, *Response, error) List(ctx context.Context, ip string, opt *ListOptions) ([]Action, *Response, error) }
FloatingIPActionsService is an interface for interfacing with the floating IPs actions endpoints of the Digital Ocean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IP-Actions
type FloatingIPActionsServiceOp ¶ added in v1.0.0
type FloatingIPActionsServiceOp struct {
// contains filtered or unexported fields
}
FloatingIPActionsServiceOp handles communication with the floating IPs action related methods of the DigitalOcean API.
func (*FloatingIPActionsServiceOp) Assign ¶ added in v1.0.0
func (s *FloatingIPActionsServiceOp) Assign(ctx context.Context, ip string, dropletID int) (*Action, *Response, error)
Assign a floating IP to a droplet.
func (*FloatingIPActionsServiceOp) Get ¶ added in v1.0.0
func (s *FloatingIPActionsServiceOp) Get(ctx context.Context, ip string, actionID int) (*Action, *Response, error)
Get an action for a particular floating IP by id.
func (*FloatingIPActionsServiceOp) List ¶ added in v1.0.0
func (s *FloatingIPActionsServiceOp) List(ctx context.Context, ip string, opt *ListOptions) ([]Action, *Response, error)
List the actions for a particular floating IP.
type FloatingIPCreateRequest ¶ added in v1.0.0
type FloatingIPCreateRequest struct { Region string `json:"region,omitempty"` DropletID int `json:"droplet_id,omitempty"` }
FloatingIPCreateRequest represents a request to create a floating IP. Specify DropletID to assign the floating IP to a Droplet or Region to reserve it to the region.
type FloatingIPsService ¶ added in v1.0.0
type FloatingIPsService interface { List(context.Context, *ListOptions) ([]FloatingIP, *Response, error) Get(context.Context, string) (*FloatingIP, *Response, error) Create(context.Context, *FloatingIPCreateRequest) (*FloatingIP, *Response, error) Delete(context.Context, string) (*Response, error) }
FloatingIPsService is an interface for interfacing with the floating IPs endpoints of the Digital Ocean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IPs
type FloatingIPsServiceOp ¶ added in v1.0.0
type FloatingIPsServiceOp struct {
// contains filtered or unexported fields
}
FloatingIPsServiceOp handles communication with the floating IPs related methods of the DigitalOcean API.
func (*FloatingIPsServiceOp) Create ¶ added in v1.0.0
func (f *FloatingIPsServiceOp) Create(ctx context.Context, createRequest *FloatingIPCreateRequest) (*FloatingIP, *Response, error)
Create a floating IP. If the DropletID field of the request is not empty, the floating IP will also be assigned to the droplet.
func (*FloatingIPsServiceOp) Get ¶ added in v1.0.0
func (f *FloatingIPsServiceOp) Get(ctx context.Context, ip string) (*FloatingIP, *Response, error)
Get an individual floating IP.
func (*FloatingIPsServiceOp) List ¶ added in v1.0.0
func (f *FloatingIPsServiceOp) List(ctx context.Context, opt *ListOptions) ([]FloatingIP, *Response, error)
List all floating IPs.
type ForwardingRule ¶ added in v1.0.0
type ForwardingRule struct { EntryProtocol string `json:"entry_protocol,omitempty"` EntryPort int `json:"entry_port,omitempty"` TargetProtocol string `json:"target_protocol,omitempty"` TargetPort int `json:"target_port,omitempty"` CertificateID string `json:"certificate_id,omitempty"` TlsPassthrough bool `json:"tls_passthrough,omitempty"` }
ForwardingRule represents load balancer forwarding rules.
func (ForwardingRule) String ¶ added in v1.0.0
func (f ForwardingRule) String() string
String creates a human-readable description of a ForwardingRule.
type GarbageCollection ¶ added in v1.67.0
type GarbageCollection struct { UUID string `json:"uuid"` RegistryName string `json:"registry_name"` Status string `json:"status"` Type GarbageCollectionType `json:"type"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` BlobsDeleted uint64 `json:"blobs_deleted"` FreedBytes uint64 `json:"freed_bytes"` }
GarbageCollection represents a garbage collection.
type GarbageCollectionType ¶ added in v1.67.0
type GarbageCollectionType string
type GitHubSourceSpec ¶ added in v1.67.0
type GitHubSourceSpec struct { Repo string `json:"repo,omitempty"` Branch string `json:"branch,omitempty"` DeployOnPush bool `json:"deploy_on_push,omitempty"` }
GitHubSourceSpec struct for GitHubSourceSpec
type GitLabSourceSpec ¶ added in v1.67.0
type GitLabSourceSpec struct { Repo string `json:"repo,omitempty"` Branch string `json:"branch,omitempty"` DeployOnPush bool `json:"deploy_on_push,omitempty"` }
GitLabSourceSpec struct for GitLabSourceSpec
type GitSourceSpec ¶ added in v1.67.0
type GitSourceSpec struct { RepoCloneURL string `json:"repo_clone_url,omitempty"` Branch string `json:"branch,omitempty"` }
GitSourceSpec struct for GitSourceSpec
type HealthCheck ¶ added in v1.0.0
type HealthCheck struct { Protocol string `json:"protocol,omitempty"` Port int `json:"port,omitempty"` Path string `json:"path,omitempty"` CheckIntervalSeconds int `json:"check_interval_seconds,omitempty"` ResponseTimeoutSeconds int `json:"response_timeout_seconds,omitempty"` HealthyThreshold int `json:"healthy_threshold,omitempty"` UnhealthyThreshold int `json:"unhealthy_threshold,omitempty"` }
HealthCheck represents optional load balancer health check rules.
func (HealthCheck) String ¶ added in v1.0.0
func (h HealthCheck) String() string
String creates a human-readable description of a HealthCheck.
type Image ¶
type Image struct { ID int `json:"id,float64,omitempty"` Name string `json:"name,omitempty"` Type string `json:"type,omitempty"` Distribution string `json:"distribution,omitempty"` Slug string `json:"slug,omitempty"` Public bool `json:"public,omitempty"` Regions []string `json:"regions,omitempty"` MinDiskSize int `json:"min_disk_size,omitempty"` SizeGigaBytes float64 `json:"size_gigabytes,omitempty"` Created string `json:"created_at,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` Status string `json:"status,omitempty"` ErrorMessage string `json:"error_message,omitempty"` }
Image represents a DigitalOcean Image
type ImageActionsService ¶
type ImageActionsService interface { Get(context.Context, int, int) (*Action, *Response, error) Transfer(context.Context, int, *ActionRequest) (*Action, *Response, error) Convert(context.Context, int) (*Action, *Response, error) }
ImageActionsService is an interface for interfacing with the image actions endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Image-Actions
type ImageActionsServiceOp ¶ added in v0.3.0
type ImageActionsServiceOp struct {
// contains filtered or unexported fields
}
ImageActionsServiceOp handles communition with the image action related methods of the DigitalOcean API.
func (*ImageActionsServiceOp) Convert ¶ added in v1.0.0
func (i *ImageActionsServiceOp) Convert(ctx context.Context, imageID int) (*Action, *Response, error)
Convert an image to a snapshot
func (*ImageActionsServiceOp) Get ¶ added in v0.3.0
func (i *ImageActionsServiceOp) Get(ctx context.Context, imageID, actionID int) (*Action, *Response, error)
Get an action for a particular image by id.
func (*ImageActionsServiceOp) Transfer ¶ added in v0.3.0
func (i *ImageActionsServiceOp) Transfer(ctx context.Context, imageID int, transferRequest *ActionRequest) (*Action, *Response, error)
Transfer an image
type ImageSourceSpec ¶ added in v1.67.0
type ImageSourceSpec struct { RegistryType ImageSourceSpecRegistryType `json:"registry_type,omitempty"` // The registry name. Must be left empty for the `DOCR` registry type. Required for the `DOCKER_HUB` registry type. Registry string `json:"registry,omitempty"` // The repository name. Repository string `json:"repository,omitempty"` // The repository tag. Defaults to `latest` if not provided. Tag string `json:"tag,omitempty"` }
ImageSourceSpec struct for ImageSourceSpec
type ImageSourceSpecRegistryType ¶ added in v1.67.0
type ImageSourceSpecRegistryType string
ImageSourceSpecRegistryType - DOCR: The DigitalOcean container registry type. - DOCKER_HUB: The DockerHub container registry type.
const ( ImageSourceSpecRegistryType_Unspecified ImageSourceSpecRegistryType = "UNSPECIFIED" ImageSourceSpecRegistryType_DOCR ImageSourceSpecRegistryType = "DOCR" ImageSourceSpecRegistryType_DockerHub ImageSourceSpecRegistryType = "DOCKER_HUB" )
List of ImageSourceSpecRegistryType
type ImageUpdateRequest ¶ added in v0.9.0
type ImageUpdateRequest struct { Name string `json:"name,omitempty"` Distribution string `json:"distribution,omitempty"` Description string `json:"description,omitempty"` }
ImageUpdateRequest represents a request to update an image.
type ImagesService ¶
type ImagesService interface { List(context.Context, *ListOptions) ([]Image, *Response, error) ListDistribution(ctx context.Context, opt *ListOptions) ([]Image, *Response, error) ListApplication(ctx context.Context, opt *ListOptions) ([]Image, *Response, error) ListUser(ctx context.Context, opt *ListOptions) ([]Image, *Response, error) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Image, *Response, error) GetByID(context.Context, int) (*Image, *Response, error) GetBySlug(context.Context, string) (*Image, *Response, error) Create(context.Context, *CustomImageCreateRequest) (*Image, *Response, error) Update(context.Context, int, *ImageUpdateRequest) (*Image, *Response, error) Delete(context.Context, int) (*Response, error) }
ImagesService is an interface for interfacing with the images endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Images
type ImagesServiceOp ¶ added in v0.3.0
type ImagesServiceOp struct {
// contains filtered or unexported fields
}
ImagesServiceOp handles communication with the image related methods of the DigitalOcean API.
func (*ImagesServiceOp) Create ¶ added in v1.7.1
func (s *ImagesServiceOp) Create(ctx context.Context, createRequest *CustomImageCreateRequest) (*Image, *Response, error)
Create a new image
func (*ImagesServiceOp) List ¶ added in v0.3.0
func (s *ImagesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
List lists all the images available.
func (*ImagesServiceOp) ListApplication ¶ added in v0.9.0
func (s *ImagesServiceOp) ListApplication(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
ListApplication lists all the application images.
func (*ImagesServiceOp) ListByTag ¶ added in v1.7.1
func (s *ImagesServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Image, *Response, error)
ListByTag lists all images with a specific tag applied.
func (*ImagesServiceOp) ListDistribution ¶ added in v0.9.0
func (s *ImagesServiceOp) ListDistribution(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
ListDistribution lists all the distribution images.
func (*ImagesServiceOp) ListUser ¶ added in v0.9.0
func (s *ImagesServiceOp) ListUser(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
ListUser lists all the user images.
func (*ImagesServiceOp) Update ¶ added in v0.9.0
func (s *ImagesServiceOp) Update(ctx context.Context, imageID int, updateRequest *ImageUpdateRequest) (*Image, *Response, error)
Update an image name.
type InboundRule ¶ added in v1.1.0
type InboundRule struct { Protocol string `json:"protocol,omitempty"` PortRange string `json:"ports,omitempty"` Sources *Sources `json:"sources"` }
InboundRule represents a DigitalOcean Firewall inbound rule.
type InstallKubernetesAppsRequest ¶ added in v1.67.0
type InstallKubernetesAppsRequest struct { Slugs []string `json:"addon_slugs"` ClusterUUID string `json:"cluster_uuid"` }
InstallKubernetesAppsRequest represents a request required to install 1-click kubernetes apps
type InstallKubernetesAppsResponse ¶ added in v1.67.0
type InstallKubernetesAppsResponse struct {
Message string `json:"message"`
}
InstallKubernetesAppsResponse is the response of a kubernetes 1-click install request
type Invoice ¶ added in v1.67.0
type Invoice struct { InvoiceItems []InvoiceItem `json:"invoice_items"` Links *Links `json:"links"` Meta *Meta `json:"meta"` }
Invoice represents a DigitalOcean Invoice
type InvoiceItem ¶ added in v1.67.0
type InvoiceItem struct { Product string `json:"product"` ResourceID string `json:"resource_id"` ResourceUUID string `json:"resource_uuid"` GroupDescription string `json:"group_description"` Description string `json:"description"` Amount string `json:"amount"` Duration string `json:"duration"` DurationUnit string `json:"duration_unit"` StartTime time.Time `json:"start_time"` EndTime time.Time `json:"end_time"` ProjectName string `json:"project_name"` Category string `json:"category"` }
InvoiceItem represents a line-item on a DigitalOcean Invoice
type InvoiceList ¶ added in v1.67.0
type InvoiceList struct { Invoices []InvoiceListItem `json:"invoices"` InvoicePreview InvoiceListItem `json:"invoice_preview"` Links *Links `json:"links"` Meta *Meta `json:"meta"` }
InvoiceList contains a paginated list of all of a customer's invoices. The InvoicePreview is the month-to-date usage generated by DigitalOcean.
type InvoiceListItem ¶ added in v1.67.0
type InvoiceListItem struct { InvoiceUUID string `json:"invoice_uuid"` Amount string `json:"amount"` InvoicePeriod string `json:"invoice_period"` UpdatedAt time.Time `json:"updated_at"` }
InvoiceListItem contains a small list of information about a customer's invoice. More information can be found in the Invoice or InvoiceSummary
type InvoiceSummary ¶ added in v1.67.0
type InvoiceSummary struct { InvoiceUUID string `json:"invoice_uuid"` BillingPeriod string `json:"billing_period"` Amount string `json:"amount"` UserName string `json:"user_name"` UserBillingAddress Address `json:"user_billing_address"` UserCompany string `json:"user_company"` UserEmail string `json:"user_email"` ProductCharges InvoiceSummaryBreakdown `json:"product_charges"` Overages InvoiceSummaryBreakdown `json:"overages"` Taxes InvoiceSummaryBreakdown `json:"taxes"` CreditsAndAdjustments InvoiceSummaryBreakdown `json:"credits_and_adjustments"` }
InvoiceSummary contains metadata and summarized usage for an invoice generated by DigitalOcean
type InvoiceSummaryBreakdown ¶ added in v1.67.0
type InvoiceSummaryBreakdown struct { Name string `json:"name"` Amount string `json:"amount"` Items []InvoiceSummaryBreakdownItem `json:"items"` }
InvoiceSummaryBreakdown is a grouped set of InvoiceItems from an invoice
type InvoiceSummaryBreakdownItem ¶ added in v1.67.0
type InvoiceSummaryBreakdownItem struct { Name string `json:"name"` Amount string `json:"amount"` Count string `json:"count"` }
InvoiceSummaryBreakdownItem further breaks down the InvoiceSummary by product
type InvoicesService ¶ added in v1.67.0
type InvoicesService interface { Get(context.Context, string, *ListOptions) (*Invoice, *Response, error) GetPDF(context.Context, string) ([]byte, *Response, error) GetCSV(context.Context, string) ([]byte, *Response, error) List(context.Context, *ListOptions) (*InvoiceList, *Response, error) GetSummary(context.Context, string) (*InvoiceSummary, *Response, error) }
InvoicesService is an interface for interfacing with the Invoice endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Billing
type InvoicesServiceOp ¶ added in v1.67.0
type InvoicesServiceOp struct {
// contains filtered or unexported fields
}
InvoicesServiceOp handles communication with the Invoice related methods of the DigitalOcean API.
func (*InvoicesServiceOp) Get ¶ added in v1.67.0
func (s *InvoicesServiceOp) Get(ctx context.Context, invoiceUUID string, opt *ListOptions) (*Invoice, *Response, error)
Get detailed invoice items for an Invoice
func (*InvoicesServiceOp) GetCSV ¶ added in v1.67.0
func (s *InvoicesServiceOp) GetCSV(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
GetCSV returns the csv for an Invoice
func (*InvoicesServiceOp) GetPDF ¶ added in v1.67.0
func (s *InvoicesServiceOp) GetPDF(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
GetPDF returns the pdf for an Invoice
func (*InvoicesServiceOp) GetSummary ¶ added in v1.67.0
func (s *InvoicesServiceOp) GetSummary(ctx context.Context, invoiceUUID string) (*InvoiceSummary, *Response, error)
GetSummary returns a summary of metadata and summarized usage for an Invoice
func (*InvoicesServiceOp) List ¶ added in v1.67.0
func (s *InvoicesServiceOp) List(ctx context.Context, opt *ListOptions) (*InvoiceList, *Response, error)
List invoices for a customer
type Kernel ¶ added in v0.9.0
type Kernel struct { ID int `json:"id,float64,omitempty"` Name string `json:"name,omitempty"` Version string `json:"version,omitempty"` }
Kernel object
type Key ¶
type Key struct { ID int `json:"id,float64,omitempty"` Name string `json:"name,omitempty"` Fingerprint string `json:"fingerprint,omitempty"` PublicKey string `json:"public_key,omitempty"` }
Key represents a DigitalOcean Key.
type KeyCreateRequest ¶
KeyCreateRequest represents a request to create a new key.
type KeyUpdateRequest ¶ added in v0.9.0
type KeyUpdateRequest struct {
Name string `json:"name"`
}
KeyUpdateRequest represents a request to update a DigitalOcean key.
type KeysService ¶
type KeysService interface { List(context.Context, *ListOptions) ([]Key, *Response, error) GetByID(context.Context, int) (*Key, *Response, error) GetByFingerprint(context.Context, string) (*Key, *Response, error) Create(context.Context, *KeyCreateRequest) (*Key, *Response, error) UpdateByID(context.Context, int, *KeyUpdateRequest) (*Key, *Response, error) UpdateByFingerprint(context.Context, string, *KeyUpdateRequest) (*Key, *Response, error) DeleteByID(context.Context, int) (*Response, error) DeleteByFingerprint(context.Context, string) (*Response, error) }
KeysService is an interface for interfacing with the keys endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/SSH-Keys
type KeysServiceOp ¶ added in v0.3.0
type KeysServiceOp struct {
// contains filtered or unexported fields
}
KeysServiceOp handles communication with key related method of the DigitalOcean API.
func (*KeysServiceOp) Create ¶ added in v0.3.0
func (s *KeysServiceOp) Create(ctx context.Context, createRequest *KeyCreateRequest) (*Key, *Response, error)
Create a key using a KeyCreateRequest
func (*KeysServiceOp) DeleteByFingerprint ¶ added in v0.3.0
func (s *KeysServiceOp) DeleteByFingerprint(ctx context.Context, fingerprint string) (*Response, error)
DeleteByFingerprint deletes a key by its fingerprint
func (*KeysServiceOp) DeleteByID ¶ added in v0.3.0
DeleteByID deletes a key by its id
func (*KeysServiceOp) GetByFingerprint ¶ added in v0.3.0
func (s *KeysServiceOp) GetByFingerprint(ctx context.Context, fingerprint string) (*Key, *Response, error)
GetByFingerprint gets a Key by by fingerprint
func (*KeysServiceOp) List ¶ added in v0.3.0
func (s *KeysServiceOp) List(ctx context.Context, opt *ListOptions) ([]Key, *Response, error)
List all keys
func (*KeysServiceOp) UpdateByFingerprint ¶ added in v0.9.0
func (s *KeysServiceOp) UpdateByFingerprint(ctx context.Context, fingerprint string, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
UpdateByFingerprint updates a key name by fingerprint.
func (*KeysServiceOp) UpdateByID ¶ added in v0.9.0
func (s *KeysServiceOp) UpdateByID(ctx context.Context, keyID int, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
UpdateByID updates a key name by ID.
type KubernetesAssociatedResources ¶ added in v1.67.0
type KubernetesAssociatedResources struct { Volumes []*AssociatedResource `json:"volumes"` VolumeSnapshots []*AssociatedResource `json:"volume_snapshots"` LoadBalancers []*AssociatedResource `json:"load_balancers"` }
KubernetesAssociatedResources represents a cluster's associated resources
type KubernetesCluster ¶ added in v1.7.0
type KubernetesCluster struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` RegionSlug string `json:"region,omitempty"` VersionSlug string `json:"version,omitempty"` ClusterSubnet string `json:"cluster_subnet,omitempty"` ServiceSubnet string `json:"service_subnet,omitempty"` IPv4 string `json:"ipv4,omitempty"` Endpoint string `json:"endpoint,omitempty"` Tags []string `json:"tags,omitempty"` VPCUUID string `json:"vpc_uuid,omitempty"` NodePools []*KubernetesNodePool `json:"node_pools,omitempty"` MaintenancePolicy *KubernetesMaintenancePolicy `json:"maintenance_policy,omitempty"` AutoUpgrade bool `json:"auto_upgrade,omitempty"` SurgeUpgrade bool `json:"surge_upgrade,omitempty"` RegistryEnabled bool `json:"registry_enabled,omitempty"` Status *KubernetesClusterStatus `json:"status,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` }
KubernetesCluster represents a Kubernetes cluster.
func (KubernetesCluster) URN ¶ added in v1.67.0
func (kc KubernetesCluster) URN() string
URN returns the Kubernetes cluster's ID in the format of DigitalOcean URN.
type KubernetesClusterConfig ¶ added in v1.7.0
type KubernetesClusterConfig struct {
KubeconfigYAML []byte
}
KubernetesClusterConfig is the content of a Kubernetes config file, which can be used to interact with your Kubernetes cluster using `kubectl`. See: https://kubernetes.io/docs/tasks/tools/install-kubectl/
type KubernetesClusterCreateRequest ¶ added in v1.7.0
type KubernetesClusterCreateRequest struct { Name string `json:"name,omitempty"` RegionSlug string `json:"region,omitempty"` VersionSlug string `json:"version,omitempty"` Tags []string `json:"tags,omitempty"` VPCUUID string `json:"vpc_uuid,omitempty"` NodePools []*KubernetesNodePoolCreateRequest `json:"node_pools,omitempty"` MaintenancePolicy *KubernetesMaintenancePolicy `json:"maintenance_policy"` AutoUpgrade bool `json:"auto_upgrade"` SurgeUpgrade bool `json:"surge_upgrade"` }
KubernetesClusterCreateRequest represents a request to create a Kubernetes cluster.
type KubernetesClusterCredentials ¶ added in v1.67.0
type KubernetesClusterCredentials struct { Server string `json:"server"` CertificateAuthorityData []byte `json:"certificate_authority_data"` ClientCertificateData []byte `json:"client_certificate_data"` ClientKeyData []byte `json:"client_key_data"` Token string `json:"token"` ExpiresAt time.Time `json:"expires_at"` }
KubernetesClusterCredentials represents Kubernetes cluster credentials.
type KubernetesClusterCredentialsGetRequest ¶ added in v1.67.0
type KubernetesClusterCredentialsGetRequest struct {
ExpirySeconds *int `json:"expiry_seconds,omitempty"`
}
KubernetesClusterCredentialsGetRequest is a request to get cluster credentials.
type KubernetesClusterDeleteSelectiveRequest ¶ added in v1.67.0
type KubernetesClusterDeleteSelectiveRequest struct { Volumes []string `json:"volumes"` VolumeSnapshots []string `json:"volume_snapshots"` LoadBalancers []string `json:"load_balancers"` }
KubernetesClusterDeleteSelectiveRequest represents a delete selective request to delete a cluster and it's associated resources.
type KubernetesClusterRegistryRequest ¶ added in v1.67.0
type KubernetesClusterRegistryRequest struct {
ClusterUUIDs []string `json:"cluster_uuids,omitempty"`
}
KubernetesClusterRegistryRequest represents clusters to integrate with docr registry
type KubernetesClusterStatus ¶ added in v1.7.0
type KubernetesClusterStatus struct { State KubernetesClusterStatusState `json:"state,omitempty"` Message string `json:"message,omitempty"` }
KubernetesClusterStatus describes the status of a cluster.
type KubernetesClusterStatusState ¶ added in v1.7.1
type KubernetesClusterStatusState string
KubernetesClusterStatusState represents states for a cluster.
func (*KubernetesClusterStatusState) UnmarshalText ¶ added in v1.7.1
func (s *KubernetesClusterStatusState) UnmarshalText(text []byte) error
UnmarshalText unmarshals the state.
type KubernetesClusterUpdateRequest ¶ added in v1.7.0
type KubernetesClusterUpdateRequest struct { Name string `json:"name,omitempty"` Tags []string `json:"tags,omitempty"` MaintenancePolicy *KubernetesMaintenancePolicy `json:"maintenance_policy,omitempty"` AutoUpgrade *bool `json:"auto_upgrade,omitempty"` SurgeUpgrade bool `json:"surge_upgrade,omitempty"` }
KubernetesClusterUpdateRequest represents a request to update a Kubernetes cluster.
type KubernetesClusterUpgradeRequest ¶ added in v1.14.0
type KubernetesClusterUpgradeRequest struct {
VersionSlug string `json:"version,omitempty"`
}
KubernetesClusterUpgradeRequest represents a request to upgrade a Kubernetes cluster.
type KubernetesClusterUser ¶ added in v1.67.0
type KubernetesClusterUser struct { Username string `json:"username,omitempty"` Groups []string `json:"groups,omitempty"` }
KubernetesClusterUser represents a Kubernetes cluster user.
type KubernetesGetClusterlintRequest ¶ added in v1.67.0
type KubernetesGetClusterlintRequest struct {
RunId string `json:"run_id"`
}
type KubernetesMaintenancePolicy ¶ added in v1.12.0
type KubernetesMaintenancePolicy struct { StartTime string `json:"start_time"` Duration string `json:"duration"` Day KubernetesMaintenancePolicyDay `json:"day"` }
KubernetesMaintenancePolicy is a configuration to set the maintenance window of a cluster
type KubernetesMaintenancePolicyDay ¶ added in v1.12.0
type KubernetesMaintenancePolicyDay int
KubernetesMaintenancePolicyDay represents the possible days of a maintenance window
const ( // KubernetesMaintenanceDayAny sets the KubernetesMaintenancePolicyDay to any // day of the week KubernetesMaintenanceDayAny KubernetesMaintenancePolicyDay = iota // KubernetesMaintenanceDayMonday sets the KubernetesMaintenancePolicyDay to // Monday KubernetesMaintenanceDayMonday // KubernetesMaintenanceDayTuesday sets the KubernetesMaintenancePolicyDay to // Tuesday KubernetesMaintenanceDayTuesday // KubernetesMaintenanceDayWednesday sets the KubernetesMaintenancePolicyDay to // Wednesday KubernetesMaintenanceDayWednesday // KubernetesMaintenanceDayThursday sets the KubernetesMaintenancePolicyDay to // Thursday KubernetesMaintenanceDayThursday // KubernetesMaintenanceDayFriday sets the KubernetesMaintenancePolicyDay to // Friday KubernetesMaintenanceDayFriday // KubernetesMaintenanceDaySaturday sets the KubernetesMaintenancePolicyDay to // Saturday KubernetesMaintenanceDaySaturday // KubernetesMaintenanceDaySunday sets the KubernetesMaintenancePolicyDay to // Sunday KubernetesMaintenanceDaySunday )
func KubernetesMaintenanceToDay ¶ added in v1.12.0
func KubernetesMaintenanceToDay(day string) (KubernetesMaintenancePolicyDay, error)
KubernetesMaintenanceToDay returns the appropriate KubernetesMaintenancePolicyDay for the given string.
func (KubernetesMaintenancePolicyDay) MarshalJSON ¶ added in v1.12.0
func (k KubernetesMaintenancePolicyDay) MarshalJSON() ([]byte, error)
MarshalJSON returns the JSON string for KubernetesMaintenancePolicyDay
func (KubernetesMaintenancePolicyDay) String ¶ added in v1.12.0
func (k KubernetesMaintenancePolicyDay) String() string
func (*KubernetesMaintenancePolicyDay) UnmarshalJSON ¶ added in v1.12.0
func (k *KubernetesMaintenancePolicyDay) UnmarshalJSON(data []byte) error
UnmarshalJSON parses the JSON string into KubernetesMaintenancePolicyDay
type KubernetesNode ¶ added in v1.7.0
type KubernetesNode struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Status *KubernetesNodeStatus `json:"status,omitempty"` DropletID string `json:"droplet_id,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` }
KubernetesNode represents a Node in a node pool in a Kubernetes cluster.
type KubernetesNodeDeleteRequest ¶ added in v1.67.0
type KubernetesNodeDeleteRequest struct { // Replace will cause a new node to be created to replace the deleted node. Replace bool `json:"replace,omitempty"` // SkipDrain skips draining the node before deleting it. SkipDrain bool `json:"skip_drain,omitempty"` }
KubernetesNodeDeleteRequest is a request to delete a specific node in a node pool.
type KubernetesNodePool ¶ added in v1.7.0
type KubernetesNodePool struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Size string `json:"size,omitempty"` Count int `json:"count,omitempty"` Tags []string `json:"tags,omitempty"` Labels map[string]string `json:"labels,omitempty"` Taints []Taint `json:"taints,omitempty"` AutoScale bool `json:"auto_scale,omitempty"` MinNodes int `json:"min_nodes,omitempty"` MaxNodes int `json:"max_nodes,omitempty"` Nodes []*KubernetesNode `json:"nodes,omitempty"` }
KubernetesNodePool represents a node pool in a Kubernetes cluster.
type KubernetesNodePoolCreateRequest ¶ added in v1.7.0
type KubernetesNodePoolCreateRequest struct { Name string `json:"name,omitempty"` Size string `json:"size,omitempty"` Count int `json:"count,omitempty"` Tags []string `json:"tags,omitempty"` Labels map[string]string `json:"labels,omitempty"` Taints []Taint `json:"taints,omitempty"` AutoScale bool `json:"auto_scale,omitempty"` MinNodes int `json:"min_nodes,omitempty"` MaxNodes int `json:"max_nodes,omitempty"` }
KubernetesNodePoolCreateRequest represents a request to create a node pool for a Kubernetes cluster.
type KubernetesNodePoolRecycleNodesRequest ¶ added in v1.7.0
type KubernetesNodePoolRecycleNodesRequest struct {
Nodes []string `json:"nodes,omitempty"`
}
KubernetesNodePoolRecycleNodesRequest is DEPRECATED please use DeleteNode The type will be removed in godo 2.0.
type KubernetesNodePoolUpdateRequest ¶ added in v1.7.0
type KubernetesNodePoolUpdateRequest struct { Name string `json:"name,omitempty"` Count *int `json:"count,omitempty"` Tags []string `json:"tags,omitempty"` Labels map[string]string `json:"labels,omitempty"` Taints *[]Taint `json:"taints,omitempty"` AutoScale *bool `json:"auto_scale,omitempty"` MinNodes *int `json:"min_nodes,omitempty"` MaxNodes *int `json:"max_nodes,omitempty"` }
KubernetesNodePoolUpdateRequest represents a request to update a node pool in a Kubernetes cluster.
type KubernetesNodeSize ¶ added in v1.7.2
KubernetesNodeSize is a node sizes supported for Kubernetes clusters.
type KubernetesNodeStatus ¶ added in v1.7.0
type KubernetesNodeStatus struct { State string `json:"state,omitempty"` Message string `json:"message,omitempty"` }
KubernetesNodeStatus represents the status of a particular Node in a Kubernetes cluster.
type KubernetesOptions ¶ added in v1.7.0
type KubernetesOptions struct { Versions []*KubernetesVersion `json:"versions,omitempty"` Regions []*KubernetesRegion `json:"regions,omitempty"` Sizes []*KubernetesNodeSize `json:"sizes,omitempty"` }
KubernetesOptions represents options available for creating Kubernetes clusters.
type KubernetesRegion ¶ added in v1.7.2
KubernetesRegion is a region usable by Kubernetes clusters.
type KubernetesRunClusterlintRequest ¶ added in v1.67.0
type KubernetesService ¶ added in v1.7.0
type KubernetesService interface { Create(context.Context, *KubernetesClusterCreateRequest) (*KubernetesCluster, *Response, error) Get(context.Context, string) (*KubernetesCluster, *Response, error) GetUser(context.Context, string) (*KubernetesClusterUser, *Response, error) GetUpgrades(context.Context, string) ([]*KubernetesVersion, *Response, error) GetKubeConfig(context.Context, string) (*KubernetesClusterConfig, *Response, error) GetKubeConfigWithExpiry(context.Context, string, int64) (*KubernetesClusterConfig, *Response, error) GetCredentials(context.Context, string, *KubernetesClusterCredentialsGetRequest) (*KubernetesClusterCredentials, *Response, error) List(context.Context, *ListOptions) ([]*KubernetesCluster, *Response, error) Update(context.Context, string, *KubernetesClusterUpdateRequest) (*KubernetesCluster, *Response, error) Upgrade(context.Context, string, *KubernetesClusterUpgradeRequest) (*Response, error) Delete(context.Context, string) (*Response, error) DeleteSelective(context.Context, string, *KubernetesClusterDeleteSelectiveRequest) (*Response, error) DeleteDangerous(context.Context, string) (*Response, error) ListAssociatedResourcesForDeletion(context.Context, string) (*KubernetesAssociatedResources, *Response, error) CreateNodePool(ctx context.Context, clusterID string, req *KubernetesNodePoolCreateRequest) (*KubernetesNodePool, *Response, error) GetNodePool(ctx context.Context, clusterID, poolID string) (*KubernetesNodePool, *Response, error) ListNodePools(ctx context.Context, clusterID string, opts *ListOptions) ([]*KubernetesNodePool, *Response, error) UpdateNodePool(ctx context.Context, clusterID, poolID string, req *KubernetesNodePoolUpdateRequest) (*KubernetesNodePool, *Response, error) // RecycleNodePoolNodes is DEPRECATED please use DeleteNode // The method will be removed in godo 2.0. RecycleNodePoolNodes(ctx context.Context, clusterID, poolID string, req *KubernetesNodePoolRecycleNodesRequest) (*Response, error) DeleteNodePool(ctx context.Context, clusterID, poolID string) (*Response, error) DeleteNode(ctx context.Context, clusterID, poolID, nodeID string, req *KubernetesNodeDeleteRequest) (*Response, error) GetOptions(context.Context) (*KubernetesOptions, *Response, error) AddRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error) RemoveRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error) RunClusterlint(ctx context.Context, clusterID string, req *KubernetesRunClusterlintRequest) (string, *Response, error) GetClusterlintResults(ctx context.Context, clusterID string, req *KubernetesGetClusterlintRequest) ([]*ClusterlintDiagnostic, *Response, error) }
KubernetesService is an interface for interfacing with the Kubernetes endpoints of the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Kubernetes
type KubernetesServiceOp ¶ added in v1.7.0
type KubernetesServiceOp struct {
// contains filtered or unexported fields
}
KubernetesServiceOp handles communication with Kubernetes methods of the DigitalOcean API.
func (*KubernetesServiceOp) AddRegistry ¶ added in v1.67.0
func (svc *KubernetesServiceOp) AddRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
AddRegistry integrates docr registry with all the specified clusters
func (*KubernetesServiceOp) Create ¶ added in v1.7.0
func (svc *KubernetesServiceOp) Create(ctx context.Context, create *KubernetesClusterCreateRequest) (*KubernetesCluster, *Response, error)
Create creates a Kubernetes cluster.
func (*KubernetesServiceOp) CreateNodePool ¶ added in v1.7.0
func (svc *KubernetesServiceOp) CreateNodePool(ctx context.Context, clusterID string, create *KubernetesNodePoolCreateRequest) (*KubernetesNodePool, *Response, error)
CreateNodePool creates a new node pool in an existing Kubernetes cluster.
func (*KubernetesServiceOp) Delete ¶ added in v1.7.0
Delete deletes a Kubernetes cluster. There is no way to recover a cluster once it has been destroyed.
func (*KubernetesServiceOp) DeleteDangerous ¶ added in v1.67.0
func (svc *KubernetesServiceOp) DeleteDangerous(ctx context.Context, clusterID string) (*Response, error)
DeleteDangerous deletes a Kubernetes cluster and all its associated resources. There is no way to recover a cluster or it's associated resources once destroyed.
func (*KubernetesServiceOp) DeleteNode ¶ added in v1.67.0
func (svc *KubernetesServiceOp) DeleteNode(ctx context.Context, clusterID, poolID, nodeID string, deleteReq *KubernetesNodeDeleteRequest) (*Response, error)
DeleteNode deletes a specific node in a node pool.
func (*KubernetesServiceOp) DeleteNodePool ¶ added in v1.7.0
func (svc *KubernetesServiceOp) DeleteNodePool(ctx context.Context, clusterID, poolID string) (*Response, error)
DeleteNodePool deletes a node pool, and subsequently all the nodes in that pool.
func (*KubernetesServiceOp) DeleteSelective ¶ added in v1.67.0
func (svc *KubernetesServiceOp) DeleteSelective(ctx context.Context, clusterID string, request *KubernetesClusterDeleteSelectiveRequest) (*Response, error)
DeleteSelective deletes a Kubernetes cluster and the specified associated resources. Users can choose to delete specific volumes, volume snapshots or load balancers along with the cluster There is no way to recover a cluster or the specified resources once destroyed.
func (*KubernetesServiceOp) Get ¶ added in v1.7.0
func (svc *KubernetesServiceOp) Get(ctx context.Context, clusterID string) (*KubernetesCluster, *Response, error)
Get retrieves the details of a Kubernetes cluster.
func (*KubernetesServiceOp) GetClusterlintResults ¶ added in v1.67.0
func (svc *KubernetesServiceOp) GetClusterlintResults(ctx context.Context, clusterID string, req *KubernetesGetClusterlintRequest) ([]*ClusterlintDiagnostic, *Response, error)
GetClusterlintResults fetches the diagnostics after clusterlint run completes
func (*KubernetesServiceOp) GetCredentials ¶ added in v1.67.0
func (svc *KubernetesServiceOp) GetCredentials(ctx context.Context, clusterID string, get *KubernetesClusterCredentialsGetRequest) (*KubernetesClusterCredentials, *Response, error)
GetCredentials returns a Kubernetes API server credentials for the specified cluster.
func (*KubernetesServiceOp) GetKubeConfig ¶ added in v1.7.0
func (svc *KubernetesServiceOp) GetKubeConfig(ctx context.Context, clusterID string) (*KubernetesClusterConfig, *Response, error)
GetKubeConfig returns a Kubernetes config file for the specified cluster.
func (*KubernetesServiceOp) GetKubeConfigWithExpiry ¶ added in v1.67.0
func (svc *KubernetesServiceOp) GetKubeConfigWithExpiry(ctx context.Context, clusterID string, expirySeconds int64) (*KubernetesClusterConfig, *Response, error)
GetKubeConfigWithExpiry returns a Kubernetes config file for the specified cluster with expiry_seconds.
func (*KubernetesServiceOp) GetNodePool ¶ added in v1.7.0
func (svc *KubernetesServiceOp) GetNodePool(ctx context.Context, clusterID, poolID string) (*KubernetesNodePool, *Response, error)
GetNodePool retrieves an existing node pool in a Kubernetes cluster.
func (*KubernetesServiceOp) GetOptions ¶ added in v1.7.0
func (svc *KubernetesServiceOp) GetOptions(ctx context.Context) (*KubernetesOptions, *Response, error)
GetOptions returns options about the Kubernetes service, such as the versions available for cluster creation.
func (*KubernetesServiceOp) GetUpgrades ¶ added in v1.14.0
func (svc *KubernetesServiceOp) GetUpgrades(ctx context.Context, clusterID string) ([]*KubernetesVersion, *Response, error)
GetUpgrades retrieves versions a Kubernetes cluster can be upgraded to. An upgrade can be requested using `Upgrade`.
func (*KubernetesServiceOp) GetUser ¶ added in v1.67.0
func (svc *KubernetesServiceOp) GetUser(ctx context.Context, clusterID string) (*KubernetesClusterUser, *Response, error)
GetUser retrieves the details of a Kubernetes cluster user.
func (*KubernetesServiceOp) List ¶ added in v1.7.0
func (svc *KubernetesServiceOp) List(ctx context.Context, opts *ListOptions) ([]*KubernetesCluster, *Response, error)
List returns a list of the Kubernetes clusters visible with the caller's API token.
func (*KubernetesServiceOp) ListAssociatedResourcesForDeletion ¶ added in v1.67.0
func (svc *KubernetesServiceOp) ListAssociatedResourcesForDeletion(ctx context.Context, clusterID string) (*KubernetesAssociatedResources, *Response, error)
ListAssociatedResourcesForDeletion lists a Kubernetes cluster's resources that can be selected for deletion along with the cluster. See DeleteSelective Associated resources include volumes, volume snapshots and load balancers.
func (*KubernetesServiceOp) ListNodePools ¶ added in v1.7.0
func (svc *KubernetesServiceOp) ListNodePools(ctx context.Context, clusterID string, opts *ListOptions) ([]*KubernetesNodePool, *Response, error)
ListNodePools lists all the node pools found in a Kubernetes cluster.
func (*KubernetesServiceOp) RecycleNodePoolNodes ¶ added in v1.7.0
func (svc *KubernetesServiceOp) RecycleNodePoolNodes(ctx context.Context, clusterID, poolID string, recycle *KubernetesNodePoolRecycleNodesRequest) (*Response, error)
RecycleNodePoolNodes is DEPRECATED please use DeleteNode The method will be removed in godo 2.0.
func (*KubernetesServiceOp) RemoveRegistry ¶ added in v1.67.0
func (svc *KubernetesServiceOp) RemoveRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
RemoveRegistry removes docr registry support for all the specified clusters
func (*KubernetesServiceOp) RunClusterlint ¶ added in v1.67.0
func (svc *KubernetesServiceOp) RunClusterlint(ctx context.Context, clusterID string, req *KubernetesRunClusterlintRequest) (string, *Response, error)
RunClusterlint schedules a clusterlint run for the specified cluster
func (*KubernetesServiceOp) Update ¶ added in v1.7.0
func (svc *KubernetesServiceOp) Update(ctx context.Context, clusterID string, update *KubernetesClusterUpdateRequest) (*KubernetesCluster, *Response, error)
Update updates a Kubernetes cluster's properties.
func (*KubernetesServiceOp) UpdateNodePool ¶ added in v1.7.0
func (svc *KubernetesServiceOp) UpdateNodePool(ctx context.Context, clusterID, poolID string, update *KubernetesNodePoolUpdateRequest) (*KubernetesNodePool, *Response, error)
UpdateNodePool updates the details of an existing node pool.
func (*KubernetesServiceOp) Upgrade ¶ added in v1.14.0
func (svc *KubernetesServiceOp) Upgrade(ctx context.Context, clusterID string, upgrade *KubernetesClusterUpgradeRequest) (*Response, error)
Upgrade upgrades a Kubernetes cluster to a new version. Valid upgrade versions for a given cluster can be retrieved with `GetUpgrades`.
type KubernetesVersion ¶ added in v1.7.0
type KubernetesVersion struct { Slug string `json:"slug,omitempty"` KubernetesVersion string `json:"kubernetes_version,omitempty"` SupportedFeatures []string `json:"supported_features,omitempty"` }
KubernetesVersion is a DigitalOcean Kubernetes release.
type LinkAction ¶ added in v0.3.0
type LinkAction struct { ID int `json:"id,omitempty"` Rel string `json:"rel,omitempty"` HREF string `json:"href,omitempty"` }
LinkAction is a pointer to an action
type Links ¶
type Links struct { Pages *Pages `json:"pages,omitempty"` Actions []LinkAction `json:"actions,omitempty"` }
Links manages links that are returned along with a List
func (*Links) CurrentPage ¶ added in v0.3.0
CurrentPage is current page of the list
func (*Links) IsLastPage ¶ added in v0.3.0
IsLastPage returns true if the current page is the last
type ListOptions ¶
type ListOptions struct { // For paginated result sets, page of results to retrieve. Page int `url:"page,omitempty"` // For paginated result sets, the number of results to include per page. PerPage int `url:"per_page,omitempty"` }
ListOptions specifies the optional parameters to various List methods that support pagination.
type ListVolumeParams ¶ added in v1.0.0
type ListVolumeParams struct { Region string `json:"region"` Name string `json:"name"` ListOptions *ListOptions `json:"list_options,omitempty"` }
ListVolumeParams stores the options you can set for a ListVolumeCall
type LoadBalancer ¶ added in v1.0.0
type LoadBalancer struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` IP string `json:"ip,omitempty"` // SizeSlug is mutually exclusive with SizeUnit. Only one should be specified SizeSlug string `json:"size,omitempty"` // SizeUnit is mutually exclusive with SizeSlug. Only one should be specified SizeUnit uint32 `json:"size_unit,omitempty"` Algorithm string `json:"algorithm,omitempty"` Status string `json:"status,omitempty"` Created string `json:"created_at,omitempty"` ForwardingRules []ForwardingRule `json:"forwarding_rules,omitempty"` HealthCheck *HealthCheck `json:"health_check,omitempty"` StickySessions *StickySessions `json:"sticky_sessions,omitempty"` Region *Region `json:"region,omitempty"` DropletIDs []int `json:"droplet_ids,omitempty"` Tag string `json:"tag,omitempty"` Tags []string `json:"tags,omitempty"` RedirectHttpToHttps bool `json:"redirect_http_to_https,omitempty"` EnableProxyProtocol bool `json:"enable_proxy_protocol,omitempty"` EnableBackendKeepalive bool `json:"enable_backend_keepalive,omitempty"` VPCUUID string `json:"vpc_uuid,omitempty"` }
LoadBalancer represents a DigitalOcean load balancer configuration. Tags can only be provided upon the creation of a Load Balancer.
func (LoadBalancer) AsRequest ¶ added in v1.1.1
func (l LoadBalancer) AsRequest() *LoadBalancerRequest
AsRequest creates a LoadBalancerRequest that can be submitted to Update with the current values of the LoadBalancer. Modifying the returned LoadBalancerRequest will not modify the original LoadBalancer.
func (LoadBalancer) String ¶ added in v1.0.0
func (l LoadBalancer) String() string
String creates a human-readable description of a LoadBalancer.
func (LoadBalancer) URN ¶ added in v1.6.0
func (l LoadBalancer) URN() string
URN returns the load balancer ID in a valid DO API URN form.
type LoadBalancerRequest ¶ added in v1.0.0
type LoadBalancerRequest struct { Name string `json:"name,omitempty"` Algorithm string `json:"algorithm,omitempty"` Region string `json:"region,omitempty"` // SizeSlug is mutually exclusive with SizeUnit. Only one should be specified SizeSlug string `json:"size,omitempty"` // SizeUnit is mutually exclusive with SizeSlug. Only one should be specified SizeUnit uint32 `json:"size_unit,omitempty"` ForwardingRules []ForwardingRule `json:"forwarding_rules,omitempty"` HealthCheck *HealthCheck `json:"health_check,omitempty"` StickySessions *StickySessions `json:"sticky_sessions,omitempty"` DropletIDs []int `json:"droplet_ids,omitempty"` Tag string `json:"tag,omitempty"` Tags []string `json:"tags,omitempty"` RedirectHttpToHttps bool `json:"redirect_http_to_https,omitempty"` EnableProxyProtocol bool `json:"enable_proxy_protocol,omitempty"` EnableBackendKeepalive bool `json:"enable_backend_keepalive,omitempty"` VPCUUID string `json:"vpc_uuid,omitempty"` }
LoadBalancerRequest represents the configuration to be applied to an existing or a new load balancer.
func (LoadBalancerRequest) String ¶ added in v1.0.0
func (l LoadBalancerRequest) String() string
String creates a human-readable description of a LoadBalancerRequest.
type LoadBalancersService ¶ added in v1.0.0
type LoadBalancersService interface { Get(context.Context, string) (*LoadBalancer, *Response, error) List(context.Context, *ListOptions) ([]LoadBalancer, *Response, error) Create(context.Context, *LoadBalancerRequest) (*LoadBalancer, *Response, error) Update(ctx context.Context, lbID string, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error) Delete(ctx context.Context, lbID string) (*Response, error) AddDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error) RemoveDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error) AddForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error) RemoveForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error) }
LoadBalancersService is an interface for managing load balancers with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Load-Balancers
type LoadBalancersServiceOp ¶ added in v1.0.0
type LoadBalancersServiceOp struct {
// contains filtered or unexported fields
}
LoadBalancersServiceOp handles communication with load balancer-related methods of the DigitalOcean API.
func (*LoadBalancersServiceOp) AddDroplets ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) AddDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error)
AddDroplets adds droplets to a load balancer.
func (*LoadBalancersServiceOp) AddForwardingRules ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) AddForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
AddForwardingRules adds forwarding rules to a load balancer.
func (*LoadBalancersServiceOp) Create ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) Create(ctx context.Context, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
Create a new load balancer with a given configuration.
func (*LoadBalancersServiceOp) Get ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) Get(ctx context.Context, lbID string) (*LoadBalancer, *Response, error)
Get an existing load balancer by its identifier.
func (*LoadBalancersServiceOp) List ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) List(ctx context.Context, opt *ListOptions) ([]LoadBalancer, *Response, error)
List load balancers, with optional pagination.
func (*LoadBalancersServiceOp) RemoveDroplets ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) RemoveDroplets(ctx context.Context, lbID string, dropletIDs ...int) (*Response, error)
RemoveDroplets removes droplets from a load balancer.
func (*LoadBalancersServiceOp) RemoveForwardingRules ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) RemoveForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
RemoveForwardingRules removes forwarding rules from a load balancer.
func (*LoadBalancersServiceOp) Update ¶ added in v1.0.0
func (l *LoadBalancersServiceOp) Update(ctx context.Context, lbID string, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
Update an existing load balancer with new configuration.
type Meta ¶ added in v1.67.0
type Meta struct {
Total int `json:"total"`
}
Meta describes generic information about a response.
type MonitoringService ¶ added in v1.67.0
type MonitoringService interface { ListAlertPolicies(context.Context, *ListOptions) ([]AlertPolicy, *Response, error) GetAlertPolicy(context.Context, string) (*AlertPolicy, *Response, error) CreateAlertPolicy(context.Context, *AlertPolicyCreateRequest) (*AlertPolicy, *Response, error) UpdateAlertPolicy(context.Context, string, *AlertPolicyUpdateRequest) (*AlertPolicy, *Response, error) DeleteAlertPolicy(context.Context, string) (*Response, error) }
MonitoringService is an interface for interfacing with the monitoring endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Monitoring
type MonitoringServiceOp ¶ added in v1.67.0
type MonitoringServiceOp struct {
// contains filtered or unexported fields
}
MonitoringServiceOp handles communication with monitoring related methods of the DigitalOcean API.
func (*MonitoringServiceOp) CreateAlertPolicy ¶ added in v1.67.0
func (s *MonitoringServiceOp) CreateAlertPolicy(ctx context.Context, createRequest *AlertPolicyCreateRequest) (*AlertPolicy, *Response, error)
CreateAlertPolicy creates a new alert policy
func (*MonitoringServiceOp) DeleteAlertPolicy ¶ added in v1.67.0
func (s *MonitoringServiceOp) DeleteAlertPolicy(ctx context.Context, uuid string) (*Response, error)
DeleteAlertPolicy deletes an existing alert policy
func (*MonitoringServiceOp) GetAlertPolicy ¶ added in v1.67.0
func (s *MonitoringServiceOp) GetAlertPolicy(ctx context.Context, uuid string) (*AlertPolicy, *Response, error)
GetAlertPolicy gets a single alert policy
func (*MonitoringServiceOp) ListAlertPolicies ¶ added in v1.67.0
func (s *MonitoringServiceOp) ListAlertPolicies(ctx context.Context, opt *ListOptions) ([]AlertPolicy, *Response, error)
ListAlertPolicies all alert policies
func (*MonitoringServiceOp) UpdateAlertPolicy ¶ added in v1.67.0
func (s *MonitoringServiceOp) UpdateAlertPolicy(ctx context.Context, uuid string, updateRequest *AlertPolicyUpdateRequest) (*AlertPolicy, *Response, error)
UpdateAlertPolicy updates an existing alert policy
type NetworkV4 ¶ added in v0.6.0
type NetworkV4 struct { IPAddress string `json:"ip_address,omitempty"` Netmask string `json:"netmask,omitempty"` Gateway string `json:"gateway,omitempty"` Type string `json:"type,omitempty"` }
NetworkV4 represents a DigitalOcean IPv4 Network.
type NetworkV6 ¶ added in v0.6.0
type NetworkV6 struct { IPAddress string `json:"ip_address,omitempty"` Netmask int `json:"netmask,omitempty"` Gateway string `json:"gateway,omitempty"` Type string `json:"type,omitempty"` }
NetworkV6 represents a DigitalOcean IPv6 network.
type OneClickService ¶ added in v1.67.0
type OneClickService interface { List(context.Context, string) ([]*OneClick, *Response, error) InstallKubernetes(context.Context, *InstallKubernetesAppsRequest) (*InstallKubernetesAppsResponse, *Response, error) }
OneClickService is an interface for interacting with 1-clicks with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/1-Click-Applications
type OneClickServiceOp ¶ added in v1.67.0
type OneClickServiceOp struct {
// contains filtered or unexported fields
}
OneClickServiceOp interfaces with 1-click endpoints in the DigitalOcean API.
func (*OneClickServiceOp) InstallKubernetes ¶ added in v1.67.0
func (ocs *OneClickServiceOp) InstallKubernetes(ctx context.Context, install *InstallKubernetesAppsRequest) (*InstallKubernetesAppsResponse, *Response, error)
InstallKubernetes installs an addon on a kubernetes cluster
type OneClicksRoot ¶ added in v1.67.0
type OneClicksRoot struct {
List []*OneClick `json:"1_clicks"`
}
OneClicksRoot is the root of the json payload that contains a list of 1-clicks
type OutboundRule ¶ added in v1.1.0
type OutboundRule struct { Protocol string `json:"protocol,omitempty"` PortRange string `json:"ports,omitempty"` Destinations *Destinations `json:"destinations"` }
OutboundRule represents a DigitalOcean Firewall outbound rule.
type Pages ¶ added in v0.3.0
type Pages struct { First string `json:"first,omitempty"` Prev string `json:"prev,omitempty"` Last string `json:"last,omitempty"` Next string `json:"next,omitempty"` }
Pages are pages specified in Links
type PendingChange ¶ added in v1.1.0
type PendingChange struct { DropletID int `json:"droplet_id,omitempty"` Removing bool `json:"removing,omitempty"` Status string `json:"status,omitempty"` }
PendingChange represents a DigitalOcean Firewall status details.
type Project ¶ added in v1.6.0
type Project struct { ID string `json:"id"` OwnerUUID string `json:"owner_uuid"` OwnerID uint64 `json:"owner_id"` Name string `json:"name"` Description string `json:"description"` Purpose string `json:"purpose"` Environment string `json:"environment"` IsDefault bool `json:"is_default"` CreatedAt string `json:"created_at"` UpdatedAt string `json:"updated_at"` }
Project represents a DigitalOcean Project configuration.
type ProjectResource ¶ added in v1.6.0
type ProjectResource struct { URN string `json:"urn"` AssignedAt string `json:"assigned_at"` Links *ProjectResourceLinks `json:"links"` Status string `json:"status,omitempty"` }
ProjectResource is the projects API's representation of a resource.
type ProjectResourceLinks ¶ added in v1.6.0
type ProjectResourceLinks struct {
Self string `json:"self"`
}
ProjectResourceLinks specify the link for more information about the resource.
type ProjectsService ¶ added in v1.6.0
type ProjectsService interface { List(context.Context, *ListOptions) ([]Project, *Response, error) GetDefault(context.Context) (*Project, *Response, error) Get(context.Context, string) (*Project, *Response, error) Create(context.Context, *CreateProjectRequest) (*Project, *Response, error) Update(context.Context, string, *UpdateProjectRequest) (*Project, *Response, error) Delete(context.Context, string) (*Response, error) ListResources(context.Context, string, *ListOptions) ([]ProjectResource, *Response, error) AssignResources(context.Context, string, ...interface{}) ([]ProjectResource, *Response, error) }
ProjectsService is an interface for creating and managing Projects with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects
type ProjectsServiceOp ¶ added in v1.6.0
type ProjectsServiceOp struct {
// contains filtered or unexported fields
}
ProjectsServiceOp handles communication with Projects methods of the DigitalOcean API.
func (*ProjectsServiceOp) AssignResources ¶ added in v1.6.0
func (p *ProjectsServiceOp) AssignResources(ctx context.Context, projectID string, resources ...interface{}) ([]ProjectResource, *Response, error)
AssignResources assigns one or more resources to a project. AssignResources accepts resources in two possible formats:
- The resource type, like `&Droplet{ID: 1}` or `&FloatingIP{IP: "1.2.3.4"}`
- A valid DO URN as a string, like "do:droplet:1234"
There is no unassign. To move a resource to another project, just assign it to that other project.
func (*ProjectsServiceOp) Create ¶ added in v1.6.0
func (p *ProjectsServiceOp) Create(ctx context.Context, cr *CreateProjectRequest) (*Project, *Response, error)
Create a new project.
func (*ProjectsServiceOp) Delete ¶ added in v1.6.0
Delete an existing project. You cannot have any resources in a project before deleting it. See the API documentation for more details.
func (*ProjectsServiceOp) GetDefault ¶ added in v1.6.0
GetDefault project.
func (*ProjectsServiceOp) List ¶ added in v1.6.0
func (p *ProjectsServiceOp) List(ctx context.Context, opts *ListOptions) ([]Project, *Response, error)
List Projects.
func (*ProjectsServiceOp) ListResources ¶ added in v1.6.0
func (p *ProjectsServiceOp) ListResources(ctx context.Context, projectID string, opts *ListOptions) ([]ProjectResource, *Response, error)
ListResources lists all resources in a project.
func (*ProjectsServiceOp) Update ¶ added in v1.6.0
func (p *ProjectsServiceOp) Update(ctx context.Context, projectID string, ur *UpdateProjectRequest) (*Project, *Response, error)
Update an existing project.
type Rate ¶
type Rate struct { // The number of request per hour the client is currently limited to. Limit int `json:"limit"` // The number of remaining requests the client can make this hour. Remaining int `json:"remaining"` // The time at which the current rate limit will reset. Reset Timestamp `json:"reset"` }
Rate contains the rate limit for the current client.
type Region ¶
type Region struct { Slug string `json:"slug,omitempty"` Name string `json:"name,omitempty"` Sizes []string `json:"sizes,omitempty"` Available bool `json:"available,omitempty"` Features []string `json:"features,omitempty"` }
Region represents a DigitalOcean Region
type RegionsService ¶
RegionsService is an interface for interfacing with the regions endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Regions
type RegionsServiceOp ¶ added in v0.3.0
type RegionsServiceOp struct {
// contains filtered or unexported fields
}
RegionsServiceOp handles communication with the region related methods of the DigitalOcean API.
func (*RegionsServiceOp) List ¶ added in v0.3.0
func (s *RegionsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Region, *Response, error)
List all regions
type Registry ¶ added in v1.67.0
type Registry struct { Name string `json:"name,omitempty"` StorageUsageBytes uint64 `json:"storage_usage_bytes,omitempty"` StorageUsageBytesUpdatedAt time.Time `json:"storage_usage_bytes_updated_at,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` }
Registry represents a registry.
type RegistryCreateRequest ¶ added in v1.67.0
type RegistryCreateRequest struct { Name string `json:"name,omitempty"` SubscriptionTierSlug string `json:"subscription_tier_slug,omitempty"` }
RegistryCreateRequest represents a request to create a registry.
type RegistryDockerCredentialsRequest ¶ added in v1.67.0
type RegistryDockerCredentialsRequest struct { ReadWrite bool `json:"read_write"` ExpirySeconds *int `json:"expiry_seconds,omitempty"` }
RegistryDockerCredentialsRequest represents a request to retrieve docker credentials for a registry.
type RegistryOptions ¶ added in v1.67.0
type RegistryOptions struct {
SubscriptionTiers []*RegistrySubscriptionTier `json:"subscription_tiers,omitempty"`
}
RegistryOptions are options for users when creating or updating a registry.
type RegistryService ¶ added in v1.67.0
type RegistryService interface { Create(context.Context, *RegistryCreateRequest) (*Registry, *Response, error) Get(context.Context) (*Registry, *Response, error) Delete(context.Context) (*Response, error) DockerCredentials(context.Context, *RegistryDockerCredentialsRequest) (*DockerCredentials, *Response, error) ListRepositories(context.Context, string, *ListOptions) ([]*Repository, *Response, error) ListRepositoryTags(context.Context, string, string, *ListOptions) ([]*RepositoryTag, *Response, error) DeleteTag(context.Context, string, string, string) (*Response, error) DeleteManifest(context.Context, string, string, string) (*Response, error) StartGarbageCollection(context.Context, string, ...*StartGarbageCollectionRequest) (*GarbageCollection, *Response, error) GetGarbageCollection(context.Context, string) (*GarbageCollection, *Response, error) ListGarbageCollections(context.Context, string, *ListOptions) ([]*GarbageCollection, *Response, error) UpdateGarbageCollection(context.Context, string, string, *UpdateGarbageCollectionRequest) (*GarbageCollection, *Response, error) GetOptions(context.Context) (*RegistryOptions, *Response, error) GetSubscription(context.Context) (*RegistrySubscription, *Response, error) UpdateSubscription(context.Context, *RegistrySubscriptionUpdateRequest) (*RegistrySubscription, *Response, error) }
RegistryService is an interface for interfacing with the Registry endpoints of the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Container-Registry
type RegistryServiceOp ¶ added in v1.67.0
type RegistryServiceOp struct {
// contains filtered or unexported fields
}
RegistryServiceOp handles communication with Registry methods of the DigitalOcean API.
func (*RegistryServiceOp) Create ¶ added in v1.67.0
func (svc *RegistryServiceOp) Create(ctx context.Context, create *RegistryCreateRequest) (*Registry, *Response, error)
Create creates a registry.
func (*RegistryServiceOp) Delete ¶ added in v1.67.0
func (svc *RegistryServiceOp) Delete(ctx context.Context) (*Response, error)
Delete deletes a registry. There is no way to recover a registry once it has been destroyed.
func (*RegistryServiceOp) DeleteManifest ¶ added in v1.67.0
func (svc *RegistryServiceOp) DeleteManifest(ctx context.Context, registry, repository, digest string) (*Response, error)
DeleteManifest deletes a manifest by its digest within a given repository.
func (*RegistryServiceOp) DeleteTag ¶ added in v1.67.0
func (svc *RegistryServiceOp) DeleteTag(ctx context.Context, registry, repository, tag string) (*Response, error)
DeleteTag deletes a tag within a given repository.
func (*RegistryServiceOp) DockerCredentials ¶ added in v1.67.0
func (svc *RegistryServiceOp) DockerCredentials(ctx context.Context, request *RegistryDockerCredentialsRequest) (*DockerCredentials, *Response, error)
DockerCredentials retrieves a Docker config file containing the registry's credentials.
func (*RegistryServiceOp) GetGarbageCollection ¶ added in v1.67.0
func (svc *RegistryServiceOp) GetGarbageCollection(ctx context.Context, registry string) (*GarbageCollection, *Response, error)
GetGarbageCollection retrieves the currently-active garbage collection for the specified registry; if there are no active garbage collections, then return a 404/NotFound error. There can only be one active garbage collection on a registry.
func (*RegistryServiceOp) GetOptions ¶ added in v1.67.0
func (svc *RegistryServiceOp) GetOptions(ctx context.Context) (*RegistryOptions, *Response, error)
GetOptions returns options the user can use when creating or updating a registry.
func (*RegistryServiceOp) GetSubscription ¶ added in v1.67.0
func (svc *RegistryServiceOp) GetSubscription(ctx context.Context) (*RegistrySubscription, *Response, error)
GetSubscription retrieves the user's subscription.
func (*RegistryServiceOp) ListGarbageCollections ¶ added in v1.67.0
func (svc *RegistryServiceOp) ListGarbageCollections(ctx context.Context, registry string, opts *ListOptions) ([]*GarbageCollection, *Response, error)
ListGarbageCollections retrieves all garbage collections (active and inactive) for the specified registry.
func (*RegistryServiceOp) ListRepositories ¶ added in v1.67.0
func (svc *RegistryServiceOp) ListRepositories(ctx context.Context, registry string, opts *ListOptions) ([]*Repository, *Response, error)
ListRepositories returns a list of the Repositories visible with the registry's credentials.
func (*RegistryServiceOp) ListRepositoryTags ¶ added in v1.67.0
func (svc *RegistryServiceOp) ListRepositoryTags(ctx context.Context, registry, repository string, opts *ListOptions) ([]*RepositoryTag, *Response, error)
ListRepositoryTags returns a list of the RepositoryTags available within the given repository.
func (*RegistryServiceOp) StartGarbageCollection ¶ added in v1.67.0
func (svc *RegistryServiceOp) StartGarbageCollection(ctx context.Context, registry string, request ...*StartGarbageCollectionRequest) (*GarbageCollection, *Response, error)
StartGarbageCollection requests a garbage collection for the specified registry.
func (*RegistryServiceOp) UpdateGarbageCollection ¶ added in v1.67.0
func (svc *RegistryServiceOp) UpdateGarbageCollection(ctx context.Context, registry, gcUUID string, request *UpdateGarbageCollectionRequest) (*GarbageCollection, *Response, error)
UpdateGarbageCollection updates the specified garbage collection for the specified registry. While only the currently-active garbage collection can be updated we still require the exact garbage collection to be specified to avoid race conditions that might may arise from issuing an update to the implicit "currently-active" garbage collection. Returns the updated garbage collection.
func (*RegistryServiceOp) UpdateSubscription ¶ added in v1.67.0
func (svc *RegistryServiceOp) UpdateSubscription(ctx context.Context, request *RegistrySubscriptionUpdateRequest) (*RegistrySubscription, *Response, error)
UpdateSubscription updates the user's registry subscription.
type RegistrySubscription ¶ added in v1.67.0
type RegistrySubscription struct { Tier *RegistrySubscriptionTier `json:"tier"` CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` }
RegistrySubscription is a user's subscription.
type RegistrySubscriptionTier ¶ added in v1.67.0
type RegistrySubscriptionTier struct { Name string `json:"name"` Slug string `json:"slug"` IncludedRepositories uint64 `json:"included_repositories"` IncludedStorageBytes uint64 `json:"included_storage_bytes"` AllowStorageOverage bool `json:"allow_storage_overage"` IncludedBandwidthBytes uint64 `json:"included_bandwidth_bytes"` MonthlyPriceInCents uint64 `json:"monthly_price_in_cents"` Eligible bool `json:"eligible,omitempty"` // EligibilityReaons is included when Eligible is false, and indicates the // reasons why this tier is not availble to the user. EligibilityReasons []string `json:"eligibility_reasons,omitempty"` }
RegistrySubscriptionTier is a subscription tier for container registry.
type RegistrySubscriptionUpdateRequest ¶ added in v1.67.0
type RegistrySubscriptionUpdateRequest struct {
TierSlug string `json:"tier_slug"`
}
RegistrySubscriptionUpdateRequest represents a request to update the subscription plan for a registry.
type Repository ¶ added in v1.67.0
type Repository struct { RegistryName string `json:"registry_name,omitempty"` Name string `json:"name,omitempty"` LatestTag *RepositoryTag `json:"latest_tag,omitempty"` TagCount uint64 `json:"tag_count,omitempty"` }
Repository represents a repository
type RepositoryTag ¶ added in v1.67.0
type RepositoryTag struct { RegistryName string `json:"registry_name,omitempty"` Repository string `json:"repository,omitempty"` Tag string `json:"tag,omitempty"` ManifestDigest string `json:"manifest_digest,omitempty"` CompressedSizeBytes uint64 `json:"compressed_size_bytes,omitempty"` SizeBytes uint64 `json:"size_bytes,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` }
RepositoryTag represents a repository tag
type RequestCompletionCallback ¶ added in v0.9.0
RequestCompletionCallback defines the type of the request callback function
type Resource ¶ added in v1.0.0
type Resource struct { ID string `json:"resource_id,omitempty"` Type ResourceType `json:"resource_type,omitempty"` }
Resource represent a single resource for associating/disassociating with tags
type ResourceType ¶ added in v1.0.0
type ResourceType string
ResourceType represents a class of resource, currently only droplet are supported
const ( // DropletResourceType holds the string representing our ResourceType of Droplet. DropletResourceType ResourceType = "droplet" // ImageResourceType holds the string representing our ResourceType of Image. ImageResourceType ResourceType = "image" // VolumeResourceType holds the string representing our ResourceType of Volume. VolumeResourceType ResourceType = "volume" // LoadBalancerResourceType holds the string representing our ResourceType of LoadBalancer. LoadBalancerResourceType ResourceType = "load_balancer" // VolumeSnapshotResourceType holds the string representing our ResourceType for storage Snapshots. VolumeSnapshotResourceType ResourceType = "volume_snapshot" // DatabaseResourceType holds the string representing our ResourceType of Database. DatabaseResourceType ResourceType = "database" )
type ResourceWithURN ¶ added in v1.6.0
type ResourceWithURN interface {
URN() string
}
ResourceWithURN is an interface for interfacing with the types that implement the URN method.
type Response ¶
type Response struct { *http.Response // Links that were returned with the response. These are parsed from // request body and not the header. Links *Links // Meta describes generic information about the response. Meta *Meta // Monitoring URI // Deprecated: This field is not populated. To poll for the status of a // newly created Droplet, use Links.Actions[0].HREF Monitor string Rate }
Response is a DigitalOcean response. This wraps the standard http.Response returned from DigitalOcean.
type Size ¶
type Size struct { Slug string `json:"slug,omitempty"` Memory int `json:"memory,omitempty"` Vcpus int `json:"vcpus,omitempty"` Disk int `json:"disk,omitempty"` PriceMonthly float64 `json:"price_monthly,omitempty"` PriceHourly float64 `json:"price_hourly,omitempty"` Regions []string `json:"regions,omitempty"` Available bool `json:"available,omitempty"` Transfer float64 `json:"transfer,omitempty"` Description string `json:"description,omitempty"` }
Size represents a DigitalOcean Size
type SizesService ¶
SizesService is an interface for interfacing with the size endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Sizes
type SizesServiceOp ¶ added in v0.3.0
type SizesServiceOp struct {
// contains filtered or unexported fields
}
SizesServiceOp handles communication with the size related methods of the DigitalOcean API.
func (*SizesServiceOp) List ¶ added in v0.3.0
func (s *SizesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Size, *Response, error)
List all images
type SlackDetails ¶ added in v1.67.0
SlackDetails represents the details required to send a slack alert
type Snapshot ¶ added in v1.0.0
type Snapshot struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` ResourceID string `json:"resource_id,omitempty"` ResourceType string `json:"resource_type,omitempty"` Regions []string `json:"regions,omitempty"` MinDiskSize int `json:"min_disk_size,omitempty"` SizeGigaBytes float64 `json:"size_gigabytes,omitempty"` Created string `json:"created_at,omitempty"` Tags []string `json:"tags,omitempty"` }
Snapshot represents a DigitalOcean Snapshot
type SnapshotCreateRequest ¶ added in v1.0.0
type SnapshotCreateRequest struct { VolumeID string `json:"volume_id"` Name string `json:"name"` Description string `json:"description"` Tags []string `json:"tags"` }
SnapshotCreateRequest represents a request to create a block store volume.
type SnapshotsService ¶ added in v1.0.0
type SnapshotsService interface { List(context.Context, *ListOptions) ([]Snapshot, *Response, error) ListVolume(context.Context, *ListOptions) ([]Snapshot, *Response, error) ListDroplet(context.Context, *ListOptions) ([]Snapshot, *Response, error) Get(context.Context, string) (*Snapshot, *Response, error) Delete(context.Context, string) (*Response, error) }
SnapshotsService is an interface for interfacing with the snapshots endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Snapshots
type SnapshotsServiceOp ¶ added in v1.0.0
type SnapshotsServiceOp struct {
// contains filtered or unexported fields
}
SnapshotsServiceOp handles communication with the snapshot related methods of the DigitalOcean API.
func (*SnapshotsServiceOp) Get ¶ added in v1.0.0
func (s *SnapshotsServiceOp) Get(ctx context.Context, snapshotID string) (*Snapshot, *Response, error)
Get retrieves an snapshot by id.
func (*SnapshotsServiceOp) List ¶ added in v1.0.0
func (s *SnapshotsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
List lists all the snapshots available.
func (*SnapshotsServiceOp) ListDroplet ¶ added in v1.0.0
func (s *SnapshotsServiceOp) ListDroplet(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
ListDroplet lists all the Droplet snapshots.
func (*SnapshotsServiceOp) ListVolume ¶ added in v1.0.0
func (s *SnapshotsServiceOp) ListVolume(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
ListVolume lists all the volume snapshots.
type Sources ¶ added in v1.1.0
type Sources struct { Addresses []string `json:"addresses,omitempty"` Tags []string `json:"tags,omitempty"` DropletIDs []int `json:"droplet_ids,omitempty"` LoadBalancerUIDs []string `json:"load_balancer_uids,omitempty"` KubernetesIDs []string `json:"kubernetes_ids,omitempty"` }
Sources represents a DigitalOcean Firewall InboundRule sources.
type StartGarbageCollectionRequest ¶ added in v1.67.0
type StartGarbageCollectionRequest struct {
Type GarbageCollectionType `json:"type"`
}
StartGarbageCollectionRequest represents options to a garbage collection start request.
type StickySessions ¶ added in v1.0.0
type StickySessions struct { Type string `json:"type,omitempty"` CookieName string `json:"cookie_name,omitempty"` CookieTtlSeconds int `json:"cookie_ttl_seconds,omitempty"` }
StickySessions represents optional load balancer session affinity rules.
func (StickySessions) String ¶ added in v1.0.0
func (s StickySessions) String() string
String creates a human-readable description of a StickySessions instance.
type StorageActionsService ¶ added in v1.0.0
type StorageActionsService interface { Attach(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error) DetachByDropletID(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error) Get(ctx context.Context, volumeID string, actionID int) (*Action, *Response, error) List(ctx context.Context, volumeID string, opt *ListOptions) ([]Action, *Response, error) Resize(ctx context.Context, volumeID string, sizeGigabytes int, regionSlug string) (*Action, *Response, error) }
StorageActionsService is an interface for interfacing with the storage actions endpoints of the Digital Ocean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Block-Storage-Actions
type StorageActionsServiceOp ¶ added in v1.0.0
type StorageActionsServiceOp struct {
// contains filtered or unexported fields
}
StorageActionsServiceOp handles communication with the storage volumes action related methods of the DigitalOcean API.
func (*StorageActionsServiceOp) Attach ¶ added in v1.0.0
func (s *StorageActionsServiceOp) Attach(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error)
Attach a storage volume to a Droplet.
func (*StorageActionsServiceOp) DetachByDropletID ¶ added in v1.0.0
func (s *StorageActionsServiceOp) DetachByDropletID(ctx context.Context, volumeID string, dropletID int) (*Action, *Response, error)
DetachByDropletID a storage volume from a Droplet by Droplet ID.
func (*StorageActionsServiceOp) Get ¶ added in v1.0.0
func (s *StorageActionsServiceOp) Get(ctx context.Context, volumeID string, actionID int) (*Action, *Response, error)
Get an action for a particular storage volume by id.
func (*StorageActionsServiceOp) List ¶ added in v1.0.0
func (s *StorageActionsServiceOp) List(ctx context.Context, volumeID string, opt *ListOptions) ([]Action, *Response, error)
List the actions for a particular storage volume.
type StorageAttachment ¶ added in v1.0.0
type StorageAttachment struct {
DropletID int `json:"droplet_id"`
}
StorageAttachment represents the attachement of a block storage volume to a specific Droplet under the device name.
type StorageService ¶ added in v1.0.0
type StorageService interface { ListVolumes(context.Context, *ListVolumeParams) ([]Volume, *Response, error) GetVolume(context.Context, string) (*Volume, *Response, error) CreateVolume(context.Context, *VolumeCreateRequest) (*Volume, *Response, error) DeleteVolume(context.Context, string) (*Response, error) ListSnapshots(ctx context.Context, volumeID string, opts *ListOptions) ([]Snapshot, *Response, error) GetSnapshot(context.Context, string) (*Snapshot, *Response, error) CreateSnapshot(context.Context, *SnapshotCreateRequest) (*Snapshot, *Response, error) DeleteSnapshot(context.Context, string) (*Response, error) }
StorageService is an interface for interfacing with the storage endpoints of the Digital Ocean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Block-Storage
type StorageServiceOp ¶ added in v1.0.0
type StorageServiceOp struct {
// contains filtered or unexported fields
}
StorageServiceOp handles communication with the storage volumes related methods of the DigitalOcean API.
func (*StorageServiceOp) CreateSnapshot ¶ added in v1.0.0
func (svc *StorageServiceOp) CreateSnapshot(ctx context.Context, createRequest *SnapshotCreateRequest) (*Snapshot, *Response, error)
CreateSnapshot creates a snapshot of a storage volume.
func (*StorageServiceOp) CreateVolume ¶ added in v1.0.0
func (svc *StorageServiceOp) CreateVolume(ctx context.Context, createRequest *VolumeCreateRequest) (*Volume, *Response, error)
CreateVolume creates a storage volume. The name must be unique.
func (*StorageServiceOp) DeleteSnapshot ¶ added in v1.0.0
DeleteSnapshot deletes a snapshot.
func (*StorageServiceOp) DeleteVolume ¶ added in v1.0.0
DeleteVolume deletes a storage volume.
func (*StorageServiceOp) GetSnapshot ¶ added in v1.0.0
func (svc *StorageServiceOp) GetSnapshot(ctx context.Context, id string) (*Snapshot, *Response, error)
GetSnapshot retrieves an individual snapshot.
func (*StorageServiceOp) GetVolume ¶ added in v1.0.0
GetVolume retrieves an individual storage volume.
func (*StorageServiceOp) ListSnapshots ¶ added in v1.0.0
func (svc *StorageServiceOp) ListSnapshots(ctx context.Context, volumeID string, opt *ListOptions) ([]Snapshot, *Response, error)
ListSnapshots lists all snapshots related to a storage volume.
func (*StorageServiceOp) ListVolumes ¶ added in v1.0.0
func (svc *StorageServiceOp) ListVolumes(ctx context.Context, params *ListVolumeParams) ([]Volume, *Response, error)
ListVolumes lists all storage volumes.
type Tag ¶ added in v1.0.0
type Tag struct { Name string `json:"name,omitempty"` Resources *TaggedResources `json:"resources,omitempty"` }
Tag represent DigitalOcean tag
type TagCreateRequest ¶ added in v1.0.0
type TagCreateRequest struct {
Name string `json:"name"`
}
TagCreateRequest represents the JSON structure of a request of that type.
type TagResourcesRequest ¶ added in v1.0.0
type TagResourcesRequest struct {
Resources []Resource `json:"resources"`
}
TagResourcesRequest represents the JSON structure of a request of that type.
type TaggedDatabasesResources ¶ added in v1.67.0
type TaggedDatabasesResources TaggedResourcesData
TaggedDatabasesResources represent the database resources a tag is attached to
type TaggedDropletsResources ¶ added in v1.0.0
type TaggedDropletsResources struct { Count int `json:"count,float64,omitempty"` LastTagged *Droplet `json:"last_tagged,omitempty"` LastTaggedURI string `json:"last_tagged_uri,omitempty"` }
TaggedDropletsResources represent the droplet resources a tag is attached to
type TaggedImagesResources ¶ added in v1.5.0
type TaggedImagesResources TaggedResourcesData
TaggedImagesResources represent the image resources a tag is attached to
type TaggedResources ¶ added in v1.0.0
type TaggedResources struct { Count int `json:"count"` LastTaggedURI string `json:"last_tagged_uri,omitempty"` Droplets *TaggedDropletsResources `json:"droplets,omitempty"` Images *TaggedImagesResources `json:"images"` Volumes *TaggedVolumesResources `json:"volumes"` VolumeSnapshots *TaggedVolumeSnapshotsResources `json:"volume_snapshots"` Databases *TaggedDatabasesResources `json:"databases"` }
TaggedResources represent the set of resources a tag is attached to
type TaggedResourcesData ¶ added in v1.7.5
type TaggedResourcesData struct { Count int `json:"count,float64,omitempty"` LastTaggedURI string `json:"last_tagged_uri,omitempty"` }
TaggedResourcesData represent the generic resources a tag is attached to
type TaggedVolumeSnapshotsResources ¶ added in v1.67.0
type TaggedVolumeSnapshotsResources TaggedResourcesData
TaggedVolumeSnapshotsResources represent the volume snapshot resources a tag is attached to
type TaggedVolumesResources ¶ added in v1.7.5
type TaggedVolumesResources TaggedResourcesData
TaggedVolumesResources represent the volume resources a tag is attached to
type TagsService ¶ added in v1.0.0
type TagsService interface { List(context.Context, *ListOptions) ([]Tag, *Response, error) Get(context.Context, string) (*Tag, *Response, error) Create(context.Context, *TagCreateRequest) (*Tag, *Response, error) Delete(context.Context, string) (*Response, error) TagResources(context.Context, string, *TagResourcesRequest) (*Response, error) UntagResources(context.Context, string, *UntagResourcesRequest) (*Response, error) }
TagsService is an interface for interfacing with the tags endpoints of the DigitalOcean API See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Tags
type TagsServiceOp ¶ added in v1.0.0
type TagsServiceOp struct {
// contains filtered or unexported fields
}
TagsServiceOp handles communication with tag related method of the DigitalOcean API.
func (*TagsServiceOp) Create ¶ added in v1.0.0
func (s *TagsServiceOp) Create(ctx context.Context, createRequest *TagCreateRequest) (*Tag, *Response, error)
Create a new tag
func (*TagsServiceOp) List ¶ added in v1.0.0
func (s *TagsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Tag, *Response, error)
List all tags
func (*TagsServiceOp) TagResources ¶ added in v1.0.0
func (s *TagsServiceOp) TagResources(ctx context.Context, name string, tagRequest *TagResourcesRequest) (*Response, error)
TagResources associates resources with a given Tag.
func (*TagsServiceOp) UntagResources ¶ added in v1.0.0
func (s *TagsServiceOp) UntagResources(ctx context.Context, name string, untagRequest *UntagResourcesRequest) (*Response, error)
UntagResources dissociates resources with a given Tag.
type Taint ¶ added in v1.67.0
Taint represents a Kubernetes taint that can be associated with a node pool (and, transitively, with all nodes of that pool).
type Timestamp ¶
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp. All exported methods of time.Time can be called on Timestamp.
func (*Timestamp) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface. Time is expected in RFC3339 or Unix format.
type UntagResourcesRequest ¶ added in v1.0.0
type UntagResourcesRequest struct {
Resources []Resource `json:"resources"`
}
UntagResourcesRequest represents the JSON structure of a request of that type.
type UpdateGarbageCollectionRequest ¶ added in v1.67.0
type UpdateGarbageCollectionRequest struct {
Cancel bool `json:"cancel"`
}
UpdateGarbageCollectionRequest represents a request to update a garbage collection.
type UpdateProjectRequest ¶ added in v1.6.0
type UpdateProjectRequest struct { Name interface{} Description interface{} Purpose interface{} Environment interface{} IsDefault interface{} }
UpdateProjectRequest represents the request to update project information. This type expects certain attribute types, but is built this way to allow nil values as well. See `updateProjectRequest` for the "real" types.
func (*UpdateProjectRequest) MarshalJSON ¶ added in v1.6.0
func (upr *UpdateProjectRequest) MarshalJSON() ([]byte, error)
MarshalJSON takes an UpdateRequest and converts it to the "typed" request which is sent to the projects API. This is a PATCH request, which allows partial attributes, so `null` values are OK.
type VPC ¶ added in v1.11.0
type VPC struct { ID string `json:"id,omitempty"` URN string `json:"urn"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` IPRange string `json:"ip_range,omitempty"` RegionSlug string `json:"region,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` Default bool `json:"default,omitempty"` }
VPC represents a DigitalOcean Virtual Private Cloud configuration.
type VPCCreateRequest ¶ added in v1.11.0
type VPCCreateRequest struct { Name string `json:"name,omitempty"` RegionSlug string `json:"region,omitempty"` Description string `json:"description,omitempty"` IPRange string `json:"ip_range,omitempty"` }
VPCCreateRequest represents a request to create a Virtual Private Cloud.
type VPCListMembersRequest ¶ added in v1.67.0
type VPCListMembersRequest struct {
ResourceType string `url:"resource_type,omitempty"`
}
type VPCSetDescription ¶ added in v1.67.0
type VPCSetDescription string
VPCSetDescription is used when one want to set the `description` field of a VPC. Ex.: VPCs.Set(..., VPCSetDescription("vpc description"))
type VPCSetField ¶ added in v1.11.0
type VPCSetField interface {
// contains filtered or unexported methods
}
VPCSetField allows one to set individual fields within a VPC configuration.
func VPCSetDefault ¶ added in v1.67.0
func VPCSetDefault() VPCSetField
VPCSetDefault is used when one wants to enable the `default` field of a VPC, to set a VPC as the default one in the region Ex.: VPCs.Set(..., VPCSetDefault())
type VPCSetName ¶ added in v1.11.0
type VPCSetName string
VPCSetName is used when one want to set the `name` field of a VPC. Ex.: VPCs.Set(..., VPCSetName("new-name"))
type VPCUpdateRequest ¶ added in v1.11.0
type VPCUpdateRequest struct { Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Default *bool `json:"default,omitempty"` }
VPCUpdateRequest represents a request to update a Virtual Private Cloud.
type VPCsService ¶ added in v1.11.0
type VPCsService interface { Create(context.Context, *VPCCreateRequest) (*VPC, *Response, error) Get(context.Context, string) (*VPC, *Response, error) List(context.Context, *ListOptions) ([]*VPC, *Response, error) ListMembers(context.Context, string, *VPCListMembersRequest, *ListOptions) ([]*VPCMember, *Response, error) Update(context.Context, string, *VPCUpdateRequest) (*VPC, *Response, error) Set(context.Context, string, ...VPCSetField) (*VPC, *Response, error) Delete(context.Context, string) (*Response, error) }
VPCsService is an interface for managing Virtual Private Cloud configurations with the DigitalOcean API. See: https://docs.digitalocean.com/reference/api/api-reference/#tag/VPCs
type VPCsServiceOp ¶ added in v1.11.0
type VPCsServiceOp struct {
// contains filtered or unexported fields
}
VPCsServiceOp interfaces with VPC endpoints in the DigitalOcean API.
func (*VPCsServiceOp) Create ¶ added in v1.11.0
func (v *VPCsServiceOp) Create(ctx context.Context, create *VPCCreateRequest) (*VPC, *Response, error)
Create creates a new Virtual Private Cloud.
func (*VPCsServiceOp) Delete ¶ added in v1.11.0
Delete deletes a Virtual Private Cloud. There is no way to recover a VPC once it has been destroyed.
func (*VPCsServiceOp) List ¶ added in v1.11.0
func (v *VPCsServiceOp) List(ctx context.Context, opt *ListOptions) ([]*VPC, *Response, error)
List returns a list of the caller's VPCs, with optional pagination.
func (*VPCsServiceOp) ListMembers ¶ added in v1.67.0
func (v *VPCsServiceOp) ListMembers(ctx context.Context, id string, request *VPCListMembersRequest, opt *ListOptions) ([]*VPCMember, *Response, error)
func (*VPCsServiceOp) Set ¶ added in v1.11.0
func (v *VPCsServiceOp) Set(ctx context.Context, id string, fields ...VPCSetField) (*VPC, *Response, error)
Set updates specific properties of a Virtual Private Cloud.
func (*VPCsServiceOp) Update ¶ added in v1.11.0
func (v *VPCsServiceOp) Update(ctx context.Context, id string, update *VPCUpdateRequest) (*VPC, *Response, error)
Update updates a Virtual Private Cloud's properties.
type Volume ¶ added in v1.0.0
type Volume struct { ID string `json:"id"` Region *Region `json:"region"` Name string `json:"name"` SizeGigaBytes int64 `json:"size_gigabytes"` Description string `json:"description"` DropletIDs []int `json:"droplet_ids"` CreatedAt time.Time `json:"created_at"` FilesystemType string `json:"filesystem_type"` FilesystemLabel string `json:"filesystem_label"` Tags []string `json:"tags"` }
Volume represents a Digital Ocean block store volume.
type VolumeCreateRequest ¶ added in v1.0.0
type VolumeCreateRequest struct { Region string `json:"region"` Name string `json:"name"` Description string `json:"description"` SizeGigaBytes int64 `json:"size_gigabytes"` SnapshotID string `json:"snapshot_id"` FilesystemType string `json:"filesystem_type"` FilesystemLabel string `json:"filesystem_label"` Tags []string `json:"tags"` }
VolumeCreateRequest represents a request to create a block store volume.
Source Files
¶
- 1-click.go
- account.go
- action.go
- apps.gen.go
- apps.go
- balance.go
- billing_history.go
- cdn.go
- certificates.go
- databases.go
- doc.go
- domains.go
- droplet_actions.go
- droplets.go
- errors.go
- firewalls.go
- floating_ips.go
- floating_ips_actions.go
- godo.go
- image_actions.go
- images.go
- invoices.go
- keys.go
- kubernetes.go
- links.go
- load_balancers.go
- meta.go
- monitoring.go
- projects.go
- regions.go
- registry.go
- sizes.go
- snapshots.go
- storage.go
- storage_actions.go
- strings.go
- tags.go
- timestamp.go
- vpcs.go