com.opsmatters.newrelic.api.model.plugins

Class Component

java.lang.Object

com.opsmatters.newrelic.api.model.plugins.Component

All Implemented Interfaces:

NamedResource

public class Component
extends Object
implements NamedResource

Represents a New Relic plugin agent data.

Author:

Gerald Curley (opsmatters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Component.Builder Builder to make plugin data construction easier.

Constructor Summary

Constructors

Constructor and Description
Component() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addMetric(String name, double value) Adds a floating-point metric to the set of metrics.
void	addMetric(String name, double[] values) Adds a floating-point metric to the set of metrics.
void	addMetric(String name, int value) Adds an integer metric to the set of metrics.
void	addMetric(String name, int[] values) Adds an integer metric to the set of metrics.
<T> void	addMetric(String name, MetricTimeslice<T> timeslice) Adds a metric to the set of metrics.
static Component.Builder	builder() Returns a builder for the plugin component.
int	getDuration() Returns the duration over which the metric data was collected (in seconds).
String	getGuid() Returns the guid of the component.
Map<String,Object>	getMetrics() Returns the set of metrics.
String	getName() Returns the name of the component.
void	setDuration(int duration) Sets the duration over which the metric data was collected (in seconds).
void	setGuid(String guid) Sets the guid of the component.
void	setName(String name) Sets the name of the component.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Component

public Component()

Default constructor.

Method Detail

setName

public void setName(String name)

Sets the name of the component.

Specified by:

setName in interface NamedResource

Parameters:

name - The name of the component

getName

public String getName()

Returns the name of the component.

Specified by:

getName in interface NamedResource

Returns:

The name of the component

setGuid

public void setGuid(String guid)

Sets the guid of the component.

Parameters:

guid - The guid of the component

getGuid

public String getGuid()

Returns the guid of the component.

Returns:

The guid of the component

setDuration

public void setDuration(int duration)

Sets the duration over which the metric data was collected (in seconds).

Parameters:

duration - The duration of the metric data

getDuration

public int getDuration()

Returns the duration over which the metric data was collected (in seconds).

Returns:

The duration of the metric data

getMetrics

public Map<String,Object> getMetrics()

Returns the set of metrics.

Returns:

The set of metrics

addMetric

public void addMetric(String name,
                      int value)

Adds an integer metric to the set of metrics.

Parameters:

name - The name of the metric

value - The value of the metric timeslice

addMetric

public void addMetric(String name,
                      double value)

Adds a floating-point metric to the set of metrics.

Parameters:

name - The name of the metric

value - The value of the metric timeslice

addMetric

public void addMetric(String name,
                      int[] values)

Adds an integer metric to the set of metrics.

Parameters:

name - The name of the metric

values - An array of 5 values representing the metric timeslice

addMetric

public void addMetric(String name,
                      double[] values)

Adds a floating-point metric to the set of metrics.

Parameters:

name - The name of the metric

values - An array of 5 values representing the metric timeslice

addMetric

public <T> void addMetric(String name,
                          MetricTimeslice<T> timeslice)

Adds a metric to the set of metrics.

Type Parameters:

T - The type parameter used for the timeslice

Parameters:

name - The name of the metric

timeslice - The values representing the metric timeslice

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

builder

public static Component.Builder builder()

Returns a builder for the plugin component.

Returns:

The builder instance.