client

Documentation

Index

• func AddOrdinalValuesPath(stream string, ordinal int, value float64) string
• func PushOrdinalValuesPath() string
• func RegisterOrdinalValuesPath() string
• func StatisticsOrdinalValuesPath() string
• func TagOrdinalValuesPath() string
• type Client
  • func New(c *http.Client) *Client
  • func (c *Client) AddOrdinalValues(ctx context.Context, path string) (*http.Response, error)
  • func (c *Client) DecodeGoaStatisticsresults(resp *http.Response) (*GoaStatisticsresults, error)
  • func (c *Client) NewAddOrdinalValuesRequest(ctx context.Context, path string) (*http.Request, error)
  • func (c *Client) NewPushOrdinalValuesRequest(ctx context.Context, path string, payload *PushOrdinalValuesPayload) (*http.Request, error)
  • func (c *Client) NewRegisterOrdinalValuesRequest(ctx context.Context, path string, payload *RegisterOrdinalValuesPayload) (*http.Request, error)
  • func (c *Client) NewStatisticsOrdinalValuesRequest(ctx context.Context, path string, payload *StatisticsOrdinalValuesPayload) (*http.Request, error)
  • func (c *Client) NewTagOrdinalValuesRequest(ctx context.Context, path string, payload *TagOrdinalValuesPayload) (*http.Request, error)
  • func (c *Client) PushOrdinalValues(ctx context.Context, path string, payload *PushOrdinalValuesPayload) (*http.Response, error)
  • func (c *Client) RegisterOrdinalValues(ctx context.Context, path string, payload *RegisterOrdinalValuesPayload) (*http.Response, error)
  • func (c *Client) StatisticsOrdinalValues(ctx context.Context, path string, payload *StatisticsOrdinalValuesPayload) (*http.Response, error)
  • func (c *Client) TagOrdinalValues(ctx context.Context, path string, payload *TagOrdinalValuesPayload) (*http.Response, error)
• type GoaIntervalstatisticsresult
• type GoaStatisticsresults
• type PushOrdinalValuesPayload
• type RegisterOrdinalValuesPayload
• type StatisticsOrdinalValuesPayload
• type StreamMatchCriteria
• type TagOrdinalValuesPayload

Functions

func AddOrdinalValuesPath

func AddOrdinalValuesPath(stream string, ordinal int, value float64) string

AddOrdinalValuesPath computes a request path to the add action of OrdinalValues.

func PushOrdinalValuesPath

func PushOrdinalValuesPath() string

PushOrdinalValuesPath computes a request path to the push action of OrdinalValues.

func RegisterOrdinalValuesPath

func RegisterOrdinalValuesPath() string

RegisterOrdinalValuesPath computes a request path to the register action of OrdinalValues.

func StatisticsOrdinalValuesPath

func StatisticsOrdinalValuesPath() string

StatisticsOrdinalValuesPath computes a request path to the statistics action of OrdinalValues.

func TagOrdinalValuesPath

func TagOrdinalValuesPath() string

TagOrdinalValuesPath computes a request path to the tag action of OrdinalValues.

Types

type Client

type Client struct {
	*goaclient.Client
	Encoder *goa.HTTPEncoder
	Decoder *goa.HTTPDecoder
}

Client is the Stream Statistics API service client.

func New

func New(c *http.Client) *Client

New instantiates the client.

func (*Client) AddOrdinalValues

func (c *Client) AddOrdinalValues(ctx context.Context, path string) (*http.Response, error)

add a value to a stream referencing an ordinal position

func (*Client) DecodeGoaStatisticsresults

func (c *Client) DecodeGoaStatisticsresults(resp *http.Response) (*GoaStatisticsresults, error)

DecodeGoaStatisticsresults decodes the GoaStatisticsresults instance encoded in resp body.

func (*Client) NewAddOrdinalValuesRequest

func (c *Client) NewAddOrdinalValuesRequest(ctx context.Context, path string) (*http.Request, error)

NewAddOrdinalValuesRequest create the request corresponding to the add action endpoint of the OrdinalValues resource.

func (*Client) NewPushOrdinalValuesRequest

func (c *Client) NewPushOrdinalValuesRequest(ctx context.Context, path string, payload *PushOrdinalValuesPayload) (*http.Request, error)

NewPushOrdinalValuesRequest create the request corresponding to the push action endpoint of the OrdinalValues resource.

func (*Client) NewRegisterOrdinalValuesRequest

func (c *Client) NewRegisterOrdinalValuesRequest(ctx context.Context, path string, payload *RegisterOrdinalValuesPayload) (*http.Request, error)

NewRegisterOrdinalValuesRequest create the request corresponding to the register action endpoint of the OrdinalValues resource.

func (*Client) NewStatisticsOrdinalValuesRequest

func (c *Client) NewStatisticsOrdinalValuesRequest(ctx context.Context, path string, payload *StatisticsOrdinalValuesPayload) (*http.Request, error)

NewStatisticsOrdinalValuesRequest create the request corresponding to the statistics action endpoint of the OrdinalValues resource.

func (*Client) NewTagOrdinalValuesRequest

func (c *Client) NewTagOrdinalValuesRequest(ctx context.Context, path string, payload *TagOrdinalValuesPayload) (*http.Request, error)

NewTagOrdinalValuesRequest create the request corresponding to the tag action endpoint of the OrdinalValues resource.

func (*Client) PushOrdinalValues

func (c *Client) PushOrdinalValues(ctx context.Context, path string, payload *PushOrdinalValuesPayload) (*http.Response, error)

Pushes a new ordinal value onto the stream

func (*Client) RegisterOrdinalValues

func (c *Client) RegisterOrdinalValues(ctx context.Context, path string, payload *RegisterOrdinalValuesPayload) (*http.Response, error)

Registers a new stream

func (*Client) StatisticsOrdinalValues

func (c *Client) StatisticsOrdinalValues(ctx context.Context, path string, payload *StatisticsOrdinalValuesPayload) (*http.Response, error)

Gets statistics matching search criteria

func (*Client) TagOrdinalValues

func (c *Client) TagOrdinalValues(ctx context.Context, path string, payload *TagOrdinalValuesPayload) (*http.Response, error)

Changes the tag assignments for a stream

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"`
}

A set of statistics based on the values of a stream for an interval

type GoaStatisticsresults

type GoaStatisticsresults struct {
	// A list of matching interval statistics
	IntervalStatisticsList []*GoaIntervalstatisticsresult `json:"intervalStatisticsList,omitempty" xml:"intervalStatisticsList,omitempty"`
}

The results of a statistics query

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.

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.

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 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 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.