hcloud

package
v1.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2018 License: MIT Imports: 15 Imported by: 191

Documentation

Overview

Package hcloud is a library for the Hetzner Cloud API.

Example 
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/hetznercloud/hcloud-go/hcloud"
)

func main() {
	client := hcloud.NewClient(hcloud.WithToken("token"))

	server, _, err := client.Server.GetByID(context.Background(), 1)
	if err != nil {
		log.Fatalf("error retrieving server: %s\n", err)
	}
	if server != nil {
		fmt.Printf("server 1 is called %q\n", server.Name)
	} else {
		fmt.Println("server 1 not found")
	}
}

Index

Examples

Constants

View Source 
const Endpoint = "https://api.hetzner.cloud/v1"

Endpoint is the base URL of the API.

View Source 
const UserAgent = "hcloud-go/" + Version

UserAgent is the value for the library part of the User-Agent header that is sent with each request.

View Source 
const Version = "1.11.0"

Version is the library's version following Semantic Versioning.

Variables

This section is empty.

Functions

func Bool added in v1.6.0 

func Bool(b bool) *bool

Bool returns a pointer to the passed bool b.

func Int 

func Int(i int) *int

Int returns a pointer to the passed integer i.

func IsError 

func IsError(err error, code ErrorCode) bool

IsError returns whether err is an API error with the given error code.

func String 

func String(s string) *string

String returns a pointer to the passed string s.

Types

type Action 

type Action struct {
	ID           int
	Status       ActionStatus
	Command      string
	Progress     int
	Started      time.Time
	Finished     time.Time
	ErrorCode    string
	ErrorMessage string
	Resources    []*ActionResource
}

Action represents an action in the Hetzner Cloud.

func ActionFromSchema 

func ActionFromSchema(s schema.Action) *Action

ActionFromSchema converts a schema.Action to an Action.

func ActionsFromSchema added in v1.11.0 

func ActionsFromSchema(s []schema.Action) []*Action

ActionsFromSchema converts a slice of schema.Action to a slice of Action.

func (*Action) Error 

func (a *Action) Error() error

type ActionClient 

type ActionClient struct {
	// contains filtered or unexported fields
}

ActionClient is a client for the actions API.

func (*ActionClient) All 

func (c *ActionClient) All(ctx context.Context) ([]*Action, error)

All returns all actions.

func (*ActionClient) GetByID 

func (c *ActionClient) GetByID(ctx context.Context, id int) (*Action, *Response, error)

GetByID retrieves an action by its ID. If the action does not exist, nil is returned.

func (*ActionClient) List 

func (c *ActionClient) List(ctx context.Context, opts ActionListOpts) ([]*Action, *Response, error)

List returns a list of actions for a specific page.

func (*ActionClient) WatchProgress added in v1.2.0 

func (c *ActionClient) WatchProgress(ctx context.Context, action *Action) (<-chan int, <-chan error)

WatchProgress watches the action's progress until it completes with success or error.

type ActionError added in v1.2.0 

type ActionError struct {
	Code    string
	Message string
}

ActionError is the error of an action.

func (ActionError) Error added in v1.2.0 

func (e ActionError) Error() string

type ActionListOpts 

type ActionListOpts struct {
	ListOpts
}

ActionListOpts specifies options for listing actions.

type ActionResource 

type ActionResource struct {
	ID   int
	Type ActionResourceType
}

ActionResource references other resources from an action.

type ActionResourceType 

type ActionResourceType string

ActionResourceType represents an action's resource reference type. 

const (
	ActionResourceTypeServer     ActionResourceType = "server"
	ActionResourceTypeImage      ActionResourceType = "image"
	ActionResourceTypeISO        ActionResourceType = "iso"
	ActionResourceTypeFloatingIP ActionResourceType = "floating_ip"
	ActionResourceTypeVolume     ActionResourceType = "volume"
)

List of action resource reference types.

type ActionStatus 

type ActionStatus string

ActionStatus represents an action's status. 

const (
	ActionStatusRunning ActionStatus = "running"
	ActionStatusSuccess ActionStatus = "success"
	ActionStatusError   ActionStatus = "error"
)

List of action statuses.

type BackoffFunc 

type BackoffFunc func(retries int) time.Duration

A BackoffFunc returns the duration to wait before performing the next retry. The retries argument specifies how many retries have already been performed. When called for the first time, retries is 0.

func ConstantBackoff 

func ConstantBackoff(d time.Duration) BackoffFunc

ConstantBackoff returns a BackoffFunc which backs off for constant duration d.

func ExponentialBackoff 

func ExponentialBackoff(b float64, d time.Duration) BackoffFunc

ExponentialBackoff returns a BackoffFunc which implements an exponential backoff using the formula: b^retries * d

type CPUType added in v1.8.0 

type CPUType string

CPUType specifies the type of the CPU. 

const (
	// CPUTypeShared is the type for shared CPU.
	CPUTypeShared CPUType = "shared"

	//CPUTypeDedicated is the type for dedicated CPU.
	CPUTypeDedicated CPUType = "dedicated"
)

type Client 

type Client struct {
	Action     ActionClient
	Datacenter DatacenterClient
	FloatingIP FloatingIPClient
	Image      ImageClient
	ISO        ISOClient
	Location   LocationClient
	Pricing    PricingClient
	Server     ServerClient
	ServerType ServerTypeClient
	SSHKey     SSHKeyClient
	Volume     VolumeClient
	// contains filtered or unexported fields
}

Client is a client for the Hetzner Cloud API.

func NewClient 

func NewClient(options ...ClientOption) *Client

NewClient creates a new client.

func (*Client) Do 

func (c *Client) Do(r *http.Request, v interface{}) (*Response, error)

Do performs an HTTP request against the API.

func (*Client) NewRequest 

func (c *Client) NewRequest(ctx context.Context, method, path string, body io.Reader) (*http.Request, error)

NewRequest creates an HTTP request against the API. The returned request is assigned with ctx and has all necessary headers set (auth, user agent, etc.).

type ClientOption 

type ClientOption func(*Client)

A ClientOption is used to configure a Client.

