proxyapi

Documentation

Index

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

Functions

func Get

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

Get returns information about a specific proxy

func List

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

List gets the list of proxies for a region

Types

type GetParams

type GetParams struct {
	*api.API
	ID     string
	Region 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 ListParams

type ListParams struct {
	*api.API
	Region string
}

ListParams is the set of parameters required for retrieving proxies

func (ListParams) Validate

func (params ListParams) Validate() error

Validate checks the parameters