storage

Documentation

Index

• type GetHostResponseBody
• type GetHostSliceResponseBody
• type GetSolutionResponseBody
• type GetSolutionSliceResponseBody
• type GetVolumeResponseBody
• type GetVolumeSliceResponseBody
• type Host
• type HostNotFoundError
  • func (e *HostNotFoundError) Error() string
• type HostSet
• type IOPS
• type PaginatedHost
  • func NewPaginatedHost(getFunc connection.PaginatedGetFunc, ...) *PaginatedHost
• type PaginatedSolution
  • func NewPaginatedSolution(getFunc connection.PaginatedGetFunc, ...) *PaginatedSolution
• type PaginatedVolume
  • func NewPaginatedVolume(getFunc connection.PaginatedGetFunc, ...) *PaginatedVolume
• type Service
  • func NewService(connection connection.Connection) *Service
  • func (s *Service) GetHost(hostID int) (Host, error)
  • func (s *Service) GetHosts(parameters connection.APIRequestParameters) ([]Host, error)
  • func (s *Service) GetHostsPaginated(parameters connection.APIRequestParameters) (*PaginatedHost, error)
  • func (s *Service) GetSolution(solutionID int) (Solution, error)
  • func (s *Service) GetSolutions(parameters connection.APIRequestParameters) ([]Solution, error)
  • func (s *Service) GetSolutionsPaginated(parameters connection.APIRequestParameters) (*PaginatedSolution, error)
  • func (s *Service) GetVolume(volumeID int) (Volume, error)
  • func (s *Service) GetVolumes(parameters connection.APIRequestParameters) ([]Volume, error)
  • func (s *Service) GetVolumesPaginated(parameters connection.APIRequestParameters) (*PaginatedVolume, error)
• type Solution
• type SolutionNotFoundError
  • func (e *SolutionNotFoundError) Error() string
• type StorageService
• type Volume
• type VolumeNotFoundError
  • func (e *VolumeNotFoundError) Error() string
• type VolumeSet

Types

type GetHostResponseBody

type GetHostResponseBody struct {
	connection.APIResponseBody
	Data Host `json:"data"`
}

GetHostResponseBody represents an API response body containing Host data

type GetHostSliceResponseBody

type GetHostSliceResponseBody struct {
	connection.APIResponseBody
	Data []Host `json:"data"`
}

GetHostSliceResponseBody represents an API response body containing []Host data

type GetSolutionResponseBody

type GetSolutionResponseBody struct {
	connection.APIResponseBody
	Data Solution `json:"data"`
}

GetSolutionResponseBody represents an API response body containing Solution data

type GetSolutionSliceResponseBody

type GetSolutionSliceResponseBody struct {
	connection.APIResponseBody
	Data []Solution `json:"data"`
}

GetSolutionSliceResponseBody represents an API response body containing []Solution data

type GetVolumeResponseBody

type GetVolumeResponseBody struct {
	connection.APIResponseBody
	Data Volume `json:"data"`
}

GetVolumeResponseBody represents an API response body containing Volume data

type GetVolumeSliceResponseBody

type GetVolumeSliceResponseBody struct {
	connection.APIResponseBody
	Data []Volume `json:"data"`
}

GetVolumeSliceResponseBody represents an API response body containing []Volume data

type Host

type Host struct {
	ID         int                 `json:"id"`
	Name       string              `json:"name"`
	OSType     string              `json:"os_type"`
	IQN        string              `json:"iqn"`
	ServerID   int                 `json:"server_id"`
	Status     string              `json:"status"`
	SolutionID int                 `json:"solution_id"`
	CreatedAt  connection.DateTime `json:"created_at"`
	UpdatedAt  connection.DateTime `json:"updated_at"`
}

Host represents a host +genie:model_response +genie:model_paginated

type HostNotFoundError

type HostNotFoundError struct {
	ID int
}

HostNotFoundError indicates a virtual machine was not found

func (*HostNotFoundError) Error

func (e *HostNotFoundError) Error() string

type HostSet

type HostSet struct {
	ID         int                 `json:"id"`
	Name       string              `json:"name"`
	SolutionID int                 `json:"solution_id"`
	CreatedAt  connection.DateTime `json:"created_at"`
	UpdatedAt  connection.DateTime `json:"updated_at"`
}

HostSet represents a host set

type IOPS

type IOPS struct {
	ID    int    `json:"id"`
	Name  string `json:"name"`
	Limit int    `json:"limit"`
}

IOPS represents an IOPS tier

type PaginatedHost

type PaginatedHost struct {
	*connection.PaginatedBase
	Items []Host
}

PaginatedHost represents a paginated collection of Host

func NewPaginatedHost

func NewPaginatedHost(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Host) *PaginatedHost

NewPaginatedHost returns a pointer to an initialized PaginatedHost struct

type PaginatedSolution

