This section lists frequently used classes of the HiTSDB SDK according to the SDK package name. Click class name links for details and usage methods of important classes.
| Class name | Description |
|---|
| HiTSDBConfig | HiTSDB configuration class; all client options are configured in this class. |
| HiTSDBConfig.Builder | HiTSDBConfig’s builder class; HiTSDBConfig objects are produced by this class. |
| HiTSDBClientFactory | HiTSDB object’s engineering class; HiTSDB objects are produced by the HiTSDBConfig objects. |
| HiTSDBClient | HiTSDB operation class; used to implement com.aliyun.hitsdb.client.HiTSDB interfaces. This class is thread-safe, and used to complete all HiTSDB operations. Typically, only one HiTSDB class object is required globally. |
| HiTSDB | HiTSDBClient interface class |
| Class name | Description |
|---|
| Point | Point; represents data to be put into HiTSDB. |
| Point.MetricBuilder | Point building class; Point objects are built by this class. |
| Timeline | class; the timeline of HiTSDB. |
| Query | Query class |
| Query.Builder | Query class and building class |
| SubQuery | SubQuery class |
| SubQuery.Builder | SubQuery class and building class |
| Filter | Filter query class |
| Filter.Builder | Filter class, Filter class’ building class. |
| MetricTimeRange | MetricTimeRange value |
| TTLValue | Time to Live (TTL) value |
| SuggestValue | SuggestValue value |
| Class name | Description |
|---|
| QueryResult | Query result class |
| Timeline | class; the timeline of HiTSDB. |
| TagResult | Tag query result |
| LastDPValue | Last query result value |
| Class name | Description |
|---|
| Aggregator | Aggregation calculation type |
| FilterType | Filter type |
| Suggest | Query result class |
| Class name | Description |
|---|
| QueryCallback | Query callback class |
| BatchPutCallback | Put callback |
| BatchPutDetailsCallback | Put callback class |
| BatchPutSummaryCallback | Put callback class |
| Class name | Description |
|---|
| BufferQueueFullException | Full queue |
| Class name | Description |
|---|
| HttpClientConnectionRefusedException | HiTSDB server refused connection |
| HttpClientException | Client exception |
| HttpClientInitException | Exception during client initialization |
| HttpClientSocketTimeoutException | Client socket time-out |
| HttpServerErrorException | Server returned 5xx-level error code |
| HttpServerNotSupportException | Server returned 4xx-level error code |
| HttpUnknowStatusException | Server returned undefined error code |