entities

Documentation

Index

• type AdminStatusType
  • func (a AdminStatusType) MarshalJSON() ([]byte, error)
  • func (a *AdminStatusType) UnmarshalJSON(b []byte) error
• type Connection
  • func (Connection) GetEntityId() string
• type DirectionType
  • func (d DirectionType) MarshalJSON() ([]byte, error)
  • func (d *DirectionType) UnmarshalJSON(b []byte) error
• type Entity
• type EntityCommon
• type Node
  • func (Node) GetEntityId() string
• type OperStatusType
  • func (o OperStatusType) MarshalJSON() ([]byte, error)
  • func (o *OperStatusType) UnmarshalJSON(b []byte) error

Types

type AdminStatusType

type AdminStatusType int

const (
	AdminStatusEnabled AdminStatusType = iota
	AdminStatusDeleted
)

func (AdminStatusType) MarshalJSON

func (a AdminStatusType) MarshalJSON() ([]byte, error)

MarshalJSON returns the string representation of AdminStatusType

func (*AdminStatusType) UnmarshalJSON

func (a *AdminStatusType) UnmarshalJSON(b []byte) error

UnmarshalJSON returns the appropriate AdminStatusType for parsed string

type Connection

type Connection struct {
	EntityCommon
	Active          bool                   `json:"active"`
	AdminStatus     AdminStatusType        `json:"adminStatus,string"`
	OperStatus      OperStatusType         `json:"operStatus,string"`
	Container       string                 `json:"container"`
	Opened          bool                   `json:"opened"`
	Host            string                 `json:"host"`
	Direction       DirectionType          `json:"dir,string"`
	Role            string                 `json:"role"`
	IsAuthenticated bool                   `json:"isAuthenticated"`
	IsEncrypted     bool                   `json:"isEncrypted"`
	Sasl            string                 `json:"sasl"`
	User            string                 `json:"user"`
	Ssl             bool                   `json:"ssl"`
	SslProto        string                 `json:"sslProto"`
	SslCipher       string                 `json:"sslCipher"`
	SslSsf          int                    `json:"sslSsf"`
	Tenant          string                 `json:"tenant"`
	Properties      map[string]interface{} `json:"properties"`
}

Connection represents a Dispatch Router connection

func (Connection) GetEntityId

func (Connection) GetEntityId() string

Implementation of Entity interface

type DirectionType

type DirectionType int

const (
	DirectionTypeIn DirectionType = iota
	DirectionTypeOut
)

func (DirectionType) MarshalJSON

func (d DirectionType) MarshalJSON() ([]byte, error)

MarshalJSON returns the string representation of DirectionType

func (*DirectionType) UnmarshalJSON

func (d *DirectionType) UnmarshalJSON(b []byte) error

UnmarshalJSON returns the appropriate DirectionType for parsed string

type Entity

type Entity interface {
	GetEntityId() string
}

Entity interface must be implemented by all entities

type EntityCommon

type EntityCommon struct {
	Name     string `json:"name"`
	Identity string `json:"identity"`
	Type     string `json:"type"`
}

EntityCommon represents the validation attributes of any Dispatch Router Entity

type Node

type Node struct {
	Id              string   `json:"id"`
	ProtocolVersion int      `json:"protocolVersion"`
	Instance        int      `json:"instance"`
	LinkState       []string `json:"linkState"`
	NextHop         string   `json:"nextHop"`
	ValidOrigins    []string `json:"validOrigins"`
	Address         string   `json:"address"`
	RouterLink      int      `json:"routerLink"`
	Cost            int      `json:"cost"`
	LastTopoChange  int      `json:"lastTopoChange"`
	Index           int      `json:"index"`
}

Node represents a Dispatch Router router.node entity

func (Node) GetEntityId

func (Node) GetEntityId() string

Implementation of the Entity interface

type OperStatusType

type OperStatusType int

const (
	OperStatusUp OperStatusType = iota
	OperStatusClosing
)

func (OperStatusType) MarshalJSON

func (o OperStatusType) MarshalJSON() ([]byte, error)

MarshalJSON returns the string representation of OperStatusType

func (*OperStatusType) UnmarshalJSON

func (o *OperStatusType) UnmarshalJSON(b []byte) error

UnmarshalJSON returns the appropriate OperStatusType for parsed string