func WithApplication added in v1.10.0 

func WithApplication(name, version string) ClientOption

WithApplication configures a Client with the given application name and application version. The version may be blank. Programs are encouraged to at least set an application name.

func WithBackoffFunc 

func WithBackoffFunc(f BackoffFunc) ClientOption

WithBackoffFunc configures a Client to use the specified backoff function.

func WithEndpoint 

func WithEndpoint(endpoint string) ClientOption

WithEndpoint configures a Client to use the specified API endpoint.

func WithPollInterval added in v1.8.0 

func WithPollInterval(pollInterval time.Duration) ClientOption

WithPollInterval configures a Client to use the specified interval when polling from the API.

func WithToken 

func WithToken(token string) ClientOption

WithToken configures a Client to use the specified token for authentication.

type Datacenter 

type Datacenter struct {
	ID          int
	Name        string
	Description string
	Location    *Location
	ServerTypes DatacenterServerTypes
}

Datacenter represents a datacenter in the Hetzner Cloud.

func DatacenterFromSchema 

func DatacenterFromSchema(s schema.Datacenter) *Datacenter

DatacenterFromSchema converts a schema.Datacenter to a Datacenter.

type DatacenterClient 

type DatacenterClient struct {
	// contains filtered or unexported fields
}

DatacenterClient is a client for the datacenter API.

func (*DatacenterClient) All 

func (c *DatacenterClient) All(ctx context.Context) ([]*Datacenter, error)

All returns all datacenters.

func (*DatacenterClient) Get 

func (c *DatacenterClient) Get(ctx context.Context, idOrName string) (*Datacenter, *Response, error)

Get retrieves a datacenter by its ID if the input can be parsed as an integer, otherwise it retrieves a datacenter by its name. If the datacenter does not exist, nil is returned.

func (*DatacenterClient) GetByID 

func (c *DatacenterClient) GetByID(ctx context.Context, id int) (*Datacenter, *Response, error)

GetByID retrieves a datacenter by its ID. If the datacenter does not exist, nil is returned.

func (*DatacenterClient) GetByName 

func (c *DatacenterClient) GetByName(ctx context.Context, name string) (*Datacenter, *Response, error)

GetByName retrieves an datacenter by its name. If the datacenter does not exist, nil is returned.

func (*DatacenterClient) List 

func (c *DatacenterClient) List(ctx context.Context, opts DatacenterListOpts) ([]*Datacenter, *Response, error)

List returns a list of datacenters for a specific page.

type DatacenterListOpts 

type DatacenterListOpts struct {
	ListOpts
}

DatacenterListOpts specifies options for listing datacenters.

type DatacenterServerTypes 

type DatacenterServerTypes struct {
	Supported []*ServerType
	Available []*ServerType
}

DatacenterServerTypes represents the server types available and supported in a datacenter.

type Error 

type Error struct {
	Code    ErrorCode
	Message string
	Details interface{}
}

Error is an error returned from the API.

func ErrorFromSchema 

func ErrorFromSchema(s schema.Error) Error

ErrorFromSchema converts a schema.Error to an Error.

func (Error) Error 

func (e Error) Error() string

type ErrorCode 

type ErrorCode string

ErrorCode represents an error code returned from the API. 

const (
	ErrorCodeServiceError      ErrorCode = "service_error"       // Generic server error
	ErrorCodeRateLimitExceeded ErrorCode = "rate_limit_exceeded" // Rate limit exceeded
	ErrorCodeUnknownError      ErrorCode = "unknown_error"       // Unknown error
	ErrorCodeNotFound          ErrorCode = "not_found"           // Resource not found
	ErrorCodeInvalidInput      ErrorCode = "invalid_input"       // Validation error

	// The actual value of this error code is limit_reached. The new error code
	// rate_limit_exceeded for ratelimiting was introduced before Hetzner Cloud
	// launched into the public. To make clients using the old error code still
	// work as expected, we set the value of the old error code to that of the
	// new error code.
	ErrorCodeLimitReached = ErrorCodeRateLimitExceeded
)

Error codes returned from the API.

type ErrorDetailsInvalidInput 

type ErrorDetailsInvalidInput struct {
	Fields []ErrorDetailsInvalidInputField
}

ErrorDetailsInvalidInput contains the details of an 'invalid_input' error.

type ErrorDetailsInvalidInputField 

type ErrorDetailsInvalidInputField struct {
	Name     string
	Messages []string
}

ErrorDetailsInvalidInputField contains the validation errors reported on a field.

type FloatingIP 

type FloatingIP struct {
	ID           int
	Description  string
	IP           net.IP
	Network      *net.IPNet
	Type         FloatingIPType
	Server       *Server
	DNSPtr       map[string]string
	HomeLocation *Location
	Blocked      bool
	Protection   FloatingIPProtection
	Labels       map[string]string
}

FloatingIP represents a Floating IP in the Hetzner Cloud.

func FloatingIPFromSchema 

func FloatingIPFromSchema(s schema.FloatingIP) *FloatingIP

FloatingIPFromSchema converts a schema.FloatingIP to a FloatingIP.

func (*FloatingIP) DNSPtrForIP 

func (f *FloatingIP) DNSPtrForIP(ip net.IP) string

DNSPtrForIP returns the reverse DNS pointer of the IP address.

type FloatingIPChangeProtectionOpts added in v1.6.0 

type FloatingIPChangeProtectionOpts struct {
	Delete *bool
}

FloatingIPChangeProtectionOpts specifies options for changing the resource protection level of a Floating IP.

type FloatingIPClient 

type FloatingIPClient struct {
	// contains filtered or unexported fields
}

FloatingIPClient is a client for the Floating IP API.

func (*FloatingIPClient) All 

func (c *FloatingIPClient) All(ctx context.Context) ([]*FloatingIP, error)

All returns all Floating IPs.

func (*FloatingIPClient) AllWithOpts added in v1.9.0 

func (c *FloatingIPClient) AllWithOpts(ctx context.Context, opts FloatingIPListOpts) ([]*FloatingIP, error)

AllWithOpts returns all Floating IPs for the given options.

