v1

Documentation

Index

• Constants
• type Annotation
  • func (m *Annotation) MarshalBinary() ([]byte, error)
  • func (m *Annotation) UnmarshalBinary(b []byte) error
  • func (m *Annotation) Validate(formats strfmt.Registry) error
• type Annotations
  • func (m *Annotations) MarshalBinary() ([]byte, error)
  • func (m *Annotations) UnmarshalBinary(b []byte) error
  • func (m *Annotations) Validate(formats strfmt.Registry) error
• type Query
  • func (m *Query) MarshalBinary() ([]byte, error)
  • func (m *Query) UnmarshalBinary(b []byte) error
  • func (m *Query) Validate(formats strfmt.Registry) error
• type Range
  • func (m *Range) MarshalBinary() ([]byte, error)
  • func (m *Range) UnmarshalBinary(b []byte) error
  • func (m *Range) Validate(formats strfmt.Registry) error
• type Target
  • func (m *Target) MarshalBinary() ([]byte, error)
  • func (m *Target) UnmarshalBinary(b []byte) error
  • func (m *Target) Validate(formats strfmt.Registry) error
• type Timeserie
  • func (m *Timeserie) MarshalBinary() ([]byte, error)
  • func (m *Timeserie) UnmarshalBinary(b []byte) error
  • func (m *Timeserie) Validate(formats strfmt.Registry) error
• type Timeseries
  • func (m Timeseries) Validate(formats strfmt.Registry) error

Constants

const (

	// TargetTypeTimeserie captures enum value "timeserie"
	TargetTypeTimeserie string = "timeserie"

	// TargetTypeTable captures enum value "table"
	TargetTypeTable string = "table"
)

const (

	// QueryFormatJSON captures enum value "json"
	QueryFormatJSON string = "json"
)

Types

type Annotation

type Annotation struct {

	// datasource
	Datasource string `json:"datasource,omitempty"`

	// enable
	Enable bool `json:"enable,omitempty"`

	// icon color
	IconColor string `json:"iconColor,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// query
	Query string `json:"query,omitempty"`

	// show line
	ShowLine bool `json:"showLine,omitempty"`
}

Annotation Annotation is the object passed by Grafana when it fetches annotations. swagger:model Annotation

func (*Annotation) MarshalBinary

func (m *Annotation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Annotation) UnmarshalBinary

func (m *Annotation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Annotation) Validate

func (m *Annotation) Validate(formats strfmt.Registry) error

Validate validates this annotation

type Annotations

type Annotations struct {

	// annotation
	Annotation *Annotation `json:"annotation,omitempty"`

	// range
	Range *Range `json:"range,omitempty"`
}

Annotations encodes the information provided by Grafana in its requests. swagger:model Annotations

func (*Annotations) MarshalBinary

func (m *Annotations) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Annotations) UnmarshalBinary

func (m *Annotations) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Annotations) Validate

func (m *Annotations) Validate(formats strfmt.Registry) error

Validate validates this annotations

type Query

type Query struct {

	// format
	// Enum: [json]
	Format *string `json:"format,omitempty"`

	// interval
	Interval string `json:"interval,omitempty"`

	// interval ms
	IntervalMs int64 `json:"intervalMs,omitempty"`

	// max data points
	MaxDataPoints int64 `json:"maxDataPoints,omitempty"`

	// range
	Range *Range `json:"range,omitempty"`

	// targets
	Targets []*Target `json:"targets"`
}

Query query data requests. swagger:model Query

func (*Query) MarshalBinary

func (m *Query) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Query) UnmarshalBinary

func (m *Query) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Query) Validate

func (m *Query) Validate(formats strfmt.Registry) error

Validate validates this query

type Range

type Range struct {

	// from
	// Format: date-time
	From strfmt.DateTime `json:"from,omitempty"`

	// to
	// Format: date-time
	To strfmt.DateTime `json:"to,omitempty"`
}

Range Range specifies the time range the request is valid for. swagger:model Range

func (*Range) MarshalBinary

func (m *Range) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Range) UnmarshalBinary

func (m *Range) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Range) Validate

func (m *Range) Validate(formats strfmt.Registry) error

Validate validates this range

type Target

type Target struct {

	// ref Id
	RefID string `json:"refId,omitempty"`

	// target
	Target string `json:"target,omitempty"`

	// type
	// Enum: [timeserie table]
	Type *string `json:"type,omitempty"`
}

Target data target. swagger:model Target

func (*Target) MarshalBinary

func (m *Target) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Target) UnmarshalBinary

func (m *Target) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Target) Validate

func (m *Target) Validate(formats strfmt.Registry) error

Validate validates this target

type Timeserie

type Timeserie struct {

	// datapoints
	Datapoints [][]interface{} `json:"datapoints"`

	// target
	Target string `json:"target,omitempty"`
}

Timeserie timeserie swagger:model Timeserie

func (*Timeserie) MarshalBinary

func (m *Timeserie) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Timeserie) UnmarshalBinary

func (m *Timeserie) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Timeserie) Validate

func (m *Timeserie) Validate(formats strfmt.Registry) error

Validate validates this timeserie

type Timeseries

type Timeseries []*Timeserie

Timeseries Request object passed to datasource.query function swagger:model Timeseries

func (Timeseries) Validate

func (m Timeseries) Validate(formats strfmt.Registry) error

Validate validates this timeseries