cherrygo

package module

Go to main page

Versions in this module

v3

v3.2.0

Apr 23, 2024

Changes in this version

+ type BMC struct

+ Password string

+ User string

type ReinstallServerFields

+ UserData string

type Server

+ BMC BMC

+ Password string

+ Username string

type ServersClient

+ func (s *ServersClient) ResetBMCPassword(serverID int) (Server, *Response, error)

type ServersService

+ ResetBMCPassword func(serverID int) (Server, *Response, error)

v3.1.0

Oct 18, 2022

Changes in this version

+ type BackupMethod struct

+ Enabled bool

+ Host string

+ Name string

+ Password string

+ Port int

+ Processing bool

+ SSHKey string

+ Username string

+ WhiteList []string

+ type BackupStorage struct

+ AttachedTo AttachedTo

+ AvailableIPAddresses []IPAddress

+ Href string

+ ID int

+ Methods []BackupMethod

+ Plan Plan

+ Pricing Pricing

+ PrivateIP string

+ PublicIP string

+ Region Region

+ Rules []Rule

+ SizeGigabytes int

+ State string

+ Status string

+ UsedGigabytes int

+ type BackupStoragePlan struct

+ Href string

+ ID int

+ Name string

+ Pricing []Pricing

+ Regions []Region

+ SizeGigabytes int

+ Slug string

+ type BackupsClient struct

+ func (s *BackupsClient) Create(request *CreateBackup) (BackupStorage, *Response, error)

+ func (s *BackupsClient) Delete(backupID int) (*Response, error)

+ func (s *BackupsClient) Get(backupID int, opts *GetOptions) (BackupStorage, *Response, error)

+ func (s *BackupsClient) ListBackups(projectID int, opts *GetOptions) ([]BackupStorage, *Response, error)

+ func (s *BackupsClient) ListPlans(opts *GetOptions) ([]BackupStoragePlan, *Response, error)

+ func (s *BackupsClient) Update(request *UpdateBackupStorage) (BackupStorage, *Response, error)

+ func (s *BackupsClient) UpdateBackupMethod(request *UpdateBackupMethod) ([]BackupMethod, *Response, error)

+ type BackupsService interface

+ Create func(request *CreateBackup) (BackupStorage, *Response, error)

+ Delete func(backupID int) (*Response, error)

+ Get func(backupID int, opts *GetOptions) (BackupStorage, *Response, error)

+ ListBackups func(projectID int, opts *GetOptions) ([]BackupStorage, *Response, error)

+ ListPlans func(opts *GetOptions) ([]BackupStoragePlan, *Response, error)

+ Update func(request *UpdateBackupStorage) (BackupStorage, *Response, error)

+ UpdateBackupMethod func(request *UpdateBackupMethod) ([]BackupMethod, *Response, error)

type Client

+ Backups BackupsService

+ type CreateBackup struct

+ BackupPlanSlug string

+ RegionSlug string

+ SSHKey string

+ ServerID int

+ type EnabledMethods struct

+ BORG bool

+ FTP bool

+ NFS bool

+ SMB bool

+ type Rule struct

+ EnabledMethods EnabledMethods

+ IPAddress IPAddress

type Server

+ Backup BackupStorage

+ type UpdateBackupMethod struct

+ BackupMethodName string

+ BackupStorageID int

+ Enabled bool

+ Whitelist []string

+ type UpdateBackupStorage struct

+ BackupPlanSlug string

+ BackupStorageID int

+ Password string

+ SSHKey string

v3.0.1

Sep 22, 2022

Changes in this version

+ type Membership struct

+ Href string

+ ID int

+ Projects []Project

+ Roles []string

+ User User

type Plan

+ Type string

type Region

+ Location string

+ type RemainingTime struct

+ Time int

+ Unit string

type Resources

+ Remaining RemainingTime

type Team

+ Memberships []Membership

+ Projects []Project

v3.0.0

Aug 9, 2022

Changes in this version

+ type AssignIPAddress struct

+ IpID string

+ ServerID int

+ type AssignedTo struct

+ Hostname string

+ Href string

+ ID int

