package
2.0.1
Repository: https://github.com/gig-tech/ovc-sdk-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

GetLock returns when its safe to execute a synchronized action towards a certain vm.
NewClient returns an OpenVCloud API Client.
NewJWT returns a new JWT type supported identity providers: IYO (itsyou.online) Deprecated.
NewJWTFromIYO returns a new JWT type from a token string obtained from itsyou.online.
ReleaseLock free's access to execute a certain action towards a certain vm.
SetJWTPublicKey configure the public key used to verify JWT token.

# Constants

DataActionTimeout is used for actions that involve moving data.
DiskExposeProtocolNBD is a constant representing the storage protocol NBD (Network Block Device).
ModelActionTimeout is used for actions that only interfere with the model in the G8.
OperationalActionTimeout is used for actions that tamper with deploy resources.

# Variables

ErrAuthentication represents an authentication error from the server 401.
ErrClaimNotPresent represents an error where a claim was not found in the token.
ErrExpiredJWT represents an expired JWT error.
ErrInvalidJWT represents an invalid JWT error.
ErrNotFound represents a resource not found error from the server 404.

# Structs

Account contains.
AccountServiceOp handles communication with the account related methods of the OVC API.
Client struct.
CloudSpace contains all information related to a CloudSpace.
CloudSpaceConfig is used when creating a CloudSpace.
CloudSpaceDeleteConfig used to delete a CloudSpace.
CloudSpaceServiceOp handles communication with the cloudspace related methods of the OVC API.
Config used to connect to the API.
Credentials used to authenticate.
DiskAttachConfig is used when attatching a disk to a machine.
DiskConfig is used when creating a disk.
DiskDeleteConfig is used when deleting a disk.
DiskExposeConfig is used to request that a given disk is exposed via a given cloudspace and protocol.
DiskExposeInfo contains information on how to access a disk exposed using a given storage protocol.
DiskInfo contains all information related to a disk.
DiskServiceOp handles communication with the disk related methods of the OVC API.
DiskUnexposeConfig is used to request that a given exposed disk is exposed.
EmptyMachineConfig is used when creating a new "empty" machine.
ExternalNetworkConfig is used when getting an external network.
ExternalNetworkInfo contains information about the external network returned by API.
ExternalNetworkServiceOp handles communication with the external network related methods of the OVC API.
ForwardingServiceOp handles communication with the machine related methods of the OVC API.
ImageConfig is used when uploading an image.
ImageInfo contains information about the image returned by API.
ImageServiceOp handles communication with the image related methods of the OVC API.
IpsecConfig is used when creating/deleting/listing ipsec.
IpsecServiceOp handles communication with the ipsec related methods of the OVC API.
JWT represents a JWT.
LocationInfo represents the information of the location.
LocationServiceOp handles communication with the location related methods of the OVC API.
LogrusAdapter adapts a logrus.FieldLogger to the Logger interface.
MachineConfig is used when creating a machine.
MachineInfo contains all information related to a cloudspace.
MachineServiceOp handles communication with the machine related methods of the OVC API.
NBDDiskEndPointDescriptor contains NBD specific information on how to access a disk exposed as a Network Block Device.
PortForwardingConfig is used when creating a portforward.
PortForwardingInfo is returned when using the get method.
ResourceLimits contains all information related to resource limits.
Size contains all information related to a disk.
SizesServiceOp handles communication with the size related methods of the OVC API.
TemplateServiceOp handles communication with the image related methods of the OVC API.

# Interfaces

AccountService is an interface for interfacing with the Account endpoints of the OVC API.
CloudSpaceService is an interface for interfacing with the CloudSpace endpoints of the OVC API.
DiskEndPointDescriptor is an interface that a type representing a storage protocol endpoint shall implement to facilitate accessing protocol specific information in DiskExposeInfo.
DiskService is an interface for interfacing with the Disk endpoints of the OVC API.
ExternalNetworkService is an interface for interfacing with the external networks of the OVC API.
ForwardingService is an interface for interfacing with the portforwards endpoints of the OVC API.
ImageService is an interface for interfacing with the images of the OVC API.
IpsecService is an interface for interfacing with ipsec endpoints of the OVC API.
LocationService represents Location service interface.
Logger describes the logging interface.
MachineService is an interface for interfacing with the Machine endpoints of the OVC API.
SizesService is an interface for interfacing with the Sizes endpoints of the OVC API.
TemplateService is an interface for interfacing with the Images endpoints of the OVC API.

# Type aliases

AccountList is a list of accounts Returned when using the List method.
CloudSpaceList returns a list of CloudSpaces.
DiskList is a list of disks Returned when using the List method.
ExternalNetworkList is a list of external networks Returned when using the List method.
ImageList is a list of images Returned when using the List method.
IpsecList is a list of ipsec of a cloudspace Returned when using the List method.
LocationList represents a list of location info.
MachineList is a list of machines Returned when using the List method.
PortForwardingList is a list of portforwards Returned when using the List method.
ResponseTimeout for specific api requests.
SizesList is a list of sizes Returned when using the list method.
TemplateList is a list of templates Returned when using the List method.