Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Error ¶
type Error struct { // code // Required: true Code *string `json:"code"` // message // Required: true Message *string `json:"message"` }
Error error
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ExperimentReport ¶
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"` }
ExperimentReport Report on the Status of an experiment
swagger:model ExperimentReport
func (*ExperimentReport) ContextValidate ¶
ContextValidate validate this experiment report based on the context it is used
func (*ExperimentReport) MarshalBinary ¶
func (m *ExperimentReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExperimentReport) UnmarshalBinary ¶
func (m *ExperimentReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExperimentReports ¶
type ExperimentReports []*ExperimentReport
ExperimentReports List of experiment reports
swagger:model ExperimentReports
func (ExperimentReports) ContextValidate ¶
ContextValidate validate this experiment reports based on the context it is used
type HealthEvent ¶
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"` }
HealthEvent health event
information on what streams are available when an experiment changes health status
swagger:model HealthEvent
func (*HealthEvent) ContextValidate ¶
ContextValidate validates this health event based on context it is used
func (*HealthEvent) MarshalBinary ¶
func (m *HealthEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthEvent) UnmarshalBinary ¶
func (m *HealthEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthEvents ¶
type HealthEvents []*HealthEvent
HealthEvents Health events
list of health events
swagger:model HealthEvents
func (HealthEvents) ContextValidate ¶
ContextValidate validate this health events based on the context it is used
type JumpReport ¶
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"` }
JumpReport Status of the jump connection for an experiment
swagger:model JumpReport
func (*JumpReport) ContextValidate ¶
ContextValidate validate this jump report based on the context it is used
func (*JumpReport) MarshalBinary ¶
func (m *JumpReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JumpReport) UnmarshalBinary ¶
func (m *JumpReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RxTx ¶
type RxTx struct { // rx Rx *Statistics `json:"rx,omitempty"` // tx Tx *Statistics `json:"tx,omitempty"` }
RxTx receive and transmit statistics for a connection
swagger:model RxTx
func (*RxTx) ContextValidate ¶
ContextValidate validate this rx tx based on the context it is used
func (*RxTx) MarshalBinary ¶
MarshalBinary interface implementation
func (*RxTx) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Statistics ¶
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"` }
Statistics connection statistics
swagger:model Statistics
func (*Statistics) ContextValidate ¶
ContextValidate validates this statistics based on context it is used
func (*Statistics) MarshalBinary ¶
func (m *Statistics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statistics) UnmarshalBinary ¶
func (m *Statistics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StreamReport ¶
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"` }
StreamReport Status of a stream
swagger:model StreamReport
func (*StreamReport) ContextValidate ¶
ContextValidate validate this stream report based on the context it is used
func (*StreamReport) MarshalBinary ¶
func (m *StreamReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StreamReport) UnmarshalBinary ¶
func (m *StreamReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation