entities

Documentation

Index

• type Address
  • func (Address) GetEntityId() string
• type AdminStatusType
  • func (a AdminStatusType) MarshalJSON() ([]byte, error)
  • func (a *AdminStatusType) UnmarshalJSON(b []byte) error
• type AutoLink
  • func (AutoLink) GetEntityId() string
• type AutoLinkOperStatusType
  • func (o AutoLinkOperStatusType) MarshalJSON() ([]byte, error)
  • func (o *AutoLinkOperStatusType) UnmarshalJSON(b []byte) error
• type ConnOperStatusType
  • func (o ConnOperStatusType) MarshalJSON() ([]byte, error)
  • func (o *ConnOperStatusType) UnmarshalJSON(b []byte) error
• type Connection
  • func (Connection) GetEntityId() string
• type ConnectionStatusType
  • func (a ConnectionStatusType) MarshalJSON() ([]byte, error)
  • func (a *ConnectionStatusType) UnmarshalJSON(b []byte) error
• type Connector
  • func (Connector) GetEntityId() string
• type DistributionType
  • func (d DistributionType) MarshalJSON() ([]byte, error)
  • func (d *DistributionType) UnmarshalJSON(b []byte) error
• type Entity
• type EntityCommon
• type LinkDistributionType
  • func (d LinkDistributionType) MarshalJSON() ([]byte, error)
  • func (d *LinkDistributionType) UnmarshalJSON(b []byte) error
• type LinkRoute
  • func (LinkRoute) GetEntityId() string
• type LinkRouteOperStatusType
  • func (d LinkRouteOperStatusType) MarshalJSON() ([]byte, error)
  • func (d *LinkRouteOperStatusType) UnmarshalJSON(b []byte) error
• type Listener
  • func (Listener) GetEntityId() string
• type Node
  • func (Node) GetEntityId() string
• type SslProfile
  • func (SslProfile) GetEntityId() string
• type StripAnnotationsType
  • func (d StripAnnotationsType) MarshalJSON() ([]byte, error)
  • func (d *StripAnnotationsType) UnmarshalJSON(b []byte) error

Types

type Address

type Address struct {
	EntityCommon
	Prefix         string           `json:"prefix"`
	Pattern        string           `json:"pattern"`
	Distribution   DistributionType `json:"distribution,string"`
	Waypoint       bool             `json:"waypoint"`
	IngressPhase   int              `json:"ingressPhase"`
	EgressPhase    int              `json:"egressPhase"`
	Priority       int              `json:"priority"`
	EnableFallback bool             `json:"enableFallback"`
}

Address represents a Dispatch Router address

func (Address) GetEntityId

func (Address) GetEntityId() string

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 AutoLink

type AutoLink struct {
	EntityCommon
	Address         string                 `json:"address"`
	Direction       common.DirectionType   `json:"direction,string"`
	Phase           int                    `json:"phase"`
	ContainerId     string                 `json:"containerId"`
	Connection      string                 `json:"connection"`
	ExternalAddress string                 `json:"externalAddress"`
	Fallback        bool                   `json:"fallback"`
	LinkRef         string                 `json:"linkRef"`
	OperStatus      AutoLinkOperStatusType `json:"operStatus,string"`
	LastError       string                 `json:"lastError"`
}

func (AutoLink) GetEntityId

func (AutoLink) GetEntityId() string

type AutoLinkOperStatusType

type AutoLinkOperStatusType int

const (
	AutoLinkOperStatusInactive AutoLinkOperStatusType = iota
	AutoLinkOperStatusAttaching
	AutoLinkOperStatusFailed
	AutoLinkOperStatusActive
	AutoLinkOperStatusQuiescing
	AutoLinkOperStatusIdle
)

func (AutoLinkOperStatusType) MarshalJSON

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

MarshalJSON returns the string representation of AutoLinkOperStatusType

func (*AutoLinkOperStatusType) UnmarshalJSON

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

