api

Documentation

Index

• type BytesUsage
• type Key
• type Limit
• type ServerAdminClient
  • func NewServerAdminClient(server, adminKey string) *ServerAdminClient
  • func (c *ServerAdminClient) ACLDelKey(key string) (err error)
  • func (c *ServerAdminClient) ACLDelUsage(key string) (err error)
  • func (c *ServerAdminClient) ACLGetLimit(key string) (l *Limit, err error)
  • func (c *ServerAdminClient) ACLGetUsage(key string) (usage *BytesUsage, err error)
  • func (c *ServerAdminClient) ACLNewKey(name string) (key string, err error)
  • func (c *ServerAdminClient) ACLPatchLimit(key string, l *Limit) (err error)
  • func (c *ServerAdminClient) ACLShow() (keys []Key, err error)
• type Stats

Types

type BytesUsage

type BytesUsage struct {
	In  uint64 `json:"in"`
	Out uint64 `json:"out"`
}

type Key

type Key struct {
	Name       string      `json:"name,omitempty"`
	Key        string      `json:"key"`
	Limit      *Limit      `json:"limit,omitempty"`
	BytesUsage *BytesUsage `json:"bytesUsage,omitempty"`
}

type Limit

type Limit struct {
	Bytes     string   `json:"bytes,omitempty"`
	InBytes   string   `json:"inBytes,omitempty"`
	OutBytes  string   `json:"outBytes,omitempty"`
	Whitelist []string `json:"whitelist,omitempty"`
	Blacklist []string `json:"blacklist,omitempty"`
}

type ServerAdminClient

type ServerAdminClient struct {
	// contains filtered or unexported fields
}

func NewServerAdminClient

func NewServerAdminClient(server, adminKey string) *ServerAdminClient

func (*ServerAdminClient) ACLDelKey

func (c *ServerAdminClient) ACLDelKey(key string) (err error)

func (*ServerAdminClient) ACLDelUsage

func (c *ServerAdminClient) ACLDelUsage(key string) (err error)

func (*ServerAdminClient) ACLGetLimit

func (c *ServerAdminClient) ACLGetLimit(key string) (l *Limit, err error)

func (*ServerAdminClient) ACLGetUsage

func (c *ServerAdminClient) ACLGetUsage(key string) (usage *BytesUsage, err error)

func (*ServerAdminClient) ACLNewKey

func (c *ServerAdminClient) ACLNewKey(name string) (key string, err error)

func (*ServerAdminClient) ACLPatchLimit

func (c *ServerAdminClient) ACLPatchLimit(key string, l *Limit) (err error)

func (*ServerAdminClient) ACLShow

func (c *ServerAdminClient) ACLShow() (keys []Key, err error)

type Stats

type Stats struct {
	BytesLimit    string              `json:"bytesLimit,omitempty"`
	InBytesLimit  string              `json:"inBytesLimit,omitempty"`
	OutBytesLimit string              `json:"outBytesLimit,omitempty"`
	BytesUsage    *BytesUsage         `json:"bytesUsage,omitempty"`
	Status        string              `json:"status"`
	Overlay       map[string][]string `json:"overlay"`
}