kvm

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• type Config
  • func DefaultConfig() Config
• type Response
  • func DefaultResponse() Response
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) Info(ctx context.Context) (*Response, error)

Constants

const (
	// Endpoint is the API endpoint of the service this client action interacts
	// with.
	Endpoint = "/v1/info/kvm/"
	// Name is the service name being implemented. This can be used for e.g.
	// logging.
	Name = "info/kvm"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	Logger     micrologger.Logger
	RestClient *resty.Client

	URL *url.URL
}

Config represents the configuration used to create a lister service.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new lister service by best effort.

type Response

type Response struct {
	General response.General `json:"general"`
	Workers response.Workers `json:"workers"`
}

Response is the return value of the service action.

func DefaultResponse

func DefaultResponse() Response

DefaultResponse provides a default response by best effort.

type Service

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

func New

func New(config Config) (*Service, error)

New creates a new configured lister service.

func (*Service) Info

func (s *Service) Info(ctx context.Context) (*Response, error)