com.coscale.sdk.client.metrics

Class MetricsApi

java.lang.Object

com.coscale.sdk.client.metrics.MetricsApi

public class MetricsApi
extends Object

MetricsApi is used to make API requests for metrics and metricgroups endpoints.

Author:

cristi

Constructor Summary

Constructors

Constructor and Description
MetricsApi(ApiClient api) MetricsApi constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MetricGroup	addGroupToGroup(long childId, long parentId) Add an existing metric group to another metric group.
Metric	addMetricToGroup(long metricId, long groupId) Add an existing metric to a metric group.
List<Metric>	all() all is used to get a list of all metrics.
List<Metric>	all(Options options) all is used to get a list of all metrics.
Msg	delete(long id) Delete a metric by id.
Msg	deleteGroupFromGroup(long childId, long parentId) Delete a metric group from another metric group.
Msg	deleteMetricFromGroup(long metricId, long groupId) Delete a metric from a metric group.
Msg	deleteMetricGroup(long id) Delete a specific metric group.
Metric	get(long id) get a metric by the id.
List<MetricGroup>	getAllMetricGroups() Get all metric groups.
List<Metric>	getGroupMetrics(long groupId) * Get all metrics in the metric group.
List<MetricGroup>	getGroupsFromGroup(long groupId) Get all child metric groups for a metric group.
MetricGroup	getMetricGroup(long id) Get a specific metric group.
Metric	insert(MetricInsert metric) Insert a new metric.
MetricGroup	insertMetricGroup(MetricGroupInsert metricGroup) Insert a new metric group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsApi

public MetricsApi(ApiClient api)

MetricsApi constructor.

Parameters:

api - ApiClient.

Method Detail

all

public List<Metric> all()
                 throws IOException

all is used to get a list of all metrics.

Returns:

List

Throws:

IOException

all

public List<Metric> all(Options options)
                 throws IOException

all is used to get a list of all metrics.

Returns:

List

Throws:

IOException

get

public Metric get(long id)
           throws IOException

get a metric by the id.

Parameters:

id - id of the metric.

Returns:

Metric

Throws:

IOException

insert

public Metric insert(MetricInsert metric)
              throws IOException

Insert a new metric.

Parameters:

metric - MetricInsert containing data for the new metric.

Returns:

MetricInsert the metric object.

Throws:

IOException

delete

public Msg delete(long id)
           throws IOException

Delete a metric by id.

Parameters:

id - id of the metric.

Returns:

Msg the response message.

Throws:

IOException

getAllMetricGroups

public List<MetricGroup> getAllMetricGroups()
                                     throws IOException

Get all metric groups.

Returns:

List of all MetricGroups

Throws:

IOException

getMetricGroup

public MetricGroup getMetricGroup(long id)
                           throws IOException

Get a specific metric group.

Parameters:

id - the id of the metric group

Returns:

MetricGroup

Throws:

IOException

insertMetricGroup

public MetricGroup insertMetricGroup(MetricGroupInsert metricGroup)
                              throws IOException

Insert a new metric group. Optionally set which MetricGroup will be its parent (this is set in MetricGroupInsert object).

Parameters:

metricGroup - the metric group to insert.

Returns:

MetricGroup

Throws:

IOException

deleteMetricGroup

public Msg deleteMetricGroup(long id)
                      throws IOException

Delete a specific metric group.

Parameters:

id - the id of the metric group.

Returns:

Msg

Throws:

IOException

addGroupToGroup

public MetricGroup addGroupToGroup(long childId,
                          long parentId)
                            throws IOException

Add an existing metric group to another metric group.

Parameters:

childId -

parentId -

Returns:

MetricGroup: the added metric group.

Throws:

IOException

addMetricToGroup

public Metric addMetricToGroup(long metricId,
                      long groupId)
                        throws IOException

Add an existing metric to a metric group.

Parameters:

metricId -

groupId -

Returns:

Metric: the inserted metric.

Throws:

IOException

getGroupMetrics

public List<Metric> getGroupMetrics(long groupId)
                             throws IOException

* Get all metrics in the metric group.

Parameters:

groupId - the id of the metric group * @return List of Metrics.

Returns:

List of Metrics.

Throws:

IOException

deleteMetricFromGroup

public Msg deleteMetricFromGroup(long metricId,
                        long groupId)
                          throws IOException

Delete a metric from a metric group.

Parameters:

metricId - the id of the metric.

groupId - the id of the group.

Returns:

Msg.

Throws:

IOException

getGroupsFromGroup

public List<MetricGroup> getGroupsFromGroup(long groupId)
                                     throws IOException

Get all child metric groups for a metric group.

Parameters:

groupId - the if of the group.

Returns:

List of MetricGroups.

Throws:

IOException

deleteGroupFromGroup

public Msg deleteGroupFromGroup(long childId,
                       long parentId)
                         throws IOException

Delete a metric group from another metric group.

Parameters:

childId - the id of the group that will be removed.

parentId - the id of the group from which the child group will be removed.

Returns:

Msg.

Throws:

IOException