Skip to content

Query Bucket Usage Request

The data collector Query Bucket Usage request provides the ability to query internal bucket state of datacollector as we have limited bandwidth for each event configured in the configuration file.

Note that although these requests do currently support "asyncCall" API, using the synchronous "execute" API is recommended since it is a non-blocking call.

Please see the API reference for the main classes related to Data Collector.

Query Bucket Usage Request

This API provides the ability to query the internal state of DataCollector to identify if events data that have not been consumed surpass the configured threshold.

Sample code

1
2
3
QueryBucketUsageRequest.Builder builder = client.queryBucketUsageRequest();
QueryBucketUsageResponse response = builder
    .build().execute();

1
2
3
var builder = client.queryBucketUsageRequest()
var response = builder
    .build().execute()

Response example

1
2
3
4
5
6
{
  "code": "SUCCESS",
  "message": "QueryBucketUsageResponse Success",
  "results": [{"bucketName":  "GROUP1", "budget":  128000, "remaining":  128000}, {"bucketName":  "GpsProbe", "budget":  128000, "remaining":  128000}],
  "response_time": 2
}