proxy

Documentation

Index

• func Get(params GetParams) (*models.ProxyInfo, error)
• func List(params Params) (*models.ProxyOverview, error)
• type GetParams
  • func (params GetParams) Validate() error
• type Params
  • func (params Params) Validate() error

Functions

func Get

func Get(params GetParams) (*models.ProxyInfo, error)

Get returns information about a specific proxy

func List

func List(params Params) (*models.ProxyOverview, error)

List gets the list of proxies for a region

Types

type GetParams

type GetParams struct {
	Params
	ID string
}

GetParams is the set of parameters required for retrieving a proxy

func (GetParams) Validate

func (params GetParams) Validate() error

Validate checks the parameters

type Params

type Params struct {
	*api.API
}

Params is the generic set of parameters used for any proxy call

func (Params) Validate

func (params Params) Validate() error

Validate checks the parameters