com.opsmatters.newrelic.api.model.insights.widgets.MetricsData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of newrelic-api Show documentation
Show all versions of newrelic-api Show documentation
Java client library for the New Relic REST APIs built using Jersey and Gson.
The library includes over 110 operations across all of the available 35 New Relic services.
It can be used by applications to automate the configuration of New Relic Monitoring, Alerting and Dashboards, but can also be used for extracting incident and metric data, executing Insights queries, and uploading plugin metrics.
/*
* Copyright 2018 Gerald Curley
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.opsmatters.newrelic.api.model.insights.widgets;
import java.util.List;
import java.util.ArrayList;
import com.google.gson.annotations.SerializedName;
import com.opsmatters.newrelic.api.model.metrics.Metric;
/**
* Represents a New Relic Insights dashboard metric data source.
*
* @author Gerald Curley (opsmatters)
*/
public class MetricsData extends WidgetData
{
// The field names
public static final String DURATION = "duration";
public static final String END_TIME = "end_time";
public static final String ENTITY_IDS = "entity_ids";
public static final String METRICS = "metrics";
public static final String ORDER_BY = "order_by";
public static final String LIMIT = "limit";
private Integer duration;
@SerializedName("end_time")
private Long endTime;
@SerializedName("entity_ids")
private List entityIds;
private List metrics;
@SerializedName("order_by")
private String orderBy;
private Integer limit;
/**
* Default constructor.
*/
public MetricsData()
{
}
/**
* Sets the duration of the metrics.
* @param duration The duration of the metrics
*/
public void setDuration(Integer duration)
{
this.duration = duration;
}
/**
* Returns the duration of the metrics.
* @return The duration of the metrics
*/
public Integer getDuration()
{
return duration;
}
/**
* Sets the end time of the metrics.
* @param endTime The end time of the metrics
*/
public void setEndTime(Long endTime)
{
this.endTime = endTime;
}
/**
* Returns the end time of the metrics.
* @return The end time of the metrics
*/
public Long getEndTime()
{
return endTime;
}
/**
* Sets the list of entities for the widget.
* @param entityIds The list of entities for the widget
*/
public void setEntityIds(List entityIds)
{
this.entityIds = entityIds;
}
/**
* Adds the given entity id to the list of entities for the widget.
* @param entityId The entity id to add to the list of entities
*/
public void addEntityId(long entityId)
{
if(this.entityIds == null)
this.entityIds = new ArrayList();
this.entityIds.add(entityId);
}
/**
* Returns the list of entities for the widget.
* @return The list of entities for the widget
*/
public List getEntityIds()
{
return entityIds;
}
/**
* Sets the list of metrics for the widget.
* @param metrics The list of metrics for the widget
*/
public void setMetrics(List metrics)
{
this.metrics = metrics;
}
/**
* Adds the given metric to the list of metrics for the widget.
* @param metric The metric to add to the list of metrics
*/
public void addMetric(Metric metric)
{
if(this.metrics == null)
this.metrics = new ArrayList();
this.metrics.add(metric);
}
/**
* Returns the list of metrics for the widget.
* @return The list of metrics for the widget
*/
public List getMetrics()
{
return metrics;
}
/**
* Sets the order by of the metrics.
* @param orderBy The order by of the metrics
*/
public void setOrderBy(String orderBy)
{
this.orderBy = orderBy;
}
/**
* Sets the order by of the metrics.
* @param orderBy The order by of the metrics
*/
public void setOrderBy(Metric.Value orderBy)
{
setOrderBy(orderBy.value());
}
/**
* Returns the order by of the metrics.
* @return The order by of the metrics
*/
public String getOrderBy()
{
return orderBy;
}
/**
* Sets the limit of the metrics.
* @param limit The limit of the metrics
*/
public void setLimit(Integer limit)
{
this.limit = limit;
}
/**
* Returns the limit of the metrics.
* @return The limit of the metrics
*/
public Integer getLimit()
{
return limit;
}
/**
* Returns a string representation of the object.
*/
@Override
public String toString()
{
return "MetricsData [duration="+duration
+", endTime="+endTime
+", entityIds="+entityIds
+", metrics="+metrics
+", orderBy="+orderBy
+", limit="+limit
+"]";
}
/**
* Returns a builder for the widget data.
* @return The builder instance.
*/
public static Builder builder()
{
return new Builder();
}
/**
* Builder to make widget data construction easier.
*/
public static class Builder
{
private MetricsData data = new MetricsData();
/**
* Sets the duration of the widget data.
* @param duration The duration of the widget data
* @return This object
*/
public Builder duration(int duration)
{
data.setDuration(duration);
return this;
}
/**
* Sets the end time of the widget data.
* @param endTime The end time of the widget data
* @return This object
*/
public Builder endTime(long endTime)
{
data.setEndTime(endTime);
return this;
}
/**
* Sets the entity ids of the widget data.
* @param entityIds The entity ids of the widget data
* @return This object
*/
public Builder entityIds(List entityIds)
{
data.setEntityIds(entityIds);
return this;
}
/**
* Adds the given entity id to the list of entities for the widget.
* @param entityId The entity id to add to the list of entities
* @return This object
*/
public Builder addEntityId(long entityId)
{
data.addEntityId(entityId);
return this;
}
/**
* Sets the metrics of the widget data.
* @param metrics The metrics of the widget data
* @return This object
*/
public Builder metrics(List metrics)
{
data.setMetrics(metrics);
return this;
}
/**
* Adds the given metric to the list of metrics for the widget.
* @param metric The metric to add to the list of metrics
* @return This object
*/
public Builder addMetric(Metric metric)
{
data.addMetric(metric);
return this;
}
/**
* Sets the order by of the widget data.
* @param orderBy The order by of the widget data
* @return This object
*/
public Builder orderBy(String orderBy)
{
data.setOrderBy(orderBy);
return this;
}
/**
* Sets the order by of the widget data.
* @param orderBy The order by of the widget data
* @return This object
*/
public Builder orderBy(Metric.Value orderBy)
{
data.setOrderBy(orderBy);
return this;
}
/**
* Sets the limit of the widget data.
* @param limit The limit of the widget data
* @return This object
*/
public Builder limit(int limit)
{
data.setLimit(limit);
return this;
}
/**
* Returns the configured widget data instance
* @return The widget data instance
*/
public MetricsData build()
{
return data;
}
}
}