+ Image string

+ Name string

+ Pricing Pricing

+ Region Region

+ State string

+ type AttachTo struct

+ AttachTo int

+ StorageID int

+ type AttachedTo struct

+ Hostname string

+ Href string

+ ID int

+ type AvailableRegions struct

+ SpotQty int

+ StockQty int

+ type BGPRoute struct

+ Active bool

+ Age string

+ Router string

+ Subnet string

+ Updated string

+ type Bandwidth struct

+ Name string

+ type Billing struct

+ Address1 string

+ Address2 string

+ City string

+ CompanyCode string

+ CompanyName string

+ CountryIso2 string

+ Currency string

+ FirstName string

+ LastName string

+ Type string

+ Vat Vat

+ type BlockStorage struct

+ AllowEditSize bool

+ AttachedTo AttachedTo

+ Description string

+ DiscoveryIP string

+ Href string

+ ID int

+ Initiator string

+ Name string

+ Region Region

+ Size int

+ Unit string

+ VlanID string

+ VlanIP string

+ type Client struct

+ AuthToken string

+ BaseURL *url.URL

+ IPAddresses IpAddressesService

+ Images ImagesService

+ Plans PlansService

+ Projects ProjectsService

+ Regions RegionsService

+ SSHKeys SSHKeysService

+ Servers ServersService

+ Storages StoragesService

+ Teams TeamsService

+ UserAgent string

+ Users UsersService

+ func NewClient(opts ...ClientOpt) (*Client, error)

+ func (c *Client) MakeRequest(method, path string, body, v interface{}) (*Response, error)

+ type ClientOpt func(*options) error

+ func WithAuthToken(authToken string) ClientOpt

+ func WithHTTPClient(client *http.Client) ClientOpt

+ func WithURL(url string) ClientOpt

+ func WithUserAgent(ua string) ClientOpt

+ type Cpus struct

+ Cores int

+ Count int

+ Frequency float32

+ Name string

+ Unit string

+ type CreateIPAddress struct

+ ARecord string

+ AssignedTo string

+ DDoSScrubbing bool

+ PtrRecord string

+ Region string

+ RoutedTo string

+ Tags *map[string]string

+ TargetedTo string

+ type CreateProject struct

+ Bgp bool

+ Name string

+ type CreateSSHKey struct

+ Key string

+ Label string

+ type CreateServer struct

+ Hostname string

+ IPAddresses []string

+ Image string

+ OSPartitionSize int

+ Plan string

+ ProjectID int

+ Region string

+ SSHKeys []string

+ SpotInstance bool

+ Tags *map[string]string

+ UserData string

+ type CreateStorage struct

+ Description string

+ ProjectID int

+ Region string

+ Size int

+ type CreateTeam struct

+ Currency string

+ Name string

+ Type string

+ type Credit struct

+ Account CreditDetails

+ Promo CreditDetails

+ Resources Resources

+ type CreditDetails struct

+ Currency string

+ Remaining float32

+ Usage float32

+ type ErrorResponse struct

+ Errors []string

+ Response *http.Response

+ SingleError string

+ type GetOptions struct

+ Fields []string

+ Limit int

+ Offset int

+ QueryParams map[string]string

+ Status []string

+ Type []string

+ func (g *GetOptions) Encode() string

+ func (g *GetOptions) WithQuery(apiPath string) string

+ type IPAddress struct

+ ARecord string

+ Address string

+ AddressFamily int

+ AssignedTo AssignedTo

+ Cidr string

+ DDoSScrubbing bool

+ Gateway string

+ Href string

+ ID string

+ Project Project

+ PtrRecord string

+ Region Region

+ RoutedTo RoutedTo

+ Tags *map[string]string

+ TargetedTo AssignedTo

+ Type string

+ type IPsClient struct

+ func (i *IPsClient) Assign(ipID string, request *AssignIPAddress) (IPAddress, *Response, error)

+ func (i *IPsClient) Create(projectID int, request *CreateIPAddress) (IPAddress, *Response, error)

+ func (i *IPsClient) Get(ipID string, opts *GetOptions) (IPAddress, *Response, error)

