clientcloudavenue

Documentation

Index

• func GetBearerToken() string
• func Init(opts *Opts) (err error)
• func ToError(e *APIErrorResponse) error
• type APIErrorResponse
  • func (e *APIErrorResponse) FormatError() string
• type Client
  • func New() (*Client, error)
  • func (v *Client) GetDebug() bool
  • func (v *Client) GetEndpoint() string
  • func (v *Client) GetOrganization() string
  • func (v *Client) GetOrganizationID() string
  • func (v *Client) GetURL() string
  • func (v *Client) GetUsername() string
• type Opts
  • func (o *Opts) Validate() error

Functions

func GetBearerToken

func GetBearerToken() string

GetBearerToken - Returns the bearer token

func Init

func Init(opts *Opts) (err error)

Init - Initializes the client

func ToError

func ToError(e *APIErrorResponse) error

ToError - Converts an APIErrorResponse to an error

Types

type APIErrorResponse

type APIErrorResponse struct {
	Code    string `json:"code"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}

func (*APIErrorResponse) FormatError

func (e *APIErrorResponse) FormatError() string

FormatError - Formats the error

type Client

type Client struct {
	*resty.Client
	Vmware   *govcd.VCDClient
	Org      *govcd.Org
	AdminOrg *govcd.AdminOrg
}

func New

func New() (*Client, error)

New creates a new cloudavenue client.

func (*Client) GetDebug

func (v *Client) GetDebug() bool

GetDebug - Returns the debug

func (*Client) GetEndpoint

func (v *Client) GetEndpoint() string

GetEndpoint - Returns the API endpoint

func (*Client) GetOrganization

func (v *Client) GetOrganization() string

GetOrganization - Returns the organization

func (*Client) GetOrganizationID

func (v *Client) GetOrganizationID() string

GetOrganizationID - Returns the organization ID

func (*Client) GetURL

func (v *Client) GetURL() string

GetURL - Returns the API endpoint

func (*Client) GetUsername

func (v *Client) GetUsername() string

GetUsername - Returns the username

type Opts

type Opts struct {
	URL        string `env:"URL,overwrite"`      // Computed from Org if not provided
	Username   string `env:"USERNAME,overwrite"` // Required
	Password   string `env:"PASSWORD,overwrite"` // Required
	Org        string `env:"ORG,overwrite"`      // Required
	VDC        string `env:"VDC,overwrite"`
	Debug      bool   `env:"DEBUG,overwrite"`
	VCDVersion string `env:"VCD_VERSION,overwrite,default=37.2"`
	Dev        bool   `env:"DEV,overwrite"` // Only for development
}

Opts - Is a struct that contains the options for the vmware client

func (*Opts) Validate

func (o *Opts) Validate() error