client

Documentation

Index

• Variables
• func NewCrudClientFromConfig(authOptions *shttp.AuthenticationOpts) (*shttp.CrudClient, error)
• func NewRestClientFromConfig(authOptions *shttp.AuthenticationOpts) (*shttp.RestClient, error)
• type GremlinQueryHelper
  • func NewGremlinQueryHelper(restClient *shttp.RestClient) *GremlinQueryHelper
  • func NewGremlinQueryHelperFromConfig(authOptions *shttp.AuthenticationOpts) (*GremlinQueryHelper, error)
  • func (g *GremlinQueryHelper) GetFlowMetric(query interface{}) (*flow.FlowMetric, error)
  • func (g *GremlinQueryHelper) GetFlowMetrics(query interface{}) (map[string][]*flow.FlowMetric, error)
  • func (g *GremlinQueryHelper) GetFlows(query interface{}) ([]*flow.Flow, error)
  • func (g *GremlinQueryHelper) GetInterfaceMetric(query interface{}) (*topology.InterfaceMetric, error)
  • func (g *GremlinQueryHelper) GetInterfaceMetrics(query interface{}) (map[string][]*topology.InterfaceMetric, error)
  • func (g *GremlinQueryHelper) GetSFlowMetric(query interface{}) (*sflow.SFMetric, error)
  • func (g *GremlinQueryHelper) GetSFlowMetrics(query interface{}) (map[string][]*sflow.SFMetric, error)
  • func (g *GremlinQueryHelper) GetSockets(query interface{}) (sockets map[string][]*socketinfo.ConnectionInfo, err error)

Variables

var ErrNoResult = gclient.ErrNoResult

ErrNoResult is returned when a query returned no result

Functions

func NewCrudClientFromConfig

func NewCrudClientFromConfig(authOptions *shttp.AuthenticationOpts) (*shttp.CrudClient, error)

NewCrudClientFromConfig creates a new REST client on /api

func NewRestClientFromConfig

func NewRestClientFromConfig(authOptions *shttp.AuthenticationOpts) (*shttp.RestClient, error)

NewRestClientFromConfig creates a new REST client

Types

type GremlinQueryHelper

type GremlinQueryHelper struct {
	*gclient.GremlinQueryHelper
}

GremlinQueryHelper describes a gremlin query request query helper mechanism

func NewGremlinQueryHelper

func NewGremlinQueryHelper(restClient *shttp.RestClient) *GremlinQueryHelper

NewGremlinQueryHelper creates a new Gremlin query helper based on authentication

func NewGremlinQueryHelperFromConfig

func NewGremlinQueryHelperFromConfig(authOptions *shttp.AuthenticationOpts) (*GremlinQueryHelper, error)

NewGremlinQueryHelperFromConfig creates a new Gremlin query helper based on authentication based on configuration file

func (*GremlinQueryHelper) GetFlowMetric

func (g *GremlinQueryHelper) GetFlowMetric(query interface{}) (*flow.FlowMetric, error)

GetFlowMetric from Gremlin query

func (*GremlinQueryHelper) GetFlowMetrics

func (g *GremlinQueryHelper) GetFlowMetrics(query interface{}) (map[string][]*flow.FlowMetric, error)

GetFlowMetrics from Gremlin query

func (*GremlinQueryHelper) GetFlows

func (g *GremlinQueryHelper) GetFlows(query interface{}) ([]*flow.Flow, error)

GetFlows from the Gremlin query

func (*GremlinQueryHelper) GetInterfaceMetric

func (g *GremlinQueryHelper) GetInterfaceMetric(query interface{}) (*topology.InterfaceMetric, error)

GetInterfaceMetric from Gremlin query

func (*GremlinQueryHelper) GetInterfaceMetrics

func (g *GremlinQueryHelper) GetInterfaceMetrics(query interface{}) (map[string][]*topology.InterfaceMetric, error)

GetInterfaceMetrics from Gremlin query

func (*GremlinQueryHelper) GetSFlowMetric

func (g *GremlinQueryHelper) GetSFlowMetric(query interface{}) (*sflow.SFMetric, error)

GetSFlowMetric from Gremlin query

func (*GremlinQueryHelper) GetSFlowMetrics

func (g *GremlinQueryHelper) GetSFlowMetrics(query interface{}) (map[string][]*sflow.SFMetric, error)

GetSFlowMetrics from Gremlin query

func (*GremlinQueryHelper) GetSockets

func (g *GremlinQueryHelper) GetSockets(query interface{}) (sockets map[string][]*socketinfo.ConnectionInfo, err error)

GetSockets from the Gremlin query