UnmarshalJSON returns the appropriate AutoLinkOperStatusType for parsed string

type ConnOperStatusType

type ConnOperStatusType int

const (
	ConnOperStatusUp ConnOperStatusType = iota
	ConnOperStatusClosing
)

func (ConnOperStatusType) MarshalJSON

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

MarshalJSON returns the string representation of ConnOperStatusType

func (*ConnOperStatusType) UnmarshalJSON

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

UnmarshalJSON returns the appropriate ConnOperStatusType for parsed string

type Connection

type Connection struct {
	EntityCommon
	Active          bool                   `json:"active"`
	AdminStatus     AdminStatusType        `json:"adminStatus,string"`
	OperStatus      ConnOperStatusType     `json:"operStatus,string"`
	Container       string                 `json:"container"`
	Opened          bool                   `json:"opened"`
	Host            string                 `json:"host"`
	Direction       common.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 ConnectionStatusType

type ConnectionStatusType int

const (
	ConnectionStatusConnecting ConnectionStatusType = iota
	ConnectionStatusSuccess
	ConnectionStatusFailed
)

func (ConnectionStatusType) MarshalJSON

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

MarshalJSON returns the string representation of ConnectionStatusType

func (*ConnectionStatusType) UnmarshalJSON

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

UnmarshalJSON returns the appropriate ConnectionStatusType for parsed string

type Connector

type Connector struct {
	EntityCommon
	Host                     string                         `json:"host"`
	Port                     string                         `json:"port"`
	ProtocolFamily           common.SocketAddressFamilyType `json:"protocolFamily,string"`
	Role                     common.RoleType                `json:"role,string"`
	Cost                     int                            `json:"cost"`
	SslProfile               string                         `json:"sslProfile"`
	SaslMechanisms           string                         `json:"saslMechanisms"`
	AllowRedirect            bool                           `json:"allowRedirect"`
	MaxFrameSize             int                            `json:"maxFrameSize"`
	MaxSessionFrames         int                            `json:"maxSessionFrames"`
	IdleSecondsTimeout       int                            `json:"idleSecondsTimeout"`
	StripAnnotations         StripAnnotationsType           `json:"stripAnnotations,string"`
	LinkCapacity             int                            `json:"linkCapacity"`
	VerifyHostname           bool                           `json:"verifyHostname"`
	SaslUsername             string                         `json:"saslUsername"`
	SaslPassword             string                         `json:"saslPassword"`
	MessageLoggingComponents string                         `json:"messageLoggingComponents"`
	FailoverUrls             string                         `json:"failoverUrls"`
	ConnectionStatus         ConnectionStatusType           `json:"connectionStatus,string"`
	ConnectionMsg            string                         `json:"connectionMsg"`
	PolicyVhost              string                         `json:"policyVhost"`
}

func (Connector) GetEntityId

func (Connector) GetEntityId() string

type DistributionType

type DistributionType int

const (
	DistributionMulticast DistributionType = iota
	DistributionClosest
	DistributionBalanced
	DistributionUnavailable
)

func (DistributionType) MarshalJSON

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

MarshalJSON returns the string represenation of DistributionType

func (*DistributionType) UnmarshalJSON

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

Unmarshal JSON return the appropriate DistributionType 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 common attributes of any Dispatch Router Entity

type LinkDistributionType

type LinkDistributionType int

const (
	LinkDistributionBalanced LinkDistributionType = iota
)

func (LinkDistributionType) MarshalJSON

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

MarshalJSON returns the string represenation of LinkDistributionType

func (*LinkDistributionType) UnmarshalJSON

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

Unmarshal JSON return the appropriate LinkDistributionType for parsed string

type LinkRoute

type LinkRoute struct {
	EntityCommon
	Prefix            string                  `json:"prefix"`
	Pattern           string                  `json:"pattern"`
	AddExternalPrefix string                  `json:"addExternalPrefix"`
	DelExternalPrefix string                  `json:"delExternalPrefix"`
	ContainerId       string                  `json:"containerId"`
	Connection        string                  `json:"connection"`
	Distribution      LinkDistributionType    `json:"distribution,string"`
	Direction         common.DirectionType    `json:"direction,string"`
	OperStatus        LinkRouteOperStatusType `json:"operStatus,string"`
}

func (LinkRoute) GetEntityId

func (LinkRoute) GetEntityId() string

type LinkRouteOperStatusType

type LinkRouteOperStatusType int

const (
	LinkRouteOperStatusInactive LinkRouteOperStatusType = iota
	LinkRouteOperStatusActive
)

func (LinkRouteOperStatusType) MarshalJSON

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

MarshalJSON returns the string represenation of LinkRouteOperStatusType

func (*LinkRouteOperStatusType) UnmarshalJSON

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

Unmarshal JSON return the appropriate LinkRouteOperStatusType for parsed string

type Listener

type Listener struct {
	EntityCommon
	Host                           string                         `json:"host"`
	Port                           string                         `json:"port"`
	SocketAddressFamily            common.SocketAddressFamilyType `json:"socketAddressFamily,string"`
	Role                           common.RoleType                `json:"role,string"`
	Cost                           int                            `json:"cost"`
	SslProfile                     string                         `json:"sslProfile"`
	SaslMechanisms                 string                         `json:"saslMechanisms"`
	AuthenticatePeer               bool                           `json:"authenticatePeer"`
	SaslPlugin                     string                         `json:"saslPlugin"`
	RequireEncryption              bool                           `json:"requireEncryption"`
	RequireSsl                     bool                           `json:"requireSsl"`
	TrustedCertsFile               string                         `json:"trustedCertsFile"`
	MaxFrameSize                   int                            `json:"maxFrameSize"`
	MaxSessions                    int                            `json:"maxSessions"`
	MaxSessionFrames               int                            `json:"maxSessionFrames"`
	IdleTimeoutSeconds             int                            `json:"idleTimeoutSeconds"`
	InitialHandshakeTimeoutSeconds int                            `json:"initialHandshakeTimeoutSeconds"`
	StripAnnotations               StripAnnotationsType           `json:"stripAnnotations,string"`
	LinkCapacity                   int                            `json:"linkCapacity"`
	MultiTenant                    bool                           `json:"multiTenant"`
	FailoverUrls                   string                         `json:"failoverUrls"`
	Healthz                        bool                           `json:"healthz"`
	Metrics                        bool                           `json:"metrics"`
	Websockets                     bool                           `json:"websockets"`
	Http                           bool                           `json:"http"`
	HttpRootDir                    string                         `json:"httpRootDir"`
	MessageLoggingComponents       string                         `json:"messageLoggingComponents"`
	PolicyVhost                    string                         `json:"policyVhost"`
}

func (Listener) GetEntityId

func (Listener) GetEntityId() string

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 SslProfile

type SslProfile struct {
	EntityCommon
	Ciphers            string `json:"ciphers"`
	Protocols          string `json:"protocols"`
	CaCertFile         string `json:"caCertFile"`
	CertFile           string `json:"certFile"`
	PrivateKeyFile     string `json:"privateKeyFile"`
	PasswordFile       string `json:"passwordFile"`
	Password           string `json:"password"`
	UidFormat          string `json:"uidFormat"`
	UidNameMappingFile string `json:"uidNameMappingFile"`
}

func (SslProfile) GetEntityId

func (SslProfile) GetEntityId() string

type StripAnnotationsType

type StripAnnotationsType int

const (
	StripAnnotationsTypeIn StripAnnotationsType = iota
	StripAnnotationsTypeOut
	StripAnnotationsTypeBoth
	StripAnnotationsTypeNo
)

func (StripAnnotationsType) MarshalJSON

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

MarshalJSON returns the string representation of StripAnnotationsType

func (*StripAnnotationsType) UnmarshalJSON

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

UnmarshalJSON returns the appropriate StripAnnotationsType for parsed string