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

java.lang.Object
- com.aliyun.hitsdb.client.HiTSDBClient

All implemented interfaces:: HiTSDB, Closeable, AutoCloseable

public class HiTSDBClient extends Object
implements HiTSDB

Builder Essentials

Builder and explanation

HiTSDBClient(HiTSDBConfig config)

Method Essentials

Qualifier and type	Method and explanation
`void`	`close()` Shut down the HiTSDB client.
`void`	`close(boolean force)` Shut down the HiTSDB client.
`void`	`delete(Query query)` Data deletion method. This method is currently not enabled!
`void`	`deleteData(String metric, Date startDate, Date endDate)` Delete data. Specifies the Metric and time range of data to delete.
`void`	`deleteData(String metric, long startTime, long endTime)` Delete data. Specifies the Metric and time range of data to delete.
`void`	`deleteMeta(String metric, Map<String,String> tags)` Delete the timeline and all of its associated data.
`void`	`deleteMeta(Timeline timeline)` Delete the timeline and all of its associated data.
`List<TagResult>`	`dumpMeta(String tagkey, String tagValuePrefix, int max)` Get tag-related information.
`List<QueryResult>`	`last(Query query, int num)` Data query methods.
`List<LastDPValue>`	`lastdp(Collection<Timeline> timelines)` Returns the last value of a timeline.
`List<LastDPValue>`	`lastdp(Timeline... timelines)` Returns the last value of a timeline.
`void`	`put(Point... points)` Put time points into HiTSDB asynchronously.
`void`	`put(Point point)` Put time points into HiTSDB asynchronously.
`<T extends Result> T`	`putSync(Class<T> resultType, Collection<Point> points)` Put time points into HiTSDB synchronously.
`<T extends Result> T`	`putSync(Class<T> resultType, Point... points)` Put time points into HiTSDB synchronously.
`Result`	`putSync(Collection<Point> points)` Put time points into HiTSDB synchronously.
`<T extends Result> T`	`putSync(Collection<Point> points, Class<T> resultType)` Put time points into HiTSDB synchronously.
`Result`	`putSync(Point... points)` Put time points into HiTSDB synchronously.
`List<QueryResult>`	`query(Query query)` Data query methods
`void`	`query(Query query, QueryCallback callback)` Data query methods
`List<String>`	`suggest(Suggest type, String prefix, int max)` This method is used to query metric lists if data meet conditions
`int`	`ttl()` Method to obtain the TTL value. Unit: seconds
`void`	`ttl(int lifetime)` Method to set the TTL value. Unit: seconds
`void`	`ttl(int lifetime, TimeUnit unit)`

Method of inheritance from a class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Builder details
  - HiTSDBClient
```
public HiTSDBClient(HiTSDBConfig config)
            throws HttpClientInitException
```
    throws:
    
    HttpClientInitException
- Method details
  - close
```
public void close()
        throws IOException
```
    Specifier:
    
    close Specifier: Closeable
    
    Specifier:
    
    close Specifier: AutoCloseable
    
    throws:
    
    IOException
  - 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.
  - last
```
public List<QueryResult> last(Query query,
                            int num)
                    throws HttpUnknowStatusException
```
    Specifier:
    
    last Specifier: HiTSDB
    
    Parameters:
    
    query - Instance of the Query class.
    
    num - The quantity of final points on the timeline of the required query results
    
    Return:
    
    Query result list
    
    throws
    
    HttpUnknowStatusException - Exception
  - 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.
  - delete
```
public void delete(Query query)
        throws HttpUnknowStatusException
```
    Explanations of replicating from interfaces: HiTSDB
    
    Deletion method, which has not been enabled.
    
    Specifier:
    
    delete Specifier: HiTSDB
    
    Parameters:
    
    query - query
    
    throws
    
    HttpUnknowStatusException - Exception
  - lastdp
```
public List<LastDPValue> lastdp(Collection<Timeline> timelines)
                        throws HttpUnknowStatusException
```
    Explanations of replicating from interfaces: HiTSDB
    
    Get the last data point of a specified timeline.
    
    Specifier:
    
    lastdp Specifier: HiTSDB
    
    Parameters:
    
    timelines - Timelines instance.
    
    Return:
    
    Result
    
    throws
    
    HttpUnknowStatusException - Exception
  - lastdp
```
public List<LastDPValue> lastdp(Timeline... timelines)
                        throws HttpUnknowStatusException
```
    Explanations of replicating from interfaces: HiTSDB
    
    Get the last data point of a specified timeline.
    
    Specifier:
    
    lastdp Specifier: HiTSDB
    
    Parameters:
    
    timelines - Timeline value.
    
    Return:
    
    List
    
    throws
    
    HttpUnknowStatusException - Exception
  - 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

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

Builder Essentials

Method Essentials

Method of inheritance from a class java.lang.Object

Builder details

HiTSDBClient

Method details

close

close

deleteData

deleteData

deleteMeta

deleteMeta

dumpMeta

put

query

query

suggest

ttl

ttl

ttl

last

putSync

putSync

delete

lastdp

lastdp

put

putSync

putSync

putSync