sifi

Documentation

Overview

Package sifi implements the go language bindings for the HyperCloud SIFI API. The bindings will support exactly one version of the API at a time, even though the data types for all currently supported versions can be found in the v* directories.

Index

• Constants
• type Client
  • func NewClient(o *client.Options) *Client
• type ResponseError
  • func NewErrorResponse(code int, err error, detail ...string) *ResponseError
  • func (e ResponseError) Error() string
  • func (e ResponseError) StatusCode() int

Constants

const (
	APIPrefix   = "/hypercloud-api" // APIPrefix is the prefix for all API paths.
	APIVersion  = "v3-preview"      // APIVersion is the prefix for all API paths (without the leading slash).
	PortNumber  = 7434              // PortNumber is the default port for `sifid` (sifi on a keypad).
	ServiceName = "sifid"           // ServiceName is the public name of the SIFI service.
)

Types

type Client

type Client struct {
	Cloud    *cloud.Service
	Metal    *metal.Service
	Snapshot *snapshot.Service

	*client.Client
}

Client is a connection to the SIFI service.

func NewClient

func NewClient(o *client.Options) *Client

NewClient returns a new client.

type ResponseError

type ResponseError struct {
	Code   int      `json:"code"`
	Text   string   `json:"error"`
	Detail []string `json:"detail"`
}

ResponseError is the response body for all error responses.

func NewErrorResponse

func NewErrorResponse(code int, err error, detail ...string) *ResponseError

NewErrorResponse returns a new ErrorResponse.

func (ResponseError) Error

func (e ResponseError) Error() string

Error implements the error interface for e.

func (ResponseError) StatusCode

func (e ResponseError) StatusCode() int

StatusCode returns the status code for e.