storage

package
v1.3.21 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2020 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Code generated by github.com/ukfast/sdk-go/pkg/gen/model_paginated. DO NOT EDIT.

Code generated by github.com/ukfast/sdk-go/pkg/gen/response. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetHostResponseBody 

type GetHostResponseBody struct {
	connection.APIResponseBody

	Data Host `json:"data"`
}

GetHostResponseBody represents an API response body containing Host data

type GetHostSetResponseBody added in v1.3.17 

type GetHostSetResponseBody struct {
	connection.APIResponseBody

	Data HostSet `json:"data"`
}

GetHostSetResponseBody represents an API response body containing HostSet data

type GetHostSetSliceResponseBody added in v1.3.17 

type GetHostSetSliceResponseBody struct {
	connection.APIResponseBody

	Data []HostSet `json:"data"`
}

GetHostSetSliceResponseBody represents an API response body containing []HostSet data

type GetHostSliceResponseBody added in v1.3.17 

type GetHostSliceResponseBody struct {
	connection.APIResponseBody

	Data []Host `json:"data"`
}

GetHostSliceResponseBody represents an API response body containing []Host data

type GetIOPSResponseBody added in v1.3.17 

type GetIOPSResponseBody struct {
	connection.APIResponseBody

	Data IOPS `json:"data"`
}

GetIOPSResponseBody represents an API response body containing IOPS data

type GetIOPSSliceResponseBody added in v1.3.17 

type GetIOPSSliceResponseBody struct {
	connection.APIResponseBody

	Data []IOPS `json:"data"`
}

GetIOPSSliceResponseBody represents an API response body containing []IOPS data

type GetSolutionResponseBody 

type GetSolutionResponseBody struct {
	connection.APIResponseBody

	Data Solution `json:"data"`
}

GetSolutionResponseBody represents an API response body containing Solution data

type GetSolutionSliceResponseBody added in v1.3.17 

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 GetVolumeSetResponseBody added in v1.3.17 

type GetVolumeSetResponseBody struct {
	connection.APIResponseBody

	Data VolumeSet `json:"data"`
}

GetVolumeSetResponseBody represents an API response body containing VolumeSet data

type GetVolumeSetSliceResponseBody added in v1.3.17 

type GetVolumeSetSliceResponseBody struct {
	connection.APIResponseBody

	Data []VolumeSet `json:"data"`
}

GetVolumeSetSliceResponseBody represents an API response body containing []VolumeSet data

type GetVolumeSliceResponseBody added in v1.3.17 

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

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 PaginatedHostSet 

type PaginatedHostSet struct {
	*connection.PaginatedBase

	Items []HostSet
}

PaginatedHostSet represents a paginated collection of HostSet

func NewPaginatedHostSet 

func NewPaginatedHostSet(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []HostSet) *PaginatedHostSet

NewPaginatedHostSet returns a pointer to an initialized PaginatedHostSet struct

type PaginatedIOPS 

type PaginatedIOPS struct {
	*connection.PaginatedBase

	Items []IOPS
}

PaginatedIOPS represents a paginated collection of IOPS

func NewPaginatedIOPS 

func NewPaginatedIOPS(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []IOPS) *PaginatedIOPS

NewPaginatedIOPS returns a pointer to an initialized PaginatedIOPS 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 PaginatedVolumeSet 

type PaginatedVolumeSet struct {
	*connection.PaginatedBase

	Items []VolumeSet
}

PaginatedVolumeSet represents a paginated collection of VolumeSet

func NewPaginatedVolumeSet 

func NewPaginatedVolumeSet(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []VolumeSet) *PaginatedVolumeSet

NewPaginatedVolumeSet returns a pointer to an initialized PaginatedVolumeSet 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

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

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

Source Files

View all Source files

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.