Add Models

Author: luyongqiang

.vs/slnx.sqlite

@@ -0,0 +1,45 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace OpenTSDB.Core.Models.Histogram
+{
+    /// <summary>
+    /// Available with OpenTSDB 2.4
+    /// This endpoint allows for storing histogram data in OpenTSDB over HTTP as an alternative to the Telnet interface. Histogram write Request can only be performed via content associated with the POST method. Queries over histogram data are performed via the query endpoints.
+    /// </summary>
+    /// <remarks>If the content you provide with the request cannot be parsed, such JSON content missing a quotation mark or curly brace, then all of the datapoints will be discarded. The API will return an error with details about what went wrong.</remarks>
+    public class HistogramRequest : DataPoint<string>
+    {
+        /// <summary>
+        /// 	When writing histograms or sketches other than the default simple bucketed histogram,
+        /// 	this value must be set to the ID of the proper histogram codec as defined in the tsd.core.histograms.config configuration setting. 
+        /// 	The value must be between 0 and 255. When given, the value must be set.
+        /// </summary>
+        /// <example>1</example>
+        [JsonProperty("id")]
+        public int Id { get; set; }
+
+        /// <summary>
+        /// A map of bucket lower and upper bounds (separated by commas) as keys with integer counter bucket values
+        /// </summary>
+        /// <example>
+        /// {"0,1.75":12,"1.75,3.5":16}
+        /// </example>
+        [JsonProperty("buckets")]
+        public Dictionary<string, int> Buckets { get; set; }
+
+        /// <summary>
+        /// The count of measurements lower than the lowest bucket lower bound. Default is zero.
+        /// </summary>
+       /// <example>0</example>
+        [JsonProperty("underflow")]
+        public int Underflow { get; set; }
+
+        /// <summary>
+        ///The count of measurements higher than the highest bucket upper bound. Default is zero.
+        /// </summary>
+        /// <example>0</example>
+        [JsonProperty("overflow")]
+        public int Overflow { get; set; }
+    }
+}

src/CoreBIM.OpenTSDB/Models/Histogram/HistogramRequest.cs

@@ -0,0 +1,105 @@
+using Newtonsoft.Json;
+
+namespace OpenTSDB.Core.Models.Query
+{
+    /// <summary>
+    /// http://opentsdb.net/docs/build/html/api_http/query/index.html
+    /// </summary>
+    public class QueryRequest
+    {
+        /// <summary>
+        /// The start time for the query. This can be a relative or absolute timestamp
+        /// </summary>
+        /// <example>1h-ago</example>
+        [JsonProperty("start")]
+        public string Start { get; set; }
+
+        /// <summary>
+        ///     An end time for the query. If not supplied, the TSD will assume the local system time on the server.
+        ///     This may be a relative or absolute timestamp
+        /// </summary>
+        /// <example>1h-ago</example>  
+        [JsonProperty("end")]
+        public string End { get; set; }
+
+        /// <summary>
+        ///     One or more sub queries used to select the time series to return. 
+        ///     These may be metric m or TSUID tsuids queries
+        /// </summary>
+        [JsonProperty("queries")]
+        public SubQueryRequest[] Queries { get; set; }
+
+        /// <summary>
+        ///     Whether or not to return annotations with a query.
+        ///     The default is to return annotations for the requested timespan but this flag can disable the return.
+        ///     This affects both local and global notes and overrides globalAnnotations
+        /// </summary>
+        /// <example>false</example>  
+        [JsonProperty("noAnnotations")]
+        public bool NoAnnotations { get; set; }
+
+        /// <summary>
+        ///     Whether or not the query should retrieve global annotations for the requested timespan
+        /// </summary>
+        [JsonProperty("globalAnnotations")]
+        public bool GlobalAnnotations { get; set; }
+
+        /// <summary>
+        ///     Whether or not to Response data point timestamps in milliseconds or seconds.
+        ///     The msResolution flag is recommended.
+        ///     If this flag is not provided and there are multiple data points within a second, those data points will be down
+        ///     sampled using the query's aggregation function.
+        /// </summary>
+        [JsonProperty("msResolution")]
+        public bool MsResolutions { get; set; }
+
+        /// <summary>
+        ///     Whether or not to Response the TSUIDs associated with timeseries in the results.
+        ///     If multiple time series were aggregated into one set, multiple TSUIDs will be returned in a sorted manner
+        /// </summary>
+        [JsonProperty("showTSUIDs")]
+        public bool ShowTsuids { get; set; }
+
+        /// <summary>
+        ///     Whether or not to show a summary of timings surrounding the query in the results.
+        ///     This creates another object in the map that is unlike the data point objects.
+        /// </summary>
+        [JsonProperty("showSummary")]
+        public bool ShowSummary { get; set; }
+
+        /// <summary>
+        ///     Whether or not to show detailed timings surrounding the query in the results.
+        ///     This creates another object in the map that is unlike the data point objects
+        /// </summary>
+        [JsonProperty("showStats")]
+        public bool ShowStats { get; set; }
+
+        /// <summary>
+        ///     Whether or not to return the original sub query with the query results.
+        ///     If the request contains many sub queries then this is a good way to determine which results belong to which sub
+        ///     query.
+        ///     Note that in the case of a * or wildcard query, this can produce a lot of duplicate Response.
+        /// </summary>
+        [JsonProperty("showQuery")]
+        public bool ShowQuery { get; set; }
+
+        /// <summary>
+        ///     Can be passed to the JSON with a POST to delete any data points that match the given query.
+        /// </summary>
+        [JsonProperty("delete")]
+        public bool Delete { get; set; }
+
+        /// <summary>
+        ///     An optional timezone for calendar-based downsampling.
+        ///     Must be a valid timezone database name supported by the JRE installed on the TSD server.
+        /// </summary>
+        [JsonProperty("timezone")]
+        public string TimeZone { get; set; }
+
+        /// <summary>
+        ///     Whether or not use the calendar based on the given timezone for downsampling intervals
+        /// </summary>
+        [JsonProperty("useCalendar")]
+        public bool UseCalendar { get; set; }
+    }
+}