+ func (i *IPsClient) List(projectID int, opts *GetOptions) ([]IPAddress, *Response, error)

+ func (i *IPsClient) Remove(ipID string) (*Response, error)

+ func (i *IPsClient) Unassign(ipID string) (*Response, error)

+ func (i *IPsClient) Update(ipID string, request *UpdateIPAddress) (IPAddress, *Response, error)

+ type Image struct

+ ID int

+ Name string

+ Pricing []Pricing

+ Slug string

+ type ImagesClient struct

+ func (i *ImagesClient) List(plan string, opts *GetOptions) ([]Image, *Response, error)

+ type ImagesService interface

+ List func(plan string, opts *GetOptions) ([]Image, *Response, error)

+ type IpAddressesService interface

+ Assign func(ipID string, request *AssignIPAddress) (IPAddress, *Response, error)

+ Create func(projectID int, request *CreateIPAddress) (IPAddress, *Response, error)

+ Get func(ipID string, opts *GetOptions) (IPAddress, *Response, error)

+ List func(projectID int, opts *GetOptions) ([]IPAddress, *Response, error)

+ Remove func(ipID string) (*Response, error)

+ Unassign func(ipID string) (*Response, error)

+ Update func(ipID string, request *UpdateIPAddress) (IPAddress, *Response, error)

+ type Memory struct

+ Count int

+ Name string

+ Total int

+ Unit string

+ type Meta struct

+ Total int

+ type Nics struct

+ Name string

+ type Plan struct

+ AvailableRegions []AvailableRegions

+ Custom bool

+ ID int

+ Name string

+ Pricing []Pricing

+ Slug string

+ Specs Specs

+ type PlansClient struct

+ func (p *PlansClient) List(teamID int, opts *GetOptions) ([]Plan, *Response, error)

+ type PlansService interface

+ List func(teamID int, opts *GetOptions) ([]Plan, *Response, error)

+ type PowerState struct

+ Power string

+ type Pricing struct

+ Currency string

+ Price float32

+ Taxed bool

+ Unit string

+ type Project struct

+ Bgp ProjectBGP

+ Href string

+ ID int

+ Name string

+ type ProjectBGP struct

+ Enabled bool

+ LocalASN int

+ type ProjectsClient struct

+ func (p *ProjectsClient) Create(teamID int, request *CreateProject) (Project, *Response, error)

+ func (p *ProjectsClient) Delete(projectID int) (*Response, error)

+ func (p *ProjectsClient) Get(projectID int, opts *GetOptions) (Project, *Response, error)

+ func (p *ProjectsClient) List(teamID int, opts *GetOptions) ([]Project, *Response, error)

+ func (p *ProjectsClient) ListSSHKeys(projectID int, opts *GetOptions) ([]SSHKey, *Response, error)

+ func (p *ProjectsClient) Update(projectID int, request *UpdateProject) (Project, *Response, error)

+ type ProjectsService interface

+ Create func(teamID int, request *CreateProject) (Project, *Response, error)

+ Delete func(projectID int) (*Response, error)

+ Get func(projectID int, opts *GetOptions) (Project, *Response, error)

+ List func(teamID int, opts *GetOptions) ([]Project, *Response, error)

+ ListSSHKeys func(projectID int, opts *GetOptions) ([]SSHKey, *Response, error)

+ Update func(projectID int, request *UpdateProject) (Project, *Response, error)

+ type Raid struct

+ Name string

+ type Region struct

+ BGP RegionBGP

+ Href string

+ ID int

+ Name string

+ RegionIso2 string

+ Slug string

+ type RegionBGP struct

+ Asn int

+ Hosts []string

+ type RegionsClient struct

+ func (i *RegionsClient) Get(region string, opts *GetOptions) (Region, *Response, error)

+ func (i *RegionsClient) List(opts *GetOptions) ([]Region, *Response, error)

+ type RegionsService interface

+ Get func(region string, opts *GetOptions) (Region, *Response, error)

+ List func(opts *GetOptions) ([]Region, *Response, error)

+ type ReinstallServer struct

+ type ReinstallServerFields struct

+ Hostname string

+ Image string

+ OSPartitionSize int

+ Password string

+ SSHKeys []string

+ type Resources struct

+ Pricing Pricing

+ type Response struct

+ type RoutedTo struct

+ Address string

+ AddressFamily int

+ Cidr string

+ Gateway string

+ ID string

+ Region Region

+ Type string

+ type SSHKey struct

+ Created string

+ Fingerprint string

+ Href string

+ ID int

+ Key string

+ Label string

+ Updated string

+ User User

+ type SSHKeysClient struct

+ func (s *SSHKeysClient) Create(request *CreateSSHKey) (SSHKey, *Response, error)

+ func (s *SSHKeysClient) Delete(sshKeyID int) (SSHKey, *Response, error)

+ func (s *SSHKeysClient) Get(sshKeyID int, opts *GetOptions) (SSHKey, *Response, error)

+ func (s *SSHKeysClient) List(opts *GetOptions) ([]SSHKey, *Response, error)

+ func (s *SSHKeysClient) Update(sshKeyID int, request *UpdateSSHKey) (SSHKey, *Response, error)

+ type SSHKeysService interface

+ Create func(request *CreateSSHKey) (SSHKey, *Response, error)

+ Delete func(sshKeyID int) (SSHKey, *Response, error)

+ Get func(sshKeyID int, opts *GetOptions) (SSHKey, *Response, error)

+ List func(opts *GetOptions) ([]SSHKey, *Response, error)

+ Update func(sshKeyID int, request *UpdateSSHKey) (SSHKey, *Response, error)

+ type Server struct

+ AvailableRegions AvailableRegions

+ BGP ServerBGP

+ Created string

+ Hostname string

+ Href string

+ ID int

+ IPAddresses []IPAddress

+ Image string

+ Name string

+ Plan Plan

+ Pricing Pricing

+ Project Project

+ Region Region

+ SSHKeys []SSHKey

+ SpotInstance bool

+ State string

+ Storage BlockStorage

+ Tags map[string]string

+ TerminationDate string

+ type ServerAction struct

+ Type string

+ type ServerBGP struct

+ Active int

+ Available bool

+ Connected int

+ Enabled bool

+ Limit int

+ Routers int

+ Routes []BGPRoute

+ Status string

+ Updated string

+ type ServersClient struct

+ func (s *ServersClient) Create(request *CreateServer) (Server, *Response, error)

+ func (s *ServersClient) Delete(serverID int) (Server, *Response, error)

+ func (s *ServersClient) Get(serverID int, opts *GetOptions) (Server, *Response, error)

+ func (s *ServersClient) List(projectID int, opts *GetOptions) ([]Server, *Response, error)

+ func (s *ServersClient) ListSSHKeys(serverID int, opts *GetOptions) ([]SSHKey, *Response, error)

+ func (s *ServersClient) PowerOff(serverID int) (Server, *Response, error)

+ func (s *ServersClient) PowerOn(serverID int) (Server, *Response, error)

+ func (s *ServersClient) PowerState(serverID int) (PowerState, *Response, error)

+ func (s *ServersClient) Reboot(serverID int) (Server, *Response, error)

+ func (s *ServersClient) Reinstall(serverID int, fields *ReinstallServerFields) (Server, *Response, error)

+ func (s *ServersClient) Update(serverID int, request *UpdateServer) (Server, *Response, error)

+ type ServersService interface

+ Create func(request *CreateServer) (Server, *Response, error)

+ Delete func(serverID int) (Server, *Response, error)

+ Get func(serverID int, opts *GetOptions) (Server, *Response, error)

+ List func(projectID int, opts *GetOptions) ([]Server, *Response, error)

+ ListSSHKeys func(serverID int, opts *GetOptions) ([]SSHKey, *Response, error)

+ PowerOff func(serverID int) (Server, *Response, error)

+ PowerOn func(serverID int) (Server, *Response, error)

+ PowerState func(serverID int) (PowerState, *Response, error)

+ Reboot func(serverID int) (Server, *Response, error)

