FrameMetric (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codeguruprofiler.model.FrameMetric

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FrameMetric
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FrameMetric()

Constructors
Constructor and Description
`FrameMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FrameMetric`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFrameName()` Name of the method common across the multiple occurrences of a frame in an application profile.
`List<String>`	`getThreadStates()` List of application runtime thread states used to get the counts for a frame a derive a metric value.
`String`	`getType()` A type of aggregation 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)` Name of the method common across the multiple occurrences of a frame in an application profile.
`void`	`setThreadStates(Collection<String> threadStates)` List of application runtime thread states used to get the counts for a frame a derive a metric value.
`void`	`setType(String type)` A type of aggregation that specifies how a metric for a frame is analyzed.
`String`	`toString()` Returns a string representation of this object.
`FrameMetric`	`withFrameName(String frameName)` Name of the method common across the multiple occurrences of a frame in an application profile.
`FrameMetric`	`withThreadStates(Collection<String> threadStates)` List of application runtime thread states used to get the counts for a frame a derive a metric value.
`FrameMetric`	`withThreadStates(String... threadStates)` List of application runtime thread states used to get the counts for a frame a derive a metric value.
`FrameMetric`	`withType(MetricType type)` A type of aggregation that specifies how a metric for a frame is analyzed.
`FrameMetric`	`withType(String type)` A type of aggregation 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
  - FrameMetric
```
public FrameMetric()
```
- Method Detail
  - setFrameName
```
public void setFrameName(String frameName)
```
    Name of the method common across the multiple occurrences of a frame in an application profile.
    
    Parameters:
    
    frameName - Name of the method common across the multiple occurrences of a frame in an application profile.
  - getFrameName
```
public String getFrameName()
```
    Name of the method common across the multiple occurrences of a frame in an application profile.
    
    Returns:
    
    Name of the method common across the multiple occurrences of a frame in an application profile.
  - withFrameName
```
public FrameMetric withFrameName(String frameName)
```
    Name of the method common across the multiple occurrences of a frame in an application profile.
    
    Parameters:
    
    frameName - Name of the method common across the multiple occurrences of a frame in an application profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getThreadStates
```
public List<String> getThreadStates()
```
    List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    Returns:
    
    List of application runtime thread states used to get the counts for a frame a derive a metric value.
  - setThreadStates
```
public void setThreadStates(Collection<String> threadStates)
```
    List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    Parameters:
    
    threadStates - List of application runtime thread states used to get the counts for a frame a derive a metric value.
  - withThreadStates
```
public FrameMetric withThreadStates(String... threadStates)
```
    List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    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 - List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withThreadStates
```
public FrameMetric withThreadStates(Collection<String> threadStates)
```
    List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    Parameters:
    
    threadStates - List of application runtime thread states used to get the counts for a frame a derive a metric value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    A type of aggregation 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 occurrences of all frames in a profile.
    
    Parameters:
    
    type - A type of aggregation 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 occurrences of all frames in a profile.
    
    See Also:
    
    MetricType
  - getType
```
public String getType()
```
    A type of aggregation 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 occurrences of all frames in a profile.
    
    Returns:
    
    A type of aggregation 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 occurrences of all frames in a profile.
    
    See Also:
    
    MetricType
  - withType
```
public FrameMetric withType(String type)
```
    A type of aggregation 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 occurrences of all frames in a profile.
    
    Parameters:
    
    type - A type of aggregation 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 occurrences 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 FrameMetric withType(MetricType type)
```
    A type of aggregation 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 occurrences of all frames in a profile.
    
    Parameters:
    
    type - A type of aggregation 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 occurrences 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 FrameMetric 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.

Did this page help you?

Class FrameMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrameMetric

Method Detail

setFrameName

getFrameName

withFrameName

getThreadStates

setThreadStates

withThreadStates

withThreadStates

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall