adapter

Documentation

Index

• Constants
• func IsBadRequestError(err error) bool
• type LocationAdapter
  • func NewHostsPoolLocationAdapter(client *api.Client, cfg config.Configuration) LocationAdapter
  • func NewHostsPoolLocationAdapterWithSSHFactory(client *api.Client, cfg config.Configuration, ...) LocationAdapter

Constants

const AdaptedLocationType = "hostspool"

AdaptedLocationType is the location target for adapter

Functions

func IsBadRequestError

func IsBadRequestError(err error) bool

IsBadRequestError checks if an error is an error due to a bad input

Types

type LocationAdapter

type LocationAdapter interface {
	CreateLocationConfiguration(locationName string, props config.DynamicMap) error
	GetLocationConfiguration(locationName string) (config.DynamicMap, error)
	SetLocationConfiguration(locationName string, props config.DynamicMap) error
	RemoveLocation(locationName string) error
	GetLocations() (map[string]config.DynamicMap, error)
	ListLocations() ([]string, error)
}

LocationAdapter interface represents the behaviour of a specific adapter for locations management

func NewHostsPoolLocationAdapter

func NewHostsPoolLocationAdapter(client *api.Client, cfg config.Configuration) LocationAdapter

NewHostsPoolLocationAdapter allows to create a new hostsPool location adapter

func NewHostsPoolLocationAdapterWithSSHFactory

func NewHostsPoolLocationAdapterWithSSHFactory(client *api.Client, cfg config.Configuration, sshClientFactory hostspool.SSHClientFactory) LocationAdapter

NewHostsPoolLocationAdapterWithSSHFactory creates a Location Adapter with a given ssh factory

Currently this is used for testing purpose to mock the ssh connection.