func (*FloatingIPClient) Assign 

func (c *FloatingIPClient) Assign(ctx context.Context, floatingIP *FloatingIP, server *Server) (*Action, *Response, error)

Assign assigns a Floating IP to a server.

func (*FloatingIPClient) ChangeDNSPtr 

func (c *FloatingIPClient) ChangeDNSPtr(ctx context.Context, floatingIP *FloatingIP, ip string, ptr *string) (*Action, *Response, error)

ChangeDNSPtr changes or resets the reverse DNS pointer for a Floating IP address. Pass a nil ptr to reset the reverse DNS pointer to its default value.

func (*FloatingIPClient) ChangeProtection added in v1.6.0 

func (c *FloatingIPClient) ChangeProtection(ctx context.Context, floatingIP *FloatingIP, opts FloatingIPChangeProtectionOpts) (*Action, *Response, error)

ChangeProtection changes the resource protection level of a Floating IP.

func (*FloatingIPClient) Create 

func (c *FloatingIPClient) Create(ctx context.Context, opts FloatingIPCreateOpts) (FloatingIPCreateResult, *Response, error)

Create creates a Floating IP.

func (*FloatingIPClient) Delete 

func (c *FloatingIPClient) Delete(ctx context.Context, floatingIP *FloatingIP) (*Response, error)

Delete deletes a Floating IP.

func (*FloatingIPClient) GetByID 

func (c *FloatingIPClient) GetByID(ctx context.Context, id int) (*FloatingIP, *Response, error)

GetByID retrieves a Floating IP by its ID. If the Floating IP does not exist, nil is returned.

func (*FloatingIPClient) List 

func (c *FloatingIPClient) List(ctx context.Context, opts FloatingIPListOpts) ([]*FloatingIP, *Response, error)

List returns a list of Floating IPs for a specific page.

func (*FloatingIPClient) Unassign 

func (c *FloatingIPClient) Unassign(ctx context.Context, floatingIP *FloatingIP) (*Action, *Response, error)

Unassign unassigns a Floating IP from the currently assigned server.

func (*FloatingIPClient) Update 

func (c *FloatingIPClient) Update(ctx context.Context, floatingIP *FloatingIP, opts FloatingIPUpdateOpts) (*FloatingIP, *Response, error)

Update updates a Floating IP.

type FloatingIPCreateOpts 

type FloatingIPCreateOpts struct {
	Type         FloatingIPType
	HomeLocation *Location
	Server       *Server
	Description  *string
	Labels       map[string]string
}

FloatingIPCreateOpts specifies options for creating a Floating IP.

func (FloatingIPCreateOpts) Validate 

func (o FloatingIPCreateOpts) Validate() error

Validate checks if options are valid.

type FloatingIPCreateResult 

type FloatingIPCreateResult struct {
	FloatingIP *FloatingIP
	Action     *Action
}

FloatingIPCreateResult is the result of creating a Floating IP.

type FloatingIPListOpts 

type FloatingIPListOpts struct {
	ListOpts
}

FloatingIPListOpts specifies options for listing Floating IPs.

type FloatingIPPricing 

type FloatingIPPricing struct {
	Monthly Price
}

FloatingIPPricing provides pricing information for Floating IPs.

type FloatingIPProtection added in v1.6.0 

type FloatingIPProtection struct {
	Delete bool
}

FloatingIPProtection represents the protection level of a Floating IP.

type FloatingIPType 

type FloatingIPType string

FloatingIPType represents the type of a Floating IP. 

const (
	FloatingIPTypeIPv4 FloatingIPType = "ipv4"
	FloatingIPTypeIPv6 FloatingIPType = "ipv6"
)

Floating IP types.

type FloatingIPUpdateOpts 

type FloatingIPUpdateOpts struct {
	Description string
	Labels      map[string]string
}

FloatingIPUpdateOpts specifies options for updating a Floating IP.

type ISO 

type ISO struct {
	ID          int
	Name        string
	Description string
	Type        ISOType
	Deprecated  time.Time
}

ISO represents an ISO image in the Hetzner Cloud.

func ISOFromSchema 

func ISOFromSchema(s schema.ISO) *ISO

ISOFromSchema converts a schema.ISO to an ISO.

func (*ISO) IsDeprecated added in v1.7.0 

func (iso *ISO) IsDeprecated() bool

IsDeprecated returns true if the ISO is deprecated

type ISOClient 

type ISOClient struct {
	// contains filtered or unexported fields
}

ISOClient is a client for the ISO API.

func (*ISOClient) All 

func (c *ISOClient) All(ctx context.Context) ([]*ISO, error)

All returns all ISOs.

func (*ISOClient) Get 

func (c *ISOClient) Get(ctx context.Context, idOrName string) (*ISO, *Response, error)

Get retrieves an ISO by its ID if the input can be parsed as an integer, otherwise it retrieves an ISO by its name.

func (*ISOClient) GetByID 

func (c *ISOClient) GetByID(ctx context.Context, id int) (*ISO, *Response, error)

GetByID retrieves an ISO by its ID.

func (*ISOClient) GetByName 

func (c *ISOClient) GetByName(ctx context.Context, name string) (*ISO, *Response, error)

GetByName retrieves an ISO by its name.

func (*ISOClient) List 

func (c *ISOClient) List(ctx context.Context, opts ISOListOpts) ([]*ISO, *Response, error)

List returns a list of ISOs for a specific page.

type ISOListOpts 

type ISOListOpts struct {
	ListOpts
}

ISOListOpts specifies options for listing isos.

type ISOType 

type ISOType string

ISOType specifies the type of an ISO image. 

const (
	// ISOTypePublic is the type of a public ISO image.
	ISOTypePublic ISOType = "public"

	// ISOTypePrivate is the type of a private ISO image.
	ISOTypePrivate ISOType = "private"
)

type Image 

type Image struct {
	ID          int
	Name        string
	Type        ImageType
	Status      ImageStatus
	Description string
	ImageSize   float32
	DiskSize    float32
	Created     time.Time
	CreatedFrom *Server
	BoundTo     *Server
	RapidDeploy bool

	OSFlavor  string
	OSVersion string

	Protection ImageProtection
	Deprecated time.Time // The zero value denotes the image is not deprecated.
	Labels     map[string]string
}

