com.amazonaws.services.codeguruprofiler.model

Class Metric

java.lang.Object

com.amazonaws.services.codeguruprofiler.model.Metric

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Metric
extends Object
implements Serializable, Cloneable, StructuredPojo

Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Metric()

Method Summary

Modifier and Type	Method and Description
Metric	clone()
boolean	equals(Object obj)
String	getFrameName() The name of the method that appears as a frame in any stack in a profile.
List<String>	getThreadStates() The list of application runtime thread states that is used to calculate the metric value for the frame.
String	getType() A type that specifies how a metric for a frame is analyzed.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFrameName(String frameName) The name of the method that appears as a frame in any stack in a profile.
void	setThreadStates(Collection<String> threadStates) The list of application runtime thread states that is used to calculate the metric value for the frame.
void	setType(String type) A type that specifies how a metric for a frame is analyzed.
String	toString() Returns a string representation of this object.
Metric	withFrameName(String frameName) The name of the method that appears as a frame in any stack in a profile.
Metric	withThreadStates(Collection<String> threadStates) The list of application runtime thread states that is used to calculate the metric value for the frame.
Metric	withThreadStates(String... threadStates) The list of application runtime thread states that is used to calculate the metric value for the frame.
Metric	withType(MetricType type) A type that specifies how a metric for a frame is analyzed.
Metric	withType(String type) A type that specifies how a metric for a frame is analyzed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Metric

public Metric()

Method Detail

setFrameName

public void setFrameName(String frameName)

The name of the method that appears as a frame in any stack in a profile.

Parameters:

frameName - The name of the method that appears as a frame in any stack in a profile.

getFrameName

public String getFrameName()

The name of the method that appears as a frame in any stack in a profile.

Returns:

The name of the method that appears as a frame in any stack in a profile.

withFrameName

public Metric withFrameName(String frameName)

The name of the method that appears as a frame in any stack in a profile.

Parameters:

frameName - The name of the method that appears as a frame in any stack in a profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

getThreadStates

public List<String> getThreadStates()

The list of application runtime thread states that is used to calculate the metric value for the frame.

Returns:

The list of application runtime thread states that is used to calculate the metric value for the frame.

setThreadStates

public void setThreadStates(Collection<String> threadStates)

The list of application runtime thread states that is used to calculate the metric value for the frame.

Parameters:

threadStates - The list of application runtime thread states that is used to calculate the metric value for the frame.

withThreadStates

public Metric withThreadStates(String... threadStates)

The list of application runtime thread states that is used to calculate the metric value for the frame.

NOTE: This method appends the values to the existing list (if any). Use setThreadStates(java.util.Collection) or withThreadStates(java.util.Collection) if you want to override the existing values.

Parameters:

threadStates - The list of application runtime thread states that is used to calculate the metric value for the frame.

Returns:

Returns a reference to this object so that method calls can be chained together.

withThreadStates

public Metric withThreadStates(Collection<String> threadStates)

The list of application runtime thread states that is used to calculate the metric value for the frame.

Parameters:

threadStates - The list of application runtime thread states that is used to calculate the metric value for the frame.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Parameters:

type - A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

See Also:

MetricType

getType

public String getType()

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Returns:

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

See Also:

MetricType

withType

public Metric withType(String type)

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Parameters:

type - A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricType

withType

public Metric withType(MetricType type)

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Parameters:

type - A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Metric clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.