edit-icon download-icon

HiTSDBClient

Last Updated: Mar 28, 2018

Class name: com.aliyun.hitsdb.client.HiTSDBClient

    • Method details

      • close

        public void close(boolean force)
                throws IOException
        Explanations of replicating from interfaces:HiTSDB
        Close the HiTSDB instance. Call this method before the program ends.
        Specifier:
        close Specifier: HiTSDB
        Parameters:
        force - true or false
        throws:
        IOException - exception
      • deleteData

        public void deleteData(String metric,
                            long startTime,
                            long endTime)
        Specifier:
        deleteData Specifier: HiTSDB
        Parameters:
        metric - metric
        startTime - start timestamp
        endTime - end timestamp
      • deleteData

        public void deleteData(String metric,
                            Date startDate,
                            Date endDate)
        Explanations of replicating from interfaces: HiTSDB
        Delete all data of the specified metric and time range.
        Specifier:
        deleteData Specifier: HiTSDB
        Parameters:
        metric - metric name
        startDate - start date
        endDate - end date
      • deleteMeta

        public void deleteMeta(String metric,
                            Map<String, String> tags)
        Explanations of replicating from interfaces: HiTSDB
        Delete timeline data.
        Specifier:
        deleteMeta Specifier: HiTSDB
        Parameters:
        metric - Metric, name of measure, name of indicator
        tags - Map-denoted Tag key-value pair.
      • deleteMeta

        public void deleteMeta(Timeline timeline)
        Explanations of replicating from interfaces: HiTSDB
        Delete timeline data./div>
        Specifier:
        deleteMeta Specifier: HiTSDB
        Parameters:
        timeline - Instance of the timeline class.
      • dumpMeta

        public List<TagResult> dumpMeta(String tagkey,
                                    String tagValuePrefix,
                                    int max)
        Explanations of replicating from interfaces: HiTSDB
        Get the list of tags that meet conditions
        Specifier:
        dumpMeta Specifier: HiTSDB
        Parameters:
        tagkey - Tag name
        tagValuePrefix - Tag value prefix
        max - Maximum quantity
        Return:
        the List of the TagResult
      • put

        public void put(Point point)
        Explanations of replicating from interfaces: HiTSDB
        Put data asynchronously
        Specifier:
        put Specifier: HiTSDB
        Parameters:
        point - Time point
      • query

        public List<QueryResult> query(Query query)
        Explanations of replicating from interfaces: HiTSDB
        Query data
        Specifier:
        query Specifier: HiTSDB
        Parameters:
        query - Instance of the Query class
        Return:
        result: instance of the QueryResult class.
      • query

        public void query(Query  query,
                        QueryCallback callback)
        Explanations of replicating from interfaces: HiTSDB
        Asynchronous query method, which returns the query results in callback.
        Specifier:
        query Specifier: HiTSDB
        Parameters:
        query - Instance of the Query class
        callback - Query instances of the callback interface. The query results are asynchronously returned using the callback method.
      • suggest

        public List<String> suggest(Suggest type,
                                String prefix,
                                int max)
        Explanations of replicating from interfaces: HiTSDB
        suggest method
        Specifier:
        suggest Specifier: HiTSDB
        Parameters:
        type - Data types
        prefix - Prefix
        max - Maximum quantity
        Return:
        result
      • ttl

        public int ttl()
        Explanations of replicating from interfaces: HiTSDB
        Obtain the TTL value. Unit: seconds
        Specifier:
        ttl Specifier: HiTSDB
        Return:
        TTL value: in seconds.
      • ttl

        public void ttl(int lifetime)
        Explanations of replicating from interfaces: HiTSDB
        Set the TTL value.
        Specifier:
        ttl Specifier: HiTSDB
        Parameters:
        lifetime - TTL value. Unit: seconds.
      • ttl

        public void ttl(int lifetime,
                    TimeUnit unit)
        Specifier:
        ttl Specifier: HiTSDB
        Parameters:
        lifetime - TTL value.
        unit - TTL unit.
      • putSync

        public Result putSync(Collection<Point> points)
        Explanations of replicating from interfaces: HiTSDB
        Put the time points synchronously
        Specifier:
        putSync Specifier: HiTSDB
        Parameters:
        points - Quantity of time points
        Return:
        Result instance. This object serves only to indicate that the method returns.
      • putSync

        public <T extends Result> T putSync(Collection<Point> points,
                                        Class<T> resultType)
        Explanations of replicating from interfaces: HiTSDB
        Synchronous putting method
        Specifier:
        putSync Specifier: HiTSDB
        Type parameters:
        T - Result.class, SummaryResult.class, DetailsResult.class
        Parameters:
        points - Set of time points
        resultType - Type of results
        Return:
        Result instance.
      • put

        public void put(Point... points)
        Explanations of replicating from interfaces: HiTSDB
        Put time points asynchronously
        Specifier:
        put Specifier: HiTSDB
        Parameters:
        points - Set of time points
      • putSync

        public Result putSync(Point... points)
        Explanations of replicating from interfaces: HiTSDB
        Put time points synchronously
        Specifier:
        putSync Specifier: HiTSDB
        Parameters:
        points - Set of time points
        Return:
        Result
      • putSync

        public <T extends Result> T putSync(Class<T> resultType,
                                        Collection<Point> points)
        Explanations of replicating from interfaces: HiTSDB
        Put synchronously
        Specifier:
        putSync Specifier: HiTSDB
        Type parameters:
        T - Result.class, SummaryResult.class, DetailsResult.class
        Parameters:
        resultType - Type of results
        points - Set of time points
        Return:
        Result
      • putSync

        public <T extends Result> T putSync(Class<T> resultType,
                                        Point... points)
        Explanations of replicating from interfaces: HiTSDB
        Synchronous putting method
        Specifier:
        putSync Specifier: HiTSDB
        Type parameters:
        T - Result.class, SummaryResult.class, DetailsResult.class
        Parameters:
        resultType - Type of results
        points - Set of time points
        Return:
        Result
Thank you! We've received your feedback.