Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CertificateClient ¶
type CertificateClient struct {
*hcloud.CertificateClient
}
CertificateClient embeds the Hetzner Cloud Certificate client and provides some additional helper functions.
func (*CertificateClient) CertificateLabelKeys ¶
func (c *CertificateClient) CertificateLabelKeys(idOrName string) []string
CertificateLabelKeys returns a slice containing the keys of all labels assigned to the certificate with the passed idOrName.
func (*CertificateClient) CertificateNames ¶
func (c *CertificateClient) CertificateNames() []string
CertificateNames obtains a list of available certificates. It returns nil if the certificate names could not be fetched or there were no certificates.
type DataCenterClient ¶
type DataCenterClient struct {
*hcloud.DatacenterClient
}
DataCenterClient embeds the Hetzner Cloud DataCenter client and provides some additional helper functions.
func (*DataCenterClient) DataCenterNames ¶
func (c *DataCenterClient) DataCenterNames() []string
DataCenterNames obtains a list of available data centers. It returns nil if data center names could not be fetched.
type FirewallClient ¶ added in v1.21.0
type FirewallClient struct {
*hcloud.FirewallClient
}
FirewallClient embeds the Hetzner Cloud Firewall client and provides some additional helper functions.
func (*FirewallClient) FirewallLabelKeys ¶ added in v1.21.0
func (c *FirewallClient) FirewallLabelKeys(idOrName string) []string
FirewallLabelKeys returns a slice containing the keys of all labels assigned to the firewall with the passed idOrName.
func (*FirewallClient) FirewallNames ¶ added in v1.21.0
func (c *FirewallClient) FirewallNames() []string
FirewallNames obtains a list of available firewalls. It returns nil if the firewall names could not be fetched or there were no firewalls.
type FloatingIPClient ¶
type FloatingIPClient struct {
*hcloud.FloatingIPClient
}
FloatingIPClient embeds the Hetzner Cloud FloatingIP client and provides some additional helper functions.
func (*FloatingIPClient) FloatingIPLabelKeys ¶
func (c *FloatingIPClient) FloatingIPLabelKeys(idOrName string) []string
FloatingIPLabelKeys returns a slice containing the keys of all labels assigned to the Floating IP with the passed idOrName.
func (*FloatingIPClient) FloatingIPNames ¶
func (c *FloatingIPClient) FloatingIPNames() []string
FloatingIPNames obtains a list of available floating IPs. It returns nil if no floating IP names could be fetched or none were available.
type ISOClient ¶
ISOClient embeds the Hetzner Cloud ISO client and provides some additional helper functions.
type ImageClient ¶
type ImageClient struct {
*hcloud.ImageClient
}
ImageClient embeds the Hetzner Cloud Image client and provides some additional helper functions.
func (*ImageClient) ImageLabelKeys ¶
func (c *ImageClient) ImageLabelKeys(idOrName string) []string
ImageLabelKeys returns a slice containing the keys of all labels assigned to the Image with the passed idOrName.
func (*ImageClient) ImageNames ¶
func (c *ImageClient) ImageNames() []string
ImageNames obtains a list of available images. It returns nil if image names could not be fetched.
type LoadBalancerClient ¶
type LoadBalancerClient struct {
*hcloud.LoadBalancerClient
TypeClient *hcloud.LoadBalancerTypeClient
// contains filtered or unexported fields
}
LoadBalancerClient embeds the Hetzner Cloud Load Balancer client and provides some additional helper functions. As a convenience it references the type client as well and provides a unified interface to Load Balancers and their types.
func (*LoadBalancerClient) LoadBalancerLabelKeys ¶
func (c *LoadBalancerClient) LoadBalancerLabelKeys(idOrName string) []string
LoadBalancerLabelKeys returns a slice containing the keys of all labels assigned to the Load Balancer with the passed idOrName.
func (*LoadBalancerClient) LoadBalancerName ¶ added in v1.22.0
func (c *LoadBalancerClient) LoadBalancerName(id int) string
LoadBalancerName returns a Load Balancer's name given its id.
If a Load Balancer has no name the Load Balancer's id is returned converted to a string.
func (*LoadBalancerClient) LoadBalancerNames ¶
func (c *LoadBalancerClient) LoadBalancerNames() []string
LoadBalancerNames obtains a list of all available Load Balancer names. It returns nil if the names could not be fetched.
func (*LoadBalancerClient) LoadBalancerTypeNames ¶
func (c *LoadBalancerClient) LoadBalancerTypeNames() []string
LoadBalancerTypeNames returns a slice containing the names of all available Load Balancer types.
type LocationClient ¶
type LocationClient struct {
*hcloud.LocationClient
}
LocationClient embeds the Hetzner Cloud Location client and provides some additional helper functions.
func (*LocationClient) LocationNames ¶
func (c *LocationClient) LocationNames() []string
LocationNames obtains a list of available locations. It returns nil if location names could not be fetched.
type NetworkClient ¶
type NetworkClient struct {
*hcloud.NetworkClient
// contains filtered or unexported fields
}
NetworkClient embeds the Hetzner Cloud Network client and provides some additional helper functions.
func (*NetworkClient) NetworkLabelKeys ¶
func (c *NetworkClient) NetworkLabelKeys(idOrName string) []string
NetworkLabelKeys returns a slice containing the keys of all labels assigned to the Network with the passed idOrName.
func (*NetworkClient) NetworkName ¶
func (c *NetworkClient) NetworkName(id int) string
NetworkName obtains the name of the network with id. If the name could not be fetched it returns the value id converted to a string.
func (*NetworkClient) NetworkNames ¶
func (c *NetworkClient) NetworkNames() []string
NetworkNames obtains a list of available networks. It returns nil if the network names could not be fetched or if there are no networks.
type PlacementGroupClient ¶ added in v1.27.0
type PlacementGroupClient struct {
*hcloud.PlacementGroupClient
}
func (*PlacementGroupClient) PlacementGroupLabelKeys ¶ added in v1.27.0
func (c *PlacementGroupClient) PlacementGroupLabelKeys(idOrName string) []string
func (*PlacementGroupClient) PlacementGroupNames ¶ added in v1.27.0
func (c *PlacementGroupClient) PlacementGroupNames() []string
type SSHKeyClient ¶
type SSHKeyClient struct {
*hcloud.SSHKeyClient
}
SSHKeyClient embeds the Hetzner Cloud SSHKey client and provides some additional helper functions.
func (*SSHKeyClient) SSHKeyLabelKeys ¶
func (c *SSHKeyClient) SSHKeyLabelKeys(idOrName string) []string
SSHKeyLabelKeys returns a slice containing the keys of all labels assigned to the SSH Key with the passed idOrName.
func (*SSHKeyClient) SSHKeyNames ¶
func (c *SSHKeyClient) SSHKeyNames() []string
SSHKeyNames obtains a list of available SSH keys. It returns nil if SSH key names could not be fetched or none are available.
type ServerClient ¶
type ServerClient struct {
*hcloud.ServerClient
ServerTypes *hcloud.ServerTypeClient
// contains filtered or unexported fields
}
ServerClient embeds the Hetzner Cloud Server client and provides some additional helper functions.
func (*ServerClient) ServerLabelKeys ¶
func (c *ServerClient) ServerLabelKeys(idOrName string) []string
ServerLabelKeys returns a slice containing the keys of all labels assigned to the Server with the passed idOrName.
func (*ServerClient) ServerName ¶
func (c *ServerClient) ServerName(id int) string
ServerName obtains the name of the server with id. If the name could not be fetched it returns the value id converted to a string.
func (*ServerClient) ServerNames ¶
func (c *ServerClient) ServerNames() []string
ServerNames obtains a list of available servers. It returns nil if the server names could not be fetched or if there are no servers.
func (*ServerClient) ServerTypeNames ¶
func (c *ServerClient) ServerTypeNames() []string
ServerTypeNames returns a slice of all available server types.
type VolumeClient ¶
type VolumeClient struct {
*hcloud.VolumeClient
}
VolumeClient embeds the Hetzner Cloud Volume client and provides some additional helper functions.
func (*VolumeClient) VolumeLabelKeys ¶
func (c *VolumeClient) VolumeLabelKeys(idOrName string) []string
VolumeLabelKeys returns a slice containing the keys of all labels assigned to the Volume with the passed idOrName.
func (*VolumeClient) VolumeNames ¶
func (c *VolumeClient) VolumeNames() []string
VolumeNames obtains a list of available volumes for the current account. It returns nil if the current project has no volumes or the volume names could not be fetched.
Source Files