Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// TODO this should be an interface rather than a struct, but this requires changing the SDK, we'll get round to that
// Octopus API Client not scoped to any space. nullable, lazily created by Get()
SystemClient *octopusApiClient.Client
// TODO this should be an interface rather than a struct, but this requires changing the SDK, we'll get round to that
// Octopus API Client scoped to the current space. nullable, lazily created by Get()
SpaceScopedClient *octopusApiClient.Client
// the Server URL, obtained from OCTOPUS_HOST
ApiUrl *url.URL
// the Octopus API Key, obtained from OCTOPUS_API_KEY
ApiKey string
// the Octopus Space to work within. Obtained from OCTOPUS_SPACE (TODO: or --space=XYZ on the command line??)
// Required for commands that need a space, but may be omitted for server-wide commands such as listing teams
Space string
}
type ClientFactory ¶
type ClientFactory interface {
Get(spaceScoped bool) (*octopusApiClient.Client, error)
}
func NewFromEnvironment ¶
func NewFromEnvironment() (ClientFactory, error)
Creates a new Client wrapper structure
Click to show internal directories.
Click to hide internal directories.