src/CoreBIM.OpenTSDB/Models/Query/QueryRequest.cs

@@ -0,0 +1,36 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace OpenTSDB.Core.Models.Query
+{
+    public class SubQueryRequest
+    {
+        [JsonProperty("aggregator")]
+        public string Aggregator { get; set; }
+
+        [JsonProperty("metric")]
+        public string Metric { get; set; }
+
+        [JsonProperty("rate")]
+        public bool Rate { get; set; }
+
+        [JsonProperty("rateOptions")]
+        public Dictionary<string, string> RateOptions { get; set; }
+
+        [JsonProperty("downsample")]
+        public string Downsample { get; set; }
+
+        [JsonProperty("tags")]
+        public Tags Tags { get; set; }
+
+        [JsonProperty("filters")]
+        public IEnumerable<string> Filters { get; set; }
+
+        [JsonProperty("explicitTags")]
+        public bool ExplicitTags { get; set; }
+
+        [JsonProperty("percentiles")]
+        public IEnumerable<string> Percentiles { get; set; }
+    }
+
+}

src/CoreBIM.OpenTSDB/Models/Query/SubQueryRequest.cs

@@ -0,0 +1,33 @@
+using Newtonsoft.Json;
+
+namespace OpenTSDB.Core.Models.Rollup
+{
+    /// <summary>
+    /// Rollup and pre-aggregate values are extensions of the put object with three additional fields. 
+    /// </summary>
+    public class RollupRequest<T>: DataPoint<T> 
+    {
+        /// <summary>
+        /// A time interval reflecting what timespan the rollup value represents. 
+        /// The interval consists of <amount><unit> similar to a downsampler or relative query timestamp. 
+        /// E.g. 6h for 5 hours of data, 30m for 30 minutes of data.
+        /// </summary>
+        /// <example>1h</example>
+        [JsonProperty("interval")]
+        public string Interval { get; set; }
+
+        /// <summary>
+        /// An aggregation function used to generate the rollup value. Must match a supplied TSDB aggregator.
+        /// </summary>
+        /// <example>SUM</example>
+        [JsonProperty("aggregator")]
+        public string Aggregator { get; set; }
+
+        /// <summary>
+        /// An aggregation function used to generate the pre-aggregate value. Must match a supplied TSDB aggregator.
+        /// </summary>
+        /// <example>COUNT</example>
+        [JsonProperty("groupByAggregator")]
+        public string GroupByAggregator { get; set; }
+    }
+}

src/CoreBIM.OpenTSDB/Models/Rollup/RollupRequest.cs

@@ -0,0 +1,28 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace OpenTSDB.Core.Models.Search.Annotation
+{
+    public class AnnotationResultItem
+    {
+        [JsonProperty("notes")]
+        public  string Notes { get; set; }
+
+        [JsonProperty("description")]
+        public string Description { get; set; }
+
+        [JsonProperty("tsuid")]
+        public string Tsuid { get; set; }
+
+        [JsonProperty("custom")]
+        public Dictionary<string,string> Custom { get; set; }
+       
+        [JsonProperty("endTime")]
+        public int endTime { get; set; }
+       
+        [JsonProperty("startTime")]
+        public int startTime { get; set; }
+    }
+
+
+}

src/CoreBIM.OpenTSDB/Models/Search/Annotation/AnnotationResultItem.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Text;
+
+namespace OpenTSDB.Core.Models.Search.Annotation
+{
+    public class SearchAnnotationResponse : SearchResponse<AnnotationResultItem>
+    {
+    }
+
+
+}

src/CoreBIM.OpenTSDB/Models/Search/Annotation/SearchAnnotationResponse.cs

@@ -0,0 +1,8 @@
+namespace OpenTSDB.Core.Models.Search.Lookup
+{
+    public class SearchLookupResponse : SearchResponse<ResultItem>
+    {
+
+    }   
+
+}

src/CoreBIM.OpenTSDB/Models/Search/Lookup/SearchLookupRepose.cs

@@ -0,0 +1,32 @@
+using Newtonsoft.Json;
+
+namespace OpenTSDB.Core.Models.Search.Lookup
+{
+    public class SearchLookupRequest
+    {
+        /// <summary>
+        /// Ignored for lookup queries.
+        /// </summary>
+        [JsonProperty("query")]
+        public string Query { get; set; }
+
+        /// <summary>
+        /// 	Whether or not to use the meta data table or the raw data table. The raw table will be much slower.
+        /// </summary>
+        [JsonProperty("useMeta")]
+        public bool UseMeta { get; set; } = true;
+        /// <summary>
+        /// 	The maximum number of items returned in the result set.
+        /// </summary>
+        [JsonProperty("limit")]
+        public int Limit { get; set; }
+
+        /// <summary>
+        /// Ignored for lookup queries, always the default.
+        /// </summary>
+        [JsonProperty("startIndex")]
+        public int StartIndex { get; set; }
+
+    }
+
+}

src/CoreBIM.OpenTSDB/Models/Search/Lookup/SearchLookupRequest.cs

@@ -0,0 +1,19 @@
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace OpenTSDB.Core.Models.Search
+{
+    public class ResultItem
+    {
+        [JsonProperty("tags")]
+        public Dictionary<string, string> Tags { get; set; }
+
+        [JsonProperty("metric")]
+        public string Metric { get; set; }
+
+        [JsonProperty("tsuid")]
+        public string Tsuid { get; set; }
+    }
+
+
+}