Documentation ¶
Index ¶
- func MountOrdinalValuesController(service *goa.Service, ctrl OrdinalValuesController)
- type AddOrdinalValuesContext
- type GoaIntervalstatisticsresult
- type GoaStatisticsresults
- type OrdinalValue
- type OrdinalValuesController
- type PushOrdinalValuesContext
- type PushOrdinalValuesPayload
- type RegisterOrdinalValuesContext
- type RegisterOrdinalValuesPayload
- type StatisticsOrdinalValuesContext
- type StatisticsOrdinalValuesPayload
- type StatisticsSearchCriteria
- type StreamDefinition
- type StreamMatchCriteria
- type TagAssignmentDefinition
- type TagOrdinalValuesContext
- type TagOrdinalValuesPayload
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MountOrdinalValuesController ¶
func MountOrdinalValuesController(service *goa.Service, ctrl OrdinalValuesController)
MountOrdinalValuesController "mounts" a OrdinalValues resource controller on the given service.
Types ¶
type AddOrdinalValuesContext ¶
type AddOrdinalValuesContext struct { context.Context *goa.ResponseData *goa.RequestData Service *goa.Service Ordinal int Stream string Value float64 }
AddOrdinalValuesContext provides the OrdinalValues add action context.
func NewAddOrdinalValuesContext ¶
func NewAddOrdinalValuesContext(ctx context.Context, service *goa.Service) (*AddOrdinalValuesContext, error)
NewAddOrdinalValuesContext parses the incoming request URL and body, performs validations and creates the context used by the OrdinalValues controller add action.
func (*AddOrdinalValuesContext) OK ¶
func (ctx *AddOrdinalValuesContext) OK(resp []byte) error
OK sends a HTTP response with status code 200.
type GoaIntervalstatisticsresult ¶
type GoaIntervalstatisticsresult struct { // a measure of the variability of values within the sample set CoefficientOfVariation *float64 `json:"coefficientOfVariation,omitempty" xml:"coefficientOfVariation,omitempty"` // the count of values occuring within the interval Count *float64 `json:"count,omitempty" xml:"count,omitempty"` // the ordinal position at the end of the interval IntervalEnd *int `json:"intervalEnd,omitempty" xml:"intervalEnd,omitempty"` // the ordinal position at the start of the interval IntervalStart *int `json:"intervalStart,omitempty" xml:"intervalStart,omitempty"` // the maximum value occuring within the interval Maximum *float64 `json:"maximum,omitempty" xml:"maximum,omitempty"` // the mean of the interval values Mean *float64 `json:"mean,omitempty" xml:"mean,omitempty"` // the minimum value occuring within the interval Minimum *float64 `json:"minimum,omitempty" xml:"minimum,omitempty"` // the count of sample values SampleCount *float64 `json:"sampleCount,omitempty" xml:"sampleCount,omitempty"` // the mean of the sample values SampleMean *float64 `json:"sampleMean,omitempty" xml:"sampleMean,omitempty"` // the standard deviation of the values within the sample set SampleStandardDeviation *float64 `json:"sampleStandardDeviation,omitempty" xml:"sampleStandardDeviation,omitempty"` // the sum of sample values SampleSum *float64 `json:"sampleSum,omitempty" xml:"sampleSum,omitempty"` // identifies the stream for which the interval statistics have been derived StreamKey *string `json:"streamKey,omitempty" xml:"streamKey,omitempty"` // the sum of values occuring within the interval Sum *float64 `json:"sum,omitempty" xml:"sum,omitempty"` }
GoaIntervalstatisticsresult media type.
Identifier: vnd.application/goa.intervalstatisticsresult
type GoaStatisticsresults ¶
type GoaStatisticsresults struct { // A list of matching interval statistics IntervalStatisticsList []*GoaIntervalstatisticsresult `json:"intervalStatisticsList,omitempty" xml:"intervalStatisticsList,omitempty"` }
GoaStatisticsresults media type.
Identifier: vnd.application/goa.statisticsresults
type OrdinalValue ¶
type OrdinalValue struct { // The ordinal position within the stream Ordinal int `json:"ordinal" xml:"ordinal"` // Identifies the stream that the ordinal value relates to Stream string `json:"stream" xml:"stream"` // The value at the ordinal position Value float64 `json:"value" xml:"value"` }
OrdinalValue user type.
func (*OrdinalValue) Validate ¶
func (ut *OrdinalValue) Validate() (err error)
Validate validates the OrdinalValue type instance.
type OrdinalValuesController ¶
type OrdinalValuesController interface { goa.Muxer Add(*AddOrdinalValuesContext) error Push(*PushOrdinalValuesContext) error Register(*RegisterOrdinalValuesContext) error Statistics(*StatisticsOrdinalValuesContext) error Tag(*TagOrdinalValuesContext) error }
OrdinalValuesController is the controller interface for the OrdinalValues actions.
type PushOrdinalValuesContext ¶
type PushOrdinalValuesContext struct { context.Context *goa.ResponseData *goa.RequestData Service *goa.Service Payload *PushOrdinalValuesPayload }
PushOrdinalValuesContext provides the OrdinalValues push action context.
func NewPushOrdinalValuesContext ¶
func NewPushOrdinalValuesContext(ctx context.Context, service *goa.Service) (*PushOrdinalValuesContext, error)
NewPushOrdinalValuesContext parses the incoming request URL and body, performs validations and creates the context used by the OrdinalValues controller push action.
func (*PushOrdinalValuesContext) OK ¶
func (ctx *PushOrdinalValuesContext) OK(resp []byte) error
OK sends a HTTP response with status code 200.
type PushOrdinalValuesPayload ¶
type PushOrdinalValuesPayload struct { // The ordinal position within the stream Ordinal int `json:"ordinal" xml:"ordinal"` // Identifies the stream that the ordinal value relates to Stream string `json:"stream" xml:"stream"` // The value at the ordinal position Value float64 `json:"value" xml:"value"` }
PushOrdinalValuesPayload is the OrdinalValues push action payload.
func (*PushOrdinalValuesPayload) Validate ¶
func (payload *PushOrdinalValuesPayload) Validate() (err error)
Validate runs the validation rules defined in the design.
type RegisterOrdinalValuesContext ¶
type RegisterOrdinalValuesContext struct { context.Context *goa.ResponseData *goa.RequestData Service *goa.Service Payload *RegisterOrdinalValuesPayload }
RegisterOrdinalValuesContext provides the OrdinalValues register action context.
func NewRegisterOrdinalValuesContext ¶
func NewRegisterOrdinalValuesContext(ctx context.Context, service *goa.Service) (*RegisterOrdinalValuesContext, error)
NewRegisterOrdinalValuesContext parses the incoming request URL and body, performs validations and creates the context used by the OrdinalValues controller register action.
func (*RegisterOrdinalValuesContext) OK ¶
func (ctx *RegisterOrdinalValuesContext) OK(resp []byte) error
OK sends a HTTP response with status code 200.
type RegisterOrdinalValuesPayload ¶
type RegisterOrdinalValuesPayload struct { // The ordinal position within the stream IntervalSize int `json:"intervalSize" xml:"intervalSize"` // The value at the ordinal position MaxIntervalLag int `json:"maxIntervalLag" xml:"maxIntervalLag"` // Identifies the stream that the definition relates to Stream string `json:"stream" xml:"stream"` // A set of tag values to be assigned to the stream Tags []string `json:"tags,omitempty" xml:"tags,omitempty"` // The value at the ordinal position TargetSampleSize int `json:"targetSampleSize" xml:"targetSampleSize"` }
RegisterOrdinalValuesPayload is the OrdinalValues register action payload.
func (*RegisterOrdinalValuesPayload) Validate ¶
func (payload *RegisterOrdinalValuesPayload) Validate() (err error)
Validate runs the validation rules defined in the design.
type StatisticsOrdinalValuesContext ¶
type StatisticsOrdinalValuesContext struct { context.Context *goa.ResponseData *goa.RequestData Service *goa.Service Payload *StatisticsOrdinalValuesPayload }
StatisticsOrdinalValuesContext provides the OrdinalValues statistics action context.
func NewStatisticsOrdinalValuesContext ¶
func NewStatisticsOrdinalValuesContext(ctx context.Context, service *goa.Service) (*StatisticsOrdinalValuesContext, error)
NewStatisticsOrdinalValuesContext parses the incoming request URL and body, performs validations and creates the context used by the OrdinalValues controller statistics action.
func (*StatisticsOrdinalValuesContext) OK ¶
func (ctx *StatisticsOrdinalValuesContext) OK(r *GoaStatisticsresults) error
OK sends a HTTP response with status code 200.
type StatisticsOrdinalValuesPayload ¶
type StatisticsOrdinalValuesPayload struct { // Specifies a maximum date time used to restrict the interval statistics returned. Only statistics for intervals that are for a time range up until this date time value will be returned. MaxDateTime *time.Time `json:"maxDateTime,omitempty" xml:"maxDateTime,omitempty"` // Specifies a maximum ordinal value used to restrict the interval statistics returned. Only statistics for intervals that end on or before this ordinal value will be returned. MaxOrdinal *int `json:"maxOrdinal,omitempty" xml:"maxOrdinal,omitempty"` // If true, results across multiple intervals will be merged together to produce a summary result. MergeIntervals *bool `json:"mergeIntervals,omitempty" xml:"mergeIntervals,omitempty"` // If true, results from multiple streams will be merged together to produce a summary result. MergeStreams *bool `json:"mergeStreams,omitempty" xml:"mergeStreams,omitempty"` // Specifies a minimum date time used to restrict the interval statistics returned. Only statistics for intervals that are for a time range on or after this date time value will be returned. MinDateTime *time.Time `json:"minDateTime,omitempty" xml:"minDateTime,omitempty"` // Specifies a minimum ordinal value used to restrict the interval statistics returned. Only statistics for intervals that begin on or after this ordinal value will be returned. MinOrdinal *int `json:"minOrdinal,omitempty" xml:"minOrdinal,omitempty"` // Specifies the criteria by which streams are to be matched StreamMatchCriteria *StreamMatchCriteria `json:"streamMatchCriteria,omitempty" xml:"streamMatchCriteria,omitempty"` }
StatisticsOrdinalValuesPayload is the OrdinalValues statistics action payload.
type StatisticsSearchCriteria ¶
type StatisticsSearchCriteria struct { // Specifies a maximum date time used to restrict the interval statistics returned. Only statistics for intervals that are for a time range up until this date time value will be returned. MaxDateTime *time.Time `json:"maxDateTime,omitempty" xml:"maxDateTime,omitempty"` // Specifies a maximum ordinal value used to restrict the interval statistics returned. Only statistics for intervals that end on or before this ordinal value will be returned. MaxOrdinal *int `json:"maxOrdinal,omitempty" xml:"maxOrdinal,omitempty"` // If true, results across multiple intervals will be merged together to produce a summary result. MergeIntervals *bool `json:"mergeIntervals,omitempty" xml:"mergeIntervals,omitempty"` // If true, results from multiple streams will be merged together to produce a summary result. MergeStreams *bool `json:"mergeStreams,omitempty" xml:"mergeStreams,omitempty"` // Specifies a minimum date time used to restrict the interval statistics returned. Only statistics for intervals that are for a time range on or after this date time value will be returned. MinDateTime *time.Time `json:"minDateTime,omitempty" xml:"minDateTime,omitempty"` // Specifies a minimum ordinal value used to restrict the interval statistics returned. Only statistics for intervals that begin on or after this ordinal value will be returned. MinOrdinal *int `json:"minOrdinal,omitempty" xml:"minOrdinal,omitempty"` // Specifies the criteria by which streams are to be matched StreamMatchCriteria *StreamMatchCriteria `json:"streamMatchCriteria,omitempty" xml:"streamMatchCriteria,omitempty"` }
StatisticsSearchCriteria user type.
type StreamDefinition ¶
type StreamDefinition struct { // The ordinal position within the stream IntervalSize int `json:"intervalSize" xml:"intervalSize"` // The value at the ordinal position MaxIntervalLag int `json:"maxIntervalLag" xml:"maxIntervalLag"` // Identifies the stream that the definition relates to Stream string `json:"stream" xml:"stream"` // A set of tag values to be assigned to the stream Tags []string `json:"tags,omitempty" xml:"tags,omitempty"` // The value at the ordinal position TargetSampleSize int `json:"targetSampleSize" xml:"targetSampleSize"` }
StreamDefinition user type.
func (*StreamDefinition) Validate ¶
func (ut *StreamDefinition) Validate() (err error)
Validate validates the StreamDefinition type instance.
type StreamMatchCriteria ¶
type StreamMatchCriteria struct { // An optional array of tags. Streams tagged with any of these tags will be excluded ExcludeWithAnyTags []string `json:"excludeWithAnyTags,omitempty" xml:"excludeWithAnyTags,omitempty"` // An optional array of tags. Streams tagged with all of these tags will be included IncludeWithAllTags []string `json:"includeWithAllTags,omitempty" xml:"includeWithAllTags,omitempty"` // An optional array of streamKeys used to select streams StreamKeys []string `json:"streamKeys,omitempty" xml:"streamKeys,omitempty"` }
StreamMatchCriteria user type.
type TagAssignmentDefinition ¶
type TagAssignmentDefinition struct { // If true, previously assigned tags will be cleared ClearAll *bool `json:"clearAll,omitempty" xml:"clearAll,omitempty"` // Identifies the stream that the definition relates to Stream string `json:"stream" xml:"stream"` // An array of tags to be assigned TagsToAssign []string `json:"tagsToAssign,omitempty" xml:"tagsToAssign,omitempty"` // An array of tags to be unassigned TagsToUnassign []string `json:"tagsToUnassign,omitempty" xml:"tagsToUnassign,omitempty"` }
TagAssignmentDefinition user type.
func (*TagAssignmentDefinition) Validate ¶
func (ut *TagAssignmentDefinition) Validate() (err error)
Validate validates the TagAssignmentDefinition type instance.
type TagOrdinalValuesContext ¶
type TagOrdinalValuesContext struct { context.Context *goa.ResponseData *goa.RequestData Service *goa.Service Payload *TagOrdinalValuesPayload }
TagOrdinalValuesContext provides the OrdinalValues tag action context.
func NewTagOrdinalValuesContext ¶
func NewTagOrdinalValuesContext(ctx context.Context, service *goa.Service) (*TagOrdinalValuesContext, error)
NewTagOrdinalValuesContext parses the incoming request URL and body, performs validations and creates the context used by the OrdinalValues controller tag action.
func (*TagOrdinalValuesContext) OK ¶
func (ctx *TagOrdinalValuesContext) OK(resp []byte) error
OK sends a HTTP response with status code 200.
type TagOrdinalValuesPayload ¶
type TagOrdinalValuesPayload struct { // If true, previously assigned tags will be cleared ClearAll *bool `json:"clearAll,omitempty" xml:"clearAll,omitempty"` // Identifies the stream that the definition relates to Stream string `json:"stream" xml:"stream"` // An array of tags to be assigned TagsToAssign []string `json:"tagsToAssign,omitempty" xml:"tagsToAssign,omitempty"` // An array of tags to be unassigned TagsToUnassign []string `json:"tagsToUnassign,omitempty" xml:"tagsToUnassign,omitempty"` }
TagOrdinalValuesPayload is the OrdinalValues tag action payload.
func (*TagOrdinalValuesPayload) Validate ¶
func (payload *TagOrdinalValuesPayload) Validate() (err error)
Validate runs the validation rules defined in the design.