api

Documentation

Index

• func DeleteEntitiesOfType(api util.API, o *Options, entityType string, ids []string, body string) error
• func DeleteEntityOfTypeWhere(api util.API, options *Options, entityType string, body string) error
• func GetJsonBool(container *gabs.Container, path string) bool
• func GetJsonString(container *gabs.Container, path string) string
• func GetJsonValue(container *gabs.Container, path string) interface{}
• func GetPlural(entityType string) string
• func MapNameToID(api util.API, entityType string, o *Options, idOrName string) (string, error)
• func MapNamesToIDs(api util.API, entityType string, o *Options, list ...string) ([]string, error)
• func NewWsMgmtChannel(bindHandler channel.BindHandler) (channel.Channel, error)
• func RenderTable(o *Options, t table.Writer, pagingInfo *Paging)
• func SetJSONValue(container *gabs.Container, value interface{}, path ...string)
• func SetTags(container *gabs.Container, tags map[string]string, tagsJson string, ...)
• type EntityOptions
  • func NewEntityOptions(out, errOut io.Writer) EntityOptions
  • func (self *EntityOptions) AddCommonFlags(cmd *cobra.Command)
  • func (self *EntityOptions) GetTags() map[string]interface{}
  • func (self *EntityOptions) SetTags(container *gabs.Container)
  • func (self *EntityOptions) TagsProvided() bool
• type Gabs2Wrapper
  • func Wrap2(c *gabs2.Container) *Gabs2Wrapper
  • func (self *Gabs2Wrapper) Bool(path string) bool
  • func (self *Gabs2Wrapper) Float64(path string) float64
  • func (self *Gabs2Wrapper) String(path string) string
  • func (self *Gabs2Wrapper) StringSlice(path string) []string
• type GabsWrapper
  • func Wrap(c *gabs.Container) *GabsWrapper
  • func (self *GabsWrapper) Bool(path string) bool
  • func (self *GabsWrapper) Float64(path string) float64
  • func (self *GabsWrapper) String(path string) string
  • func (self *GabsWrapper) StringSlice(path string) []string
• type Options
  • func (options *Options) AddCommonFlags(cmd *cobra.Command)
  • func (options *Options) ErrOutputWriter() io.Writer
  • func (options *Options) LogCreateResult(entityType string, result *gabs.Container, err error) error
  • func (options *Options) OutputRequestJson() bool
  • func (options *Options) OutputResponseJson() bool
  • func (options *Options) OutputWriter() io.Writer
• type Paging
  • func FilterEntitiesOfType(api util.API, entityType string, filter string, logJSON bool, out io.Writer, ...) ([]*gabs.Container, *Paging, error)
  • func GetPaging(c *gabs.Container) *Paging
  • func ListEntitiesOfType(api util.API, entityType string, params url.Values, logJSON bool, ...) ([]*gabs.Container, *Paging, error)
  • func ListEntitiesWithOptions(api util.API, entityType string, options *Options) ([]*gabs.Container, *Paging, error)
  • func (p *Paging) Output(o *Options)

Functions

func DeleteEntitiesOfType

func DeleteEntitiesOfType(api util.API, o *Options, entityType string, ids []string, body string) error

func DeleteEntityOfTypeWhere

func DeleteEntityOfTypeWhere(api util.API, options *Options, entityType string, body string) error

DeleteEntityOfTypeWhere implements the commands to delete various entity types

func GetJsonBool

func GetJsonBool(container *gabs.Container, path string) bool

func GetJsonString

func GetJsonString(container *gabs.Container, path string) string

func GetJsonValue

func GetJsonValue(container *gabs.Container, path string) interface{}

func GetPlural

func GetPlural(entityType string) string

func MapNameToID

func MapNameToID(api util.API, entityType string, o *Options, idOrName string) (string, error)

func MapNamesToIDs

func MapNamesToIDs(api util.API, entityType string, o *Options, list ...string) ([]string, error)

func NewWsMgmtChannel

func NewWsMgmtChannel(bindHandler channel.BindHandler) (channel.Channel, error)

func RenderTable

func RenderTable(o *Options, t table.Writer, pagingInfo *Paging)

func SetJSONValue

func SetJSONValue(container *gabs.Container, value interface{}, path ...string)

func SetTags

func SetTags(container *gabs.Container, tags map[string]string, tagsJson string, path ...string)

Types

type EntityOptions

type EntityOptions struct {
	Options
	Tags     map[string]string
	TagsJson string
}

func NewEntityOptions

func NewEntityOptions(out, errOut io.Writer) EntityOptions

func (*EntityOptions) AddCommonFlags

func (self *EntityOptions) AddCommonFlags(cmd *cobra.Command)

func (*EntityOptions) GetTags

func (self *EntityOptions) GetTags() map[string]interface{}

func (*EntityOptions) SetTags

func (self *EntityOptions) SetTags(container *gabs.Container)

func (*EntityOptions) TagsProvided

func (self *EntityOptions) TagsProvided() bool

type Gabs2Wrapper

type Gabs2Wrapper struct {
	*gabs2.Container
}

func Wrap2

func Wrap2(c *gabs2.Container) *Gabs2Wrapper

func (*Gabs2Wrapper) Bool

func (self *Gabs2Wrapper) Bool(path string) bool

func (*Gabs2Wrapper) Float64

func (self *Gabs2Wrapper) Float64(path string) float64

func (*Gabs2Wrapper) String

func (self *Gabs2Wrapper) String(path string) string

func (*Gabs2Wrapper) StringSlice

func (self *Gabs2Wrapper) StringSlice(path string) []string

type GabsWrapper

type GabsWrapper struct {
	*gabs.Container
}

func Wrap

func Wrap(c *gabs.Container) *GabsWrapper

func (*GabsWrapper) Bool

func (self *GabsWrapper) Bool(path string) bool

func (*GabsWrapper) Float64

func (self *GabsWrapper) Float64(path string) float64

func (*GabsWrapper) String

func (self *GabsWrapper) String(path string) string

func (*GabsWrapper) StringSlice

func (self *GabsWrapper) StringSlice(path string) []string

type Options

type Options struct {
	common.CommonOptions
	OutputJSONRequest  bool
	OutputJSONResponse bool
	OutputCSV          bool
}

Options are common options for edge controller commands

func (*Options) AddCommonFlags

func (options *Options) AddCommonFlags(cmd *cobra.Command)

func (*Options) ErrOutputWriter

func (options *Options) ErrOutputWriter() io.Writer

func (*Options) LogCreateResult

func (options *Options) LogCreateResult(entityType string, result *gabs.Container, err error) error

func (*Options) OutputRequestJson

func (options *Options) OutputRequestJson() bool

func (*Options) OutputResponseJson

func (options *Options) OutputResponseJson() bool

func (*Options) OutputWriter

func (options *Options) OutputWriter() io.Writer

type Paging

type Paging struct {
	Limit  int64
	Offset int64
	Count  int64
	errorz.ErrorHolderImpl
}

func FilterEntitiesOfType

func FilterEntitiesOfType(api util.API, entityType string, filter string, logJSON bool, out io.Writer, timeout int, verbose bool) ([]*gabs.Container, *Paging, error)

func GetPaging

func GetPaging(c *gabs.Container) *Paging

func ListEntitiesOfType

func ListEntitiesOfType(api util.API, entityType string, params url.Values, logJSON bool, out io.Writer, timeout int, verbose bool) ([]*gabs.Container, *Paging, error)

ListEntitiesOfType queries the Ziti Controller for entities of the given type

func ListEntitiesWithOptions

func ListEntitiesWithOptions(api util.API, entityType string, options *Options) ([]*gabs.Container, *Paging, error)

ListEntitiesOfType queries the Ziti Controller for entities of the given type

func (*Paging) Output

func (p *Paging) Output(o *Options)