types

Documentation

Index

• type Alert
  • func NewAlert() *Alert
  • func (a *Alert) GetName() string
• type Edge
  • func (e *Edge) GetID() string
  • func (e *Edge) GetName() string
  • func (e *Edge) SetID(i string)
  • func (e *Edge) Validate() error
• type Node
  • func (n *Node) GetID() string
  • func (n *Node) GetName() string
  • func (n *Node) SetID(i string)
  • func (n *Node) Validate() error
• type TopologyParams
• type Workflow
• type WorkflowCall
• type WorkflowChoice
• type WorkflowParam

Types

type Alert

type Alert struct {
	// swagger:allOf
	rest.BasicResource `yaml:",inline"`
	// Alert name
	Name string `json:",omitempty" yaml:"Name"`
	// Alert description
	Description string `json:",omitempty" yaml:"Description"`
	// Gremlin or JavaScript expression evaluated to trigger the alarm
	Expression string `json:",omitempty" valid:"nonzero" yaml:"Expression"`
	// Action to execute when the alert is triggered.
	// Can be either an empty string, or a URL (use 'file://' for local scripts)
	Action string `json:",omitempty" valid:"regexp=^(|http://|https://|file://).*$" yaml:"Action"`
	// Event that triggers the alert evaluation
	Trigger    string `json:",omitempty" valid:"regexp=^(graph|duration:.+|)$" yaml:"Trigger"`
	CreateTime time.Time
}

Alert object

Alerts provide a way to be notified when a Gremlin expression is evaluated to true.

easyjson:json swagger:model Alert

func NewAlert

func NewAlert() *Alert

NewAlert creates a New empty Alert, only CreateTime is set.

func (*Alert) GetName

func (a *Alert) GetName() string

GetName returns the resource name

type Edge

type Edge struct {
	*graph.Edge
}

Edge object easyjson:skip swagger:model

func (*Edge) GetID

func (e *Edge) GetID() string

GetID returns the edge ID

func (*Edge) GetName

func (e *Edge) GetName() string

GetName returns the edge resource name

func (*Edge) SetID

func (e *Edge) SetID(i string)

SetID sets the node ID

func (*Edge) Validate

func (e *Edge) Validate() error

Validate integrity of the resource

type Node

type Node struct {
	*graph.Node
}

Node object easyjson:skip swagger:model

func (*Node) GetID

func (n *Node) GetID() string

GetID returns the node ID

func (*Node) GetName

func (n *Node) GetName() string

GetName returns the node resource name

func (*Node) SetID

func (n *Node) SetID(i string)

SetID sets the resource ID

func (*Node) Validate

func (n *Node) Validate() error

Validate integrity of the resource

type TopologyParams

type TopologyParams struct {
	GremlinQuery string `json:"GremlinQuery,omitempty" valid:"isGremlinExpr" yaml:"GremlinQuery"`
}

TopologyParams topology query parameters easyjson:json swagger:model

type Workflow

type Workflow struct {
	// swagger:allOf
	rest.BasicResource `yaml:",inline"`
	// Workflow name
	Name string `yaml:"Name" valid:"nonzero"`
	// Workflow title
	Title string `yaml:"Title"`
	// Workflow abstract
	Abstract string `yaml:"Abstract"`
	// Workflow description
	Description string `yaml:"Description"`
	// Workflow parameters
	Parameters []WorkflowParam `yaml:"Parameters"`
	Source     string          `valid:"isValidWorkflow" yaml:"Source"`
}

Workflow object

Workflow allows to automate actions using JavaScript.

easyjson:json swagger:model

type WorkflowCall

type WorkflowCall struct {
	Params []interface{}
}

WorkflowCall describes workflow call swagger:model

type WorkflowChoice

type WorkflowChoice struct {
	Value       string `yaml:"Value"`
	Description string `yaml:"Description"`
}

WorkflowChoice describes one value within a choice easyjson:json swagger:model

type WorkflowParam

type WorkflowParam struct {
	Name        string           `yaml:"Name"`
	Description string           `yaml:"Description"`
	Type        string           `yaml:"Type"`
	Default     interface{}      `yaml:"Default"`
	Values      []WorkflowChoice `yaml:"Values"`
}

WorkflowParam describes a workflow parameter easyjson:json swagger:model