apiclient

Documentation

Index

• func ValidateMandatoryEnvironment(host string, apiKey string) error
• type Client
  • func (c *Client) Get(spaceScoped bool) (*octopusApiClient.Client, error)
• type ClientFactory
  • func NewFromEnvironment() (ClientFactory, error)

Functions

func ValidateMandatoryEnvironment

func ValidateMandatoryEnvironment(host string, apiKey string) error

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
}

func (*Client) Get

func (c *Client) Get(spaceScoped bool) (*octopusApiClient.Client, error)

type ClientFactory

type ClientFactory interface {
	Get(spaceScoped bool) (*octopusApiClient.Client, error)
}

func NewFromEnvironment

func NewFromEnvironment() (ClientFactory, error)

NewFromEnvironment Creates a new Client wrapper structure