Image represents an Image in the Hetzner Cloud.

func ImageFromSchema 

func ImageFromSchema(s schema.Image) *Image

ImageFromSchema converts a schema.Image to an Image.

func (*Image) IsDeprecated added in v1.7.0 

func (image *Image) IsDeprecated() bool

IsDeprecated returns whether the image is deprecated.

type ImageChangeProtectionOpts added in v1.6.0 

type ImageChangeProtectionOpts struct {
	Delete *bool
}

ImageChangeProtectionOpts specifies options for changing the resource protection level of an image.

type ImageClient 

type ImageClient struct {
	// contains filtered or unexported fields
}

ImageClient is a client for the image API.

func (*ImageClient) All 

func (c *ImageClient) All(ctx context.Context) ([]*Image, error)

All returns all images.

func (*ImageClient) AllWithOpts added in v1.9.0 

func (c *ImageClient) AllWithOpts(ctx context.Context, opts ImageListOpts) ([]*Image, error)

AllWithOpts returns all images for the given options.

func (*ImageClient) ChangeProtection added in v1.6.0 

func (c *ImageClient) ChangeProtection(ctx context.Context, image *Image, opts ImageChangeProtectionOpts) (*Action, *Response, error)

ChangeProtection changes the resource protection level of an image.

func (*ImageClient) Delete 

func (c *ImageClient) Delete(ctx context.Context, image *Image) (*Response, error)

Delete deletes an image.

func (*ImageClient) Get 

func (c *ImageClient) Get(ctx context.Context, idOrName string) (*Image, *Response, error)

Get retrieves an image by its ID if the input can be parsed as an integer, otherwise it retrieves an image by its name. If the image does not exist, nil is returned.

func (*ImageClient) GetByID 

func (c *ImageClient) GetByID(ctx context.Context, id int) (*Image, *Response, error)

GetByID retrieves an image by its ID. If the image does not exist, nil is returned.

func (*ImageClient) GetByName 

func (c *ImageClient) GetByName(ctx context.Context, name string) (*Image, *Response, error)

GetByName retrieves an image by its name. If the image does not exist, nil is returned.

func (*ImageClient) List 

func (c *ImageClient) List(ctx context.Context, opts ImageListOpts) ([]*Image, *Response, error)

List returns a list of images for a specific page.

func (*ImageClient) Update 

func (c *ImageClient) Update(ctx context.Context, image *Image, opts ImageUpdateOpts) (*Image, *Response, error)

Update updates an image.

type ImageListOpts 

type ImageListOpts struct {
	ListOpts
}

ImageListOpts specifies options for listing images.

type ImagePricing 

type ImagePricing struct {
	PerGBMonth Price
}

ImagePricing provides pricing information for imaegs.

type ImageProtection added in v1.6.0 

type ImageProtection struct {
	Delete bool
}

ImageProtection represents the protection level of an image.

type ImageStatus 

type ImageStatus string

ImageStatus specifies the status of an image. 

const (
	// ImageStatusCreating is the status when an image is being created.
	ImageStatusCreating ImageStatus = "creating"
	// ImageStatusAvailable is the status when an image is available.
	ImageStatusAvailable ImageStatus = "available"
)

type ImageType 

type ImageType string

ImageType specifies the type of an image. 

const (
	// ImageTypeSnapshot represents a snapshot image.
	ImageTypeSnapshot ImageType = "snapshot"
	// ImageTypeBackup represents a backup image.
	ImageTypeBackup ImageType = "backup"
	// ImageTypeSystem represents a system image.
	ImageTypeSystem ImageType = "system"
)

type ImageUpdateOpts 

type ImageUpdateOpts struct {
	Description *string
	Type        ImageType
	Labels      map[string]string
}

ImageUpdateOpts specifies options for updating an image.

type ListOpts 

type ListOpts struct {
	Page          int    // Page (starting at 1)
	PerPage       int    // Items per page (0 means default)
	LabelSelector string // Label selector for filtering by labels
}

ListOpts specifies options for listing resources.

type Location 

type Location struct {
	ID          int
	Name        string
	Description string
	Country     string
	City        string
	Latitude    float64
	Longitude   float64
}

Location represents a location in the Hetzner Cloud.

func LocationFromSchema 

func LocationFromSchema(s schema.Location) *Location

LocationFromSchema converts a schema.Location to a Location.

type LocationClient 

type LocationClient struct {
	// contains filtered or unexported fields
}

LocationClient is a client for the location API.

func (*LocationClient) All 

func (c *LocationClient) All(ctx context.Context) ([]*Location, error)

All returns all locations.

func (*LocationClient) Get 

func (c *LocationClient) Get(ctx context.Context, idOrName string) (*Location, *Response, error)

Get retrieves a location by its ID if the input can be parsed as an integer, otherwise it retrieves a location by its name. If the location does not exist, nil is returned.

func (*LocationClient) GetByID 

func (c *LocationClient) GetByID(ctx context.Context, id int) (*Location, *Response, error)

GetByID retrieves a location by its ID. If the location does not exist, nil is returned.

func (*LocationClient) GetByName 

func (c *LocationClient) GetByName(ctx context.Context, name string) (*Location, *Response, error)

GetByName retrieves an location by its name. If the location does not exist, nil is returned.

func (*LocationClient) List 

func (c *LocationClient) List(ctx context.Context, opts LocationListOpts) ([]*Location, *Response, error)

List returns a list of locations for a specific page.

type LocationListOpts 

type LocationListOpts struct {
	ListOpts
}

LocationListOpts specifies options for listing location.

type Meta 

type Meta struct {
	Pagination *Pagination
	Ratelimit  Ratelimit
}

Meta represents meta information included in an API response.

type Pagination 

type Pagination struct {
	Page         int
	PerPage      int
	PreviousPage int
	NextPage     int
	LastPage     int
	TotalEntries int
}

Pagination represents pagination meta information.