+ Reinstall func(serverID int, fields *ReinstallServerFields) (Server, *Response, error)

+ Update func(serverID int, request *UpdateServer) (Server, *Response, error)

+ type Specs struct

+ Bandwidth Bandwidth

+ Cpus Cpus

+ Memory Memory

+ Nics Nics

+ Raid Raid

+ Storage []Storage

+ type Storage struct

+ Count int

+ Name string

+ Size float32

+ Unit string

+ type StorageClient struct

+ type StoragesClient struct

+ func (c *StoragesClient) List(projectID int, opts *GetOptions) ([]BlockStorage, *Response, error)

+ func (s *StoragesClient) Attach(request *AttachTo) (BlockStorage, *Response, error)

+ func (s *StoragesClient) Create(request *CreateStorage) (BlockStorage, *Response, error)

+ func (s *StoragesClient) Delete(storageID int) (*Response, error)

+ func (s *StoragesClient) Detach(storageID int) (*Response, error)

+ func (s *StoragesClient) Get(storageID int, opts *GetOptions) (BlockStorage, *Response, error)

+ func (s *StoragesClient) Update(request *UpdateStorage) (BlockStorage, *Response, error)

+ type StoragesService interface

+ Attach func(request *AttachTo) (BlockStorage, *Response, error)

+ Create func(request *CreateStorage) (BlockStorage, *Response, error)

+ Delete func(storageID int) (*Response, error)

+ Detach func(storageID int) (*Response, error)

+ Get func(storageID int, opts *GetOptions) (BlockStorage, *Response, error)

+ List func(projectID int, opts *GetOptions) ([]BlockStorage, *Response, error)

+ Update func(request *UpdateStorage) (BlockStorage, *Response, error)

+ type Team struct

+ Billing Billing

+ Credit Credit

+ Href string

+ ID int

+ Name string

+ type TeamsClient struct

+ func (p *TeamsClient) Create(request *CreateTeam) (Team, *Response, error)

+ func (p *TeamsClient) Delete(teamID int) (*Response, error)

+ func (p *TeamsClient) Get(teamID int, opts *GetOptions) (Team, *Response, error)

+ func (p *TeamsClient) Update(teamID int, request *UpdateTeam) (Team, *Response, error)

+ func (t *TeamsClient) List(opts *GetOptions) ([]Team, *Response, error)

+ type TeamsService interface

+ Create func(request *CreateTeam) (Team, *Response, error)

+ Delete func(teamID int) (*Response, error)

+ Get func(teamID int, opts *GetOptions) (Team, *Response, error)

+ List func(opts *GetOptions) ([]Team, *Response, error)

+ Update func(teamID int, request *UpdateTeam) (Team, *Response, error)

+ type UpdateIPAddress struct

+ ARecord string

+ AssignedTo string

+ PtrRecord string

+ RoutedTo string

+ Tags *map[string]string

+ TargetedTo string

+ type UpdateProject struct

+ Bgp *bool

+ Name *string

+ type UpdateSSHKey struct

+ Key *string

+ Label *string

+ type UpdateServer struct

+ Bgp bool

+ Hostname string

+ Name string

+ Tags *map[string]string

+ type UpdateStorage struct

+ Description string

+ Size int

+ StorageID int

+ type UpdateTeam struct

+ Currency *string

+ Name *string

+ Type *string

+ type User struct

+ Email string

+ EmailVerified bool

+ FirstName string

+ Href string

+ ID int

+ LastName string

+ Phone string

+ SecurityPhone string

+ SecurityPhoneVerified bool

+ type UsersClient struct

+ func (s *UsersClient) CurrentUser(opts *GetOptions) (User, *Response, error)

+ func (s *UsersClient) Get(userID int, opts *GetOptions) (User, *Response, error)

+ type UsersService interface

+ CurrentUser func(opts *GetOptions) (User, *Response, error)

+ Get func(userID int, opts *GetOptions) (User, *Response, error)

+ type Vat struct

+ Amount int

+ Number string

+ Valid bool

Other modules containing this package

github.com/cherryservers/cherrygo

github.com/cherryservers/cherrygo/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL