Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

clientbase

package

Go to main page

Versions in this module

v0

v0.5.1

Nov 25, 2024

v0.5.0

Nov 15, 2024

v0.4.0

Nov 15, 2024

v0.3.0

Nov 15, 2024

Changes in this version

type ClientOpts

+ ProxyURL string

v0.2.0

Nov 15, 2024

v0.1.0

Nov 15, 2024

Changes in this version

+ const COLLECTION

+ const SELF

+ var Debug = false

+ func IsNotFound(err error) bool

+ func NewListOpts() *types.ListOpts

+ type APIBaseClient struct

+ Ops *APIOperations

+ Opts *ClientOpts

+ Types map[string]types.Schema

+ func NewAPIClient(opts *ClientOpts) (APIBaseClient, error)

+ func (a *APIBaseClient) Action(schemaType string, action string, existing *types.Resource, ...) error

+ func (a *APIBaseClient) ByID(schemaType string, id string, respObject interface{}) error

+ func (a *APIBaseClient) Create(schemaType string, createObj interface{}, respObject interface{}) error

+ func (a *APIBaseClient) Delete(existing *types.Resource) error

+ func (a *APIBaseClient) GetLink(resource types.Resource, link string, respObject interface{}) error

+ func (a *APIBaseClient) List(schemaType string, opts *types.ListOpts, respObject interface{}) error

+ func (a *APIBaseClient) Post(url string, createObj interface{}, respObject interface{}) error

+ func (a *APIBaseClient) Reload(existing *types.Resource, output interface{}) error

+ func (a *APIBaseClient) Replace(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ func (a *APIBaseClient) Update(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ func (a *APIBaseClient) Websocket(url string, headers map[string][]string) (*websocket.Conn, *http.Response, error)

+ type APIBaseClientInterface interface

+ Action func(schemaType string, action string, existing *types.Resource, ...) error

+ ByID func(schemaType string, id string, respObject interface{}) error

+ Create func(schemaType string, createObj interface{}, respObject interface{}) error

+ Delete func(existing *types.Resource) error

+ GetLink func(resource types.Resource, link string, respObject interface{}) error

+ List func(schemaType string, opts *types.ListOpts, respObject interface{}) error

+ Post func(url string, createObj interface{}, respObject interface{}) error

+ Reload func(existing *types.Resource, output interface{}) error

+ Replace func(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ Update func(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ Websocket func(url string, headers map[string][]string) (*websocket.Conn, *http.Response, error)

+ type APIError struct

+ Body string

+ Msg string

+ Status string

+ StatusCode int

+ URL string

+ func NewAPIError(resp *http.Response, url string) *APIError

+ func (e *APIError) Error() string

+ type APIOperations struct

+ Client *http.Client

+ Dialer *websocket.Dialer

+ Opts *ClientOpts

+ Types map[string]types.Schema

+ func (a *APIOperations) DoAction(schemaType string, action string, existing *types.Resource, ...) error

+ func (a *APIOperations) DoByID(schemaType string, id string, respObject interface{}) error

+ func (a *APIOperations) DoCollectionAction(schemaType string, action string, existing *types.Collection, ...) error

+ func (a *APIOperations) DoCreate(schemaType string, createObj interface{}, respObject interface{}) error

+ func (a *APIOperations) DoDelete(url string) error

+ func (a *APIOperations) DoGet(url string, opts *types.ListOpts, respObject interface{}) error

+ func (a *APIOperations) DoList(schemaType string, opts *types.ListOpts, respObject interface{}) error

+ func (a *APIOperations) DoModify(method string, url string, createObj interface{}, respObject interface{}) error

+ func (a *APIOperations) DoNext(nextURL string, respObject interface{}) error

+ func (a *APIOperations) DoReplace(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ func (a *APIOperations) DoResourceDelete(schemaType string, existing *types.Resource) error

+ func (a *APIOperations) DoUpdate(schemaType string, existing *types.Resource, updates interface{}, ...) error

+ func (a *APIOperations) SetupRequest(req *http.Request)

+ type ClientOpts struct

+ AccessKey string

+ CACerts string

+ HTTPClient *http.Client

+ Insecure bool

+ SecretKey string

+ Timeout time.Duration

+ TokenKey string

+ URL string

+ WSDialer *websocket.Dialer