func PaginationFromSchema 

func PaginationFromSchema(s schema.MetaPagination) Pagination

PaginationFromSchema converts a schema.MetaPagination to a Pagination.

type Price 

type Price struct {
	Currency string
	VATRate  string
	Net      string
	Gross    string
}

Price represents a price. Net amount, gross amount, as well as VAT rate are specified as strings and it is the user's responsibility to convert them to appropriate types for calculations.

type Pricing 

type Pricing struct {
	Image        ImagePricing
	FloatingIP   FloatingIPPricing
	Traffic      TrafficPricing
	ServerBackup ServerBackupPricing
	ServerTypes  []ServerTypePricing
}

Pricing specifies pricing information for various resources.

func PricingFromSchema 

func PricingFromSchema(s schema.Pricing) Pricing

PricingFromSchema converts a schema.Pricing to a Pricing.

type PricingClient 

type PricingClient struct {
	// contains filtered or unexported fields
}

PricingClient is a client for the pricing API.

func (*PricingClient) Get 

func (c *PricingClient) Get(ctx context.Context) (Pricing, *Response, error)

Get retrieves pricing information.

type Ratelimit 

type Ratelimit struct {
	Limit     int
	Remaining int
	Reset     time.Time
}

Ratelimit represents ratelimit information.

type Response 

type Response struct {
	*http.Response
	Meta Meta
}

Response represents a response from the API. It embeds http.Response.

type SSHKey 

type SSHKey struct {
	ID          int
	Name        string
	Fingerprint string
	PublicKey   string
	Labels      map[string]string
}

SSHKey represents a SSH key in the Hetzner Cloud.

func SSHKeyFromSchema 

func SSHKeyFromSchema(s schema.SSHKey) *SSHKey

SSHKeyFromSchema converts a schema.SSHKey to a SSHKey.

type SSHKeyClient 

type SSHKeyClient struct {
	// contains filtered or unexported fields
}

SSHKeyClient is a client for the SSH keys API.

func (*SSHKeyClient) All 

func (c *SSHKeyClient) All(ctx context.Context) ([]*SSHKey, error)

All returns all SSH keys.

func (*SSHKeyClient) AllWithOpts added in v1.9.0 

func (c *SSHKeyClient) AllWithOpts(ctx context.Context, opts SSHKeyListOpts) ([]*SSHKey, error)

AllWithOpts returns all SSH keys with the given options.

func (*SSHKeyClient) Create 

func (c *SSHKeyClient) Create(ctx context.Context, opts SSHKeyCreateOpts) (*SSHKey, *Response, error)

Create creates a new SSH key with the given options.

func (*SSHKeyClient) Delete 

func (c *SSHKeyClient) Delete(ctx context.Context, sshKey *SSHKey) (*Response, error)

Delete deletes a SSH key.

func (*SSHKeyClient) Get 

func (c *SSHKeyClient) Get(ctx context.Context, idOrName string) (*SSHKey, *Response, error)

Get retrieves a SSH key by its ID if the input can be parsed as an integer, otherwise it retrieves a SSH key by its name. If the SSH key does not exist, nil is returned.

func (*SSHKeyClient) GetByFingerprint added in v1.5.0 

func (c *SSHKeyClient) GetByFingerprint(ctx context.Context, fingerprint string) (*SSHKey, *Response, error)

GetByFingerprint retreives a SSH key by its fingerprint. If the SSH key does not exist, nil is returned.

func (*SSHKeyClient) GetByID 

func (c *SSHKeyClient) GetByID(ctx context.Context, id int) (*SSHKey, *Response, error)

GetByID retrieves a SSH key by its ID. If the SSH key does not exist, nil is returned.

func (*SSHKeyClient) GetByName 

func (c *SSHKeyClient) GetByName(ctx context.Context, name string) (*SSHKey, *Response, error)

GetByName retrieves a SSH key by its name. If the SSH key does not exist, nil is returned.

func (*SSHKeyClient) List 

func (c *SSHKeyClient) List(ctx context.Context, opts SSHKeyListOpts) ([]*SSHKey, *Response, error)

List returns a list of SSH keys for a specific page.

func (*SSHKeyClient) Update 

func (c *SSHKeyClient) Update(ctx context.Context, sshKey *SSHKey, opts SSHKeyUpdateOpts) (*SSHKey, *Response, error)

Update updates a SSH key.

type SSHKeyCreateOpts 

type SSHKeyCreateOpts struct {
	Name      string
	PublicKey string
	Labels    map[string]string
}

SSHKeyCreateOpts specifies parameters for creating a SSH key.

func (SSHKeyCreateOpts) Validate 

func (o SSHKeyCreateOpts) Validate() error

Validate checks if options are valid.

type SSHKeyListOpts 

type SSHKeyListOpts struct {
	ListOpts
}

SSHKeyListOpts specifies options for listing SSH keys.

type SSHKeyUpdateOpts 

type SSHKeyUpdateOpts struct {
	Name   string
	Labels map[string]string
}

SSHKeyUpdateOpts specifies options for updating a SSH key.

type Server 

type Server struct {
	ID              int
	Name            string
	Status          ServerStatus
	Created         time.Time
	PublicNet       ServerPublicNet
	ServerType      *ServerType
	Datacenter      *Datacenter
	IncludedTraffic uint64
	OutgoingTraffic uint64
	IngoingTraffic  uint64
	BackupWindow    string
	RescueEnabled   bool
	Locked          bool
	ISO             *ISO
	Image           *Image
	Protection      ServerProtection
	Labels          map[string]string
	Volumes         []*Volume
}

Server represents a server in the Hetzner Cloud.

func ServerFromSchema 

func ServerFromSchema(s schema.Server) *Server

ServerFromSchema converts a schema.Server to a Server.

type ServerBackupPricing 

type ServerBackupPricing struct {
	Percentage string
}

ServerBackupPricing provides pricing information for server backups.

type ServerChangeProtectionOpts added in v1.6.0 

type ServerChangeProtectionOpts struct {
	Rebuild *bool
	Delete  *bool
}

