org.hawkular.client.metrics.clients

Interface AvailabilityClient

All Known Implementing Classes:

DefaultAvailabilityClient

public interface AvailabilityClient

Method Summary

Modifier and Type	Method and Description
ClientResponse<Empty>	addAvailabilityData(List<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>> data) Add metric data for multiple availability metrics in a single call.
ClientResponse<Empty>	addAvailabilityDataForMetric(String id, List<org.hawkular.metrics.model.DataPoint<org.hawkular.metrics.model.AvailabilityType>> data) Add data for a single availability metric.
ClientResponse<Empty>	createAvailabilityMetric(Boolean overwrite, org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType> metric) Create availability metric.
ClientResponse<Empty>	deleteAvailabilityMetricTags(String id, org.hawkular.metrics.model.param.Tags tags) Delete tags associated with the metric definition.
ClientResponse<List<org.hawkular.metrics.model.DataPoint<org.hawkular.metrics.model.AvailabilityType>>>	findAvailabilityData(String id, String start, String end, Boolean distinct, Integer limit, Order order) Retrieve availability data.
ClientResponse<List<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>>>	findAvailabilityMetrics(org.hawkular.metrics.model.param.Tags tags) Find tenant’s metric definitions.
ClientResponse<List<org.hawkular.metrics.model.AvailabilityBucketPoint>>	findAvailabilityStats(String id, String start, String end, Integer buckets, org.hawkular.metrics.model.param.Duration bucketDuration) Retrieve availability data.
ClientResponse<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>>	getAvailabilityMetric(String id) Retrieve single metric definition.
ClientResponse<Map<String,String>>	getAvailabilityMetricTags(String id) Retrieve tags associated with the metric definition.
ClientResponse<Map<String,List<String>>>	getGaugeTags(org.hawkular.metrics.model.param.Tags tags) Retrieve gauge type’s tag values
ClientResponse<Empty>	updateAvailabilityMetricTags(String id, Map<String,String> tags) Update tags associated with the metric definition.

Method Detail

findAvailabilityMetrics

ClientResponse<List<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>>> findAvailabilityMetrics(org.hawkular.metrics.model.param.Tags tags)

Find tenant’s metric definitions.

Parameters:

tags -

Returns:

createAvailabilityMetric

ClientResponse<Empty> createAvailabilityMetric(Boolean overwrite,
                                               org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType> metric)

Create availability metric.

Parameters:

overwrite -

metric -

Returns:

addAvailabilityData

ClientResponse<Empty> addAvailabilityData(List<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>> data)

Add metric data for multiple availability metrics in a single call.

Parameters:

data -

Returns:

getGaugeTags

ClientResponse<Map<String,List<String>>> getGaugeTags(org.hawkular.metrics.model.param.Tags tags)

Retrieve gauge type’s tag values

Parameters:

tags -

Returns:

getAvailabilityMetric

ClientResponse<org.hawkular.metrics.model.Metric<org.hawkular.metrics.model.AvailabilityType>> getAvailabilityMetric(String id)

Retrieve single metric definition.

Parameters:

id -

Returns:

findAvailabilityData

ClientResponse<List<org.hawkular.metrics.model.DataPoint<org.hawkular.metrics.model.AvailabilityType>>> findAvailabilityData(String id,
                                                                                                                             String start,
                                                                                                                             String end,
                                                                                                                             Boolean distinct,
                                                                                                                             Integer limit,
                                                                                                                             Order order)

Retrieve availability data.

Parameters:

id -

start -

end -

distinct -

limit -

order -

Returns:

addAvailabilityDataForMetric

ClientResponse<Empty> addAvailabilityDataForMetric(String id,
                                                   List<org.hawkular.metrics.model.DataPoint<org.hawkular.metrics.model.AvailabilityType>> data)

Add data for a single availability metric.

Parameters:

id -

data -

Returns:

findAvailabilityStats

ClientResponse<List<org.hawkular.metrics.model.AvailabilityBucketPoint>> findAvailabilityStats(String id,
                                                                                               String start,
                                                                                               String end,
                                                                                               Integer buckets,
                                                                                               org.hawkular.metrics.model.param.Duration bucketDuration)

Retrieve availability data.

Parameters:

id -

start -

end -

buckets -

bucketDuration -

Returns:

getAvailabilityMetricTags

ClientResponse<Map<String,String>> getAvailabilityMetricTags(String id)

Retrieve tags associated with the metric definition.

Parameters:

id -

Returns:

updateAvailabilityMetricTags

ClientResponse<Empty> updateAvailabilityMetricTags(String id,
                                                   Map<String,String> tags)

Update tags associated with the metric definition.

Parameters:

id -

tags -

Returns:

deleteAvailabilityMetricTags

ClientResponse<Empty> deleteAvailabilityMetricTags(String id,
                                                   org.hawkular.metrics.model.param.Tags tags)

Delete tags associated with the metric definition.

Parameters:

id -

tags -

Returns: