models

type Error struct {

	// code
	// Required: true
	Code *string `json:"code"`

	// message
	// Required: true
	Message *string `json:"message"`
}

type ExperimentReport struct {

	// is it set as available on the booking system?
	// Required: true
	Available *bool `json:"available"`

	// first checked
	// Required: true
	FirstChecked *string `json:"first_checked"`

	// number of health events recorded
	HealthEvents int64 `json:"health_events,omitempty"`

	// healthy
	// Required: true
	Healthy *bool `json:"healthy"`

	// jump ok
	// Required: true
	JumpOk *bool `json:"jump_ok"`

	// jump report
	JumpReport *JumpReport `json:"jump_report,omitempty"`

	// last checked jump
	// Required: true
	LastCheckedJump *string `json:"last_checked_jump"`

	// last checked streams
	// Required: true
	LastCheckedStreams *string `json:"last_checked_streams"`

	// last found in manifest
	// Required: true
	LastFoundInManifest *string `json:"last_found_in_manifest"`

	// name of the resouce in the manifest
	// Example: r-spin30
	// Required: true
	ResourceName *string `json:"resource_name"`

	// stream ok
	// Required: true
	StreamOk map[string]bool `json:"stream_ok"`

	// stream reports
	// Required: true
	StreamReports map[string]StreamReport `json:"stream_reports"`

	// defaults to true for required stream, false currently undefined, but kept as a map for consistenct with stream_reports and stream_ok
	// Required: true
	StreamRequired map[string]bool `json:"stream_required"`

	// topic stub in stream names
	// Example: spin30
	// Required: true
	TopicName *string `json:"topic_name"`
}

type ExperimentReports []*ExperimentReport

type HealthEvent struct {

	// is experiment healthy?
	Healthy bool `json:"healthy,omitempty"`

	// list of issues, if any
	Issues []string `json:"issues"`

	// is the jump connection ok?
	JumpOk bool `json:"jump_ok,omitempty"`

	// which streams are connected, and are they ok? Name of stream in key
	StreamOk map[string]bool `json:"stream_ok,omitempty"`

	// the time and date of the event occurring
	When string `json:"when,omitempty"`
}

type HealthEvents []*HealthEvent

type JumpReport struct {

	// can read
	CanRead bool `json:"can_read,omitempty"`

	// can write
	CanWrite bool `json:"can_write,omitempty"`

	// date and time connection made
	// Required: true
	Connected *string `json:"connected"`

	// expiry date and time in the token used to authenticate the connection
	// Required: true
	ExpiresAt *string `json:"expires_at"`

	// list of IP addresses for client (typically <client>, <proxy 1>, etc)
	RemoteAddr string `json:"remote_addr,omitempty"`

	// list of scopes supplied in token used to authenticate the connection
	// Required: true
	Scopes []string `json:"scopes"`

	// stats
	// Required: true
	Stats *RxTx `json:"stats"`

	// topic_stub for experiment e.g. pend00
	// Required: true
	Topic *string `json:"topic"`

	// what tool is user using to connect
	// Required: true
	UserAgent *string `json:"user_agent"`
}

type RxTx struct {

	// rx
	Rx *Statistics `json:"rx,omitempty"`

	// tx
	Tx *Statistics `json:"tx,omitempty"`
}

type Statistics struct {

	// messages per second (frames per second if video)
	Fps int64 `json:"fps,omitempty"`

	// date and time of the last message sent
	Last string `json:"last,omitempty"`

	// true if not messages ever sent on this connection
	Never bool `json:"never,omitempty"`

	// size in bytes of the last message sent
	Size int64 `json:"size,omitempty"`
}

type StreamReport struct {

	// can read
	CanRead bool `json:"can_read,omitempty"`

	// can write
	CanWrite bool `json:"can_write,omitempty"`

	// date and time connection made
	// Required: true
	Connected *string `json:"connected"`

	// expiry date and time in the token used to authenticate the connection
	// Required: true
	ExpiresAt *string `json:"expires_at"`

	// list of IP addresses for client (typically <client>, <proxy 1>, etc)
	RemoteAddr string `json:"remote_addr,omitempty"`

	// list of scopes supplied in token used to authenticate the connection
	// Required: true
	Scopes []string `json:"scopes"`

	// stats
	// Required: true
	Stats *RxTx `json:"stats"`

	// topic_stub for experiment e.g. pend00
	// Required: true
	Topic *string `json:"topic"`

	// what tool is user using to connect
	// Required: true
	UserAgent *string `json:"user_agent"`
}