type PaginatedSolution struct {
	*connection.PaginatedBase
	Items []Solution
}

PaginatedSolution represents a paginated collection of Solution

func NewPaginatedSolution

func NewPaginatedSolution(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Solution) *PaginatedSolution

NewPaginatedSolution returns a pointer to an initialized PaginatedSolution struct

type PaginatedVolume

type PaginatedVolume struct {
	*connection.PaginatedBase
	Items []Volume
}

PaginatedVolume represents a paginated collection of Volume

func NewPaginatedVolume

func NewPaginatedVolume(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Volume) *PaginatedVolume

NewPaginatedVolume returns a pointer to an initialized PaginatedVolume struct

type Service

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

Service implements StorageService for managing Storage certificates via the UKFast API

func NewService

func NewService(connection connection.Connection) *Service

NewService returns a new instance of StorageService

func (*Service) GetHost

func (s *Service) GetHost(hostID int) (Host, error)

GetHost retrieves a single host by id

func (*Service) GetHosts

func (s *Service) GetHosts(parameters connection.APIRequestParameters) ([]Host, error)

GetHosts retrieves a list of hosts

func (*Service) GetHostsPaginated

func (s *Service) GetHostsPaginated(parameters connection.APIRequestParameters) (*PaginatedHost, error)

GetHostsPaginated retrieves a paginated list of hosts

func (*Service) GetSolution

func (s *Service) GetSolution(solutionID int) (Solution, error)

GetSolution retrieves a single solution by id

func (*Service) GetSolutions

func (s *Service) GetSolutions(parameters connection.APIRequestParameters) ([]Solution, error)

GetSolutions retrieves a list of solutions

func (*Service) GetSolutionsPaginated

func (s *Service) GetSolutionsPaginated(parameters connection.APIRequestParameters) (*PaginatedSolution, error)

GetSolutionsPaginated retrieves a paginated list of solutions

func (*Service) GetVolume

func (s *Service) GetVolume(volumeID int) (Volume, error)

GetVolume retrieves a single volume by id

func (*Service) GetVolumes

func (s *Service) GetVolumes(parameters connection.APIRequestParameters) ([]Volume, error)

GetVolumes retrieves a list of volumes

func (*Service) GetVolumesPaginated

func (s *Service) GetVolumesPaginated(parameters connection.APIRequestParameters) (*PaginatedVolume, error)

GetVolumesPaginated retrieves a paginated list of volumes

type Solution

type Solution struct {
	ID        int                 `json:"id"`
	Name      string              `json:"name"`
	SanID     int                 `json:"san_id"`
	CreatedAt connection.DateTime `json:"created_at"`
	UpdatedAt connection.DateTime `json:"updated_at"`
}

Solution represents a solution +genie:model_response +genie:model_paginated

type SolutionNotFoundError

type SolutionNotFoundError struct {
	ID int
}

SolutionNotFoundError indicates a virtual machine was not found

func (*SolutionNotFoundError) Error

func (e *SolutionNotFoundError) Error() string

type StorageService

type StorageService interface {
	GetSolutions(parameters connection.APIRequestParameters) ([]Solution, error)
	GetSolutionsPaginated(parameters connection.APIRequestParameters) (*PaginatedSolution, error)
	GetSolution(certificateID int) (Solution, error)
	GetHosts(parameters connection.APIRequestParameters) ([]Host, error)
	GetHostsPaginated(parameters connection.APIRequestParameters) (*PaginatedHost, error)
	GetHost(hostID int) (Host, error)
	GetVolumes(parameters connection.APIRequestParameters) ([]Volume, error)
	GetVolumesPaginated(parameters connection.APIRequestParameters) (*PaginatedVolume, error)
	GetVolume(volumeID int) (Volume, error)
}

StorageService is an interface for managing UKFast Storage

type Volume

type Volume struct {
	ID         int                 `json:"id"`
	Name       string              `json:"name"`
	WWN        string              `json:"wwn"`
	SizeGB     int                 `json:"size_gb"`
	Status     string              `json:"status"`
	SolutionID int                 `json:"solution_id"`
	CreatedAt  connection.DateTime `json:"created_at"`
	UpdatedAt  connection.DateTime `json:"updated_at"`
}

Volume represents a volume +genie:model_response +genie:model_paginated

type VolumeNotFoundError

type VolumeNotFoundError struct {
	ID int
}

VolumeNotFoundError indicates a virtual machine was not found

func (*VolumeNotFoundError) Error

func (e *VolumeNotFoundError) Error() string

type VolumeSet

type VolumeSet struct {
	ID         int                 `json:"id"`
	SolutionID int                 `json:"solution_id"`
	MaxIOPS    int                 `json:"max_iops"`
	CreatedAt  connection.DateTime `json:"created_at"`
	UpdatedAt  connection.DateTime `json:"updated_at"`
}

VolumeSet represents a volume set