ServerChangeProtectionOpts specifies options for changing the resource protection level of a server.

type ServerChangeTypeOpts 

type ServerChangeTypeOpts struct {
	ServerType  *ServerType // new server type
	UpgradeDisk bool        // whether disk should be upgraded
}

ServerChangeTypeOpts specifies options for changing a server's type.

type ServerClient 

type ServerClient struct {
	// contains filtered or unexported fields
}

ServerClient is a client for the servers API.

func (*ServerClient) All 

func (c *ServerClient) All(ctx context.Context) ([]*Server, error)

All returns all servers.

func (*ServerClient) AllWithOpts added in v1.9.0 

func (c *ServerClient) AllWithOpts(ctx context.Context, opts ServerListOpts) ([]*Server, error)

AllWithOpts returns all servers for the given options.

func (*ServerClient) AttachISO 

func (c *ServerClient) AttachISO(ctx context.Context, server *Server, iso *ISO) (*Action, *Response, error)

AttachISO attaches an ISO to a server.

func (*ServerClient) ChangeDNSPtr 

func (c *ServerClient) ChangeDNSPtr(ctx context.Context, server *Server, ip string, ptr *string) (*Action, *Response, error)

ChangeDNSPtr changes or resets the reverse DNS pointer for a server IP address. Pass a nil ptr to reset the reverse DNS pointer to its default value.

func (*ServerClient) ChangeProtection added in v1.6.0 

func (c *ServerClient) ChangeProtection(ctx context.Context, image *Server, opts ServerChangeProtectionOpts) (*Action, *Response, error)

ChangeProtection changes the resource protection level of a server.

func (*ServerClient) ChangeType 

func (c *ServerClient) ChangeType(ctx context.Context, server *Server, opts ServerChangeTypeOpts) (*Action, *Response, error)

ChangeType changes a server's type.

func (*ServerClient) Create 

func (c *ServerClient) Create(ctx context.Context, opts ServerCreateOpts) (ServerCreateResult, *Response, error)

Create creates a new server.

func (*ServerClient) CreateImage 

func (c *ServerClient) CreateImage(ctx context.Context, server *Server, opts *ServerCreateImageOpts) (ServerCreateImageResult, *Response, error)

CreateImage creates an image from a server.

func (*ServerClient) Delete 

func (c *ServerClient) Delete(ctx context.Context, server *Server) (*Response, error)

Delete deletes a server.

func (*ServerClient) DetachISO 

func (c *ServerClient) DetachISO(ctx context.Context, server *Server) (*Action, *Response, error)

DetachISO detaches the currently attached ISO from a server.

func (*ServerClient) DisableBackup 

func (c *ServerClient) DisableBackup(ctx context.Context, server *Server) (*Action, *Response, error)

DisableBackup disables backup for a server.

func (*ServerClient) DisableRescue 

func (c *ServerClient) DisableRescue(ctx context.Context, server *Server) (*Action, *Response, error)

DisableRescue disables rescue mode for a server.

func (*ServerClient) EnableBackup 

func (c *ServerClient) EnableBackup(ctx context.Context, server *Server, window string) (*Action, *Response, error)

EnableBackup enables backup for a server. Pass in an empty backup window to let the API pick a window for you. See the API documentation at docs.hetzner.cloud for a list of valid backup windows.

func (*ServerClient) EnableRescue 

func (c *ServerClient) EnableRescue(ctx context.Context, server *Server, opts ServerEnableRescueOpts) (ServerEnableRescueResult, *Response, error)

EnableRescue enables rescue mode for a server.

func (*ServerClient) Get 

func (c *ServerClient) Get(ctx context.Context, idOrName string) (*Server, *Response, error)

Get retrieves a server by its ID if the input can be parsed as an integer, otherwise it retrieves a server by its name. If the server does not exist, nil is returned.

func (*ServerClient) GetByID 

func (c *ServerClient) GetByID(ctx context.Context, id int) (*Server, *Response, error)

GetByID retrieves a server by its ID. If the server does not exist, nil is returned.

func (*ServerClient) GetByName 

func (c *ServerClient) GetByName(ctx context.Context, name string) (*Server, *Response, error)

GetByName retreives a server by its name. If the server does not exist, nil is returned.

func (*ServerClient) List 

func (c *ServerClient) List(ctx context.Context, opts ServerListOpts) ([]*Server, *Response, error)

List returns a list of servers for a specific page.

func (*ServerClient) Poweroff 

func (c *ServerClient) Poweroff(ctx context.Context, server *Server) (*Action, *Response, error)

Poweroff stops a server.

func (*ServerClient) Poweron 

func (c *ServerClient) Poweron(ctx context.Context, server *Server) (*Action, *Response, error)

Poweron starts a server.

func (*ServerClient) Reboot 

func (c *ServerClient) Reboot(ctx context.Context, server *Server) (*Action, *Response, error)

Reboot reboots a server.

func (*ServerClient) Rebuild 

func (c *ServerClient) Rebuild(ctx context.Context, server *Server, opts ServerRebuildOpts) (*Action, *Response, error)

Rebuild rebuilds a server.

func (*ServerClient) Reset 

func (c *ServerClient) Reset(ctx context.Context, server *Server) (*Action, *Response, error)

Reset resets a server.

func (*ServerClient) ResetPassword 

func (c *ServerClient) ResetPassword(ctx context.Context, server *Server) (ServerResetPasswordResult, *Response, error)

ResetPassword resets a server's password.

func (*ServerClient) Shutdown 

func (c *ServerClient) Shutdown(ctx context.Context, server *Server) (*Action, *Response, error)

Shutdown shuts down a server.

func (*ServerClient) Update 

func (c *ServerClient) Update(ctx context.Context, server *Server, opts ServerUpdateOpts) (*Server, *Response, error)

Update updates a server.

type ServerCreateImageOpts 

type ServerCreateImageOpts struct {
	Type        ImageType
	Description *string
	Labels      map[string]string
}

ServerCreateImageOpts specifies options for creating an image from a server.

func (ServerCreateImageOpts) Validate 

func (o ServerCreateImageOpts) Validate() error

Validate checks if options are valid.

type ServerCreateImageResult 

type ServerCreateImageResult struct {
	Action *Action
	Image  *Image
}

ServerCreateImageResult is the result of creating an image from a server.

type ServerCreateOpts 

type ServerCreateOpts struct {
	Name             string
	ServerType       *ServerType
	Image            *Image
	SSHKeys          []*SSHKey
	Location         *Location
	Datacenter       *Datacenter
	UserData         string
	StartAfterCreate *bool
	Labels           map[string]string
}

ServerCreateOpts specifies options for creating a new server.

func (ServerCreateOpts) Validate 

func (o ServerCreateOpts) Validate() error

Validate checks if options are valid.

type ServerCreateResult 

type ServerCreateResult struct {
	Server       *Server
	Action       *Action
	RootPassword string
	NextActions  []*Action
}

ServerCreateResult is the result of a create server call.

type ServerEnableRescueOpts 

type ServerEnableRescueOpts struct {
	Type    ServerRescueType
	SSHKeys []*SSHKey
}

ServerEnableRescueOpts specifies options for enabling rescue mode for a server.

type ServerEnableRescueResult 

type ServerEnableRescueResult struct {
	Action       *Action
	RootPassword string
}

ServerEnableRescueResult is the result of enabling rescue mode for a server.

type ServerListOpts 

type ServerListOpts struct {
	ListOpts
}

ServerListOpts specifies options for listing servers.

type ServerProtection added in v1.6.0 

type ServerProtection struct {
	Delete, Rebuild bool
}

ServerProtection represents the protection level of a server.

type ServerPublicNet 

type ServerPublicNet struct {
	IPv4        ServerPublicNetIPv4
	IPv6        ServerPublicNetIPv6
	FloatingIPs []*FloatingIP
}

ServerPublicNet represents a server's public network.

func ServerPublicNetFromSchema 

func ServerPublicNetFromSchema(s schema.ServerPublicNet) ServerPublicNet

ServerPublicNetFromSchema converts a schema.ServerPublicNet to a ServerPublicNet.

type ServerPublicNetIPv4 

type ServerPublicNetIPv4 struct {
	IP      net.IP
	Blocked bool
	DNSPtr  string
}

ServerPublicNetIPv4 represents a server's public IPv4 address.

func ServerPublicNetIPv4FromSchema 

func ServerPublicNetIPv4FromSchema(s schema.ServerPublicNetIPv4) ServerPublicNetIPv4

ServerPublicNetIPv4FromSchema converts a schema.ServerPublicNetIPv4 to a ServerPublicNetIPv4.

type ServerPublicNetIPv6 

type ServerPublicNetIPv6 struct {
	IP      net.IP
	Network *net.IPNet
	Blocked bool
	DNSPtr  map[string]string
}

ServerPublicNetIPv6 represents a server's public IPv6 network and address.

func ServerPublicNetIPv6FromSchema 

func ServerPublicNetIPv6FromSchema(s schema.ServerPublicNetIPv6) ServerPublicNetIPv6

ServerPublicNetIPv6FromSchema converts a schema.ServerPublicNetIPv6 to a ServerPublicNetIPv6.

func (*ServerPublicNetIPv6) DNSPtrForIP 

func (s *ServerPublicNetIPv6) DNSPtrForIP(ip net.IP) string

DNSPtrForIP returns the reverse dns pointer of the ip address.

type ServerRebuildOpts 

type ServerRebuildOpts struct {
	Image *Image
}

ServerRebuildOpts specifies options for rebuilding a server.

type ServerRescueType 

type ServerRescueType string

ServerRescueType represents rescue types. 

const (
	ServerRescueTypeLinux32   ServerRescueType = "linux32"
	ServerRescueTypeLinux64   ServerRescueType = "linux64"
	ServerRescueTypeFreeBSD64 ServerRescueType = "freebsd64"
)

List of rescue types.

type ServerResetPasswordResult 

type ServerResetPasswordResult struct {
	Action       *Action
	RootPassword string
}

ServerResetPasswordResult is the result of resetting a server's password.

type ServerStatus 

type ServerStatus string

ServerStatus specifies a server's status. 

const (
	// ServerStatusInitializing is the status when a server is initializing.
	ServerStatusInitializing ServerStatus = "initializing"

	// ServerStatusOff is the status when a server is off.
	ServerStatusOff ServerStatus = "off"

	// ServerStatusRunning is the status when a server is running.
	ServerStatusRunning ServerStatus = "running"
)

type ServerType 

type ServerType struct {
	ID          int
	Name        string
	Description string
	Cores       int
	Memory      float32
	Disk        int
	StorageType StorageType
	CPUType     CPUType
	Pricings    []ServerTypeLocationPricing
}

ServerType represents a server type in the Hetzner Cloud.

func ServerTypeFromSchema 

func ServerTypeFromSchema(s schema.ServerType) *ServerType

ServerTypeFromSchema converts a schema.ServerType to a ServerType.

type ServerTypeClient 

type ServerTypeClient struct {
	// contains filtered or unexported fields
}

ServerTypeClient is a client for the server types API.

func (*ServerTypeClient) All 

func (c *ServerTypeClient) All(ctx context.Context) ([]*ServerType, error)

All returns all server types.

func (*ServerTypeClient) Get 

func (c *ServerTypeClient) Get(ctx context.Context, idOrName string) (*ServerType, *Response, error)

Get retrieves a server type by its ID if the input can be parsed as an integer, otherwise it retrieves a server type by its name. If the server type does not exist, nil is returned.

func (*ServerTypeClient) GetByID 

func (c *ServerTypeClient) GetByID(ctx context.Context, id int) (*ServerType, *Response, error)

GetByID retrieves a server type by its ID. If the server type does not exist, nil is returned.

func (*ServerTypeClient) GetByName 

func (c *ServerTypeClient) GetByName(ctx context.Context, name string) (*ServerType, *Response, error)

GetByName retrieves a server type by its name. If the server type does not exist, nil is returned.

func (*ServerTypeClient) List 

func (c *ServerTypeClient) List(ctx context.Context, opts ServerTypeListOpts) ([]*ServerType, *Response, error)

List returns a list of server types for a specific page.

type ServerTypeListOpts 

type ServerTypeListOpts struct {
	ListOpts
}

ServerTypeListOpts specifies options for listing server types.

type ServerTypeLocationPricing 

type ServerTypeLocationPricing struct {
	Location *Location
	Hourly   Price
	Monthly  Price
}

ServerTypeLocationPricing provides pricing information for a server type at a location.

type ServerTypePricing 

type ServerTypePricing struct {
	ServerType *ServerType
	Pricings   []ServerTypeLocationPricing
}

ServerTypePricing provides pricing information for a server type.

type ServerUpdateOpts 

type ServerUpdateOpts struct {
	Name   string
	Labels map[string]string
}

ServerUpdateOpts specifies options for updating a server.

type StorageType 

type StorageType string

StorageType specifies the type of storage. 

const (
	// StorageTypeLocal is the type for local storage.
	StorageTypeLocal StorageType = "local"

	// StorageTypeCeph is the type for remote storage.
	StorageTypeCeph StorageType = "ceph"
)

type TrafficPricing 

type TrafficPricing struct {
	PerTB Price
}

TrafficPricing provides pricing information for traffic.

type Volume added in v1.10.0 

type Volume struct {
	ID          int
	Name        string
	Server      *Server
	Location    *Location
	Size        int
	Protection  VolumeProtection
	Labels      map[string]string
	LinuxDevice string
	Created     time.Time
}

Volume represents a volume in the Hetzner Cloud.

func VolumeFromSchema added in v1.10.0 

func VolumeFromSchema(s schema.Volume) *Volume

VolumeFromSchema converts a schema.Volume to a Volume.

type VolumeChangeProtectionOpts added in v1.10.0 

type VolumeChangeProtectionOpts struct {
	Delete *bool
}

VolumeChangeProtectionOpts specifies options for changing the resource protection level of a volume.

type VolumeClient added in v1.10.0 

type VolumeClient struct {
	// contains filtered or unexported fields
}

VolumeClient is a client for the volume API.

func (*VolumeClient) All added in v1.10.0 

func (c *VolumeClient) All(ctx context.Context) ([]*Volume, error)

All returns all volumes.

func (*VolumeClient) AllWithOpts added in v1.10.0 

func (c *VolumeClient) AllWithOpts(ctx context.Context, opts VolumeListOpts) ([]*Volume, error)

AllWithOpts returns all volumes with the given options.

func (*VolumeClient) Attach added in v1.10.0 

func (c *VolumeClient) Attach(ctx context.Context, volume *Volume, server *Server) (*Action, *Response, error)

Attach attaches a volume to a server.

func (*VolumeClient) ChangeProtection added in v1.10.0 

func (c *VolumeClient) ChangeProtection(ctx context.Context, volume *Volume, opts VolumeChangeProtectionOpts) (*Action, *Response, error)

ChangeProtection changes the resource protection level of a volume.

func (*VolumeClient) Create added in v1.10.0 

func (c *VolumeClient) Create(ctx context.Context, opts VolumeCreateOpts) (VolumeCreateResult, *Response, error)

Create creates a new volume with the given options.

func (*VolumeClient) Delete added in v1.10.0 

func (c *VolumeClient) Delete(ctx context.Context, volume *Volume) (*Response, error)

Delete deletes a volume.

func (*VolumeClient) Detach added in v1.10.0 

func (c *VolumeClient) Detach(ctx context.Context, volume *Volume) (*Action, *Response, error)

Detach detaches a volume from a server.

func (*VolumeClient) Get added in v1.10.0 

func (c *VolumeClient) Get(ctx context.Context, idOrName string) (*Volume, *Response, error)

Get retrieves a volume by its ID if the input can be parsed as an integer, otherwise it retrieves a volume by its name. If the volume does not exist, nil is returned.

func (*VolumeClient) GetByID added in v1.10.0 

func (c *VolumeClient) GetByID(ctx context.Context, id int) (*Volume, *Response, error)

GetByID retrieves a volume by its ID. If the volume does not exist, nil is returned.

func (*VolumeClient) GetByName added in v1.10.0 

func (c *VolumeClient) GetByName(ctx context.Context, name string) (*Volume, *Response, error)

GetByName retrieves a volume by its name. If the volume does not exist, nil is returned.

func (*VolumeClient) List added in v1.10.0 

func (c *VolumeClient) List(ctx context.Context, opts VolumeListOpts) ([]*Volume, *Response, error)

List returns a list of volumes for a specific page.

func (*VolumeClient) Resize added in v1.10.0 

func (c *VolumeClient) Resize(ctx context.Context, volume *Volume, size int) (*Action, *Response, error)

Resize changes the size of a volume.

func (*VolumeClient) Update added in v1.10.0 

func (c *VolumeClient) Update(ctx context.Context, volume *Volume, opts VolumeUpdateOpts) (*Volume, *Response, error)

Update updates a volume.

type VolumeCreateOpts added in v1.10.0 

type VolumeCreateOpts struct {
	Name     string
	Size     int
	Server   *Server
	Location *Location
	Labels   map[string]string
}

VolumeCreateOpts specifies parameters for creating a volume.

func (VolumeCreateOpts) Validate added in v1.10.0 

func (o VolumeCreateOpts) Validate() error

Validate checks if options are valid.

type VolumeCreateResult added in v1.10.0 

type VolumeCreateResult struct {
	Volume      *Volume
	Action      *Action
	NextActions []*Action
}

VolumeCreateResult is the result of creating a volume.

type VolumeListOpts added in v1.10.0 

type VolumeListOpts struct {
	ListOpts
}

VolumeListOpts specifies options for listing volumes.

type VolumeProtection added in v1.10.0 

type VolumeProtection struct {
	Delete bool
}

VolumeProtection represents the protection level of a volume.

type VolumeUpdateOpts added in v1.10.0 

type VolumeUpdateOpts struct {
	Name   string
	Labels map[string]string
}

VolumeUpdateOpts specifies options for updating a volume.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.