Package software.amazon.awssdk.services.codeguruprofiler.model

Class Metric

java.lang.Object

software.amazon.awssdk.services.codeguruprofiler.model.Metric

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Metric.Builder,Metric>

@Generated("software.amazon.awssdk:codegen")
public final class Metric
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Metric.Builder,Metric>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Metric.Builder

Method Summary

Modifier and Type	Method	Description
static Metric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	frameName()	The name of the method that appears as a frame in any stack in a profile.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasThreadStates()	For responses, this returns true if the service returned a value for the ThreadStates property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Metric.Builder>	serializableBuilderClass()
List<String>	threadStates()	The list of application runtime thread states that is used to calculate the metric value for the frame.
Metric.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MetricType	type()	A type that specifies how a metric for a frame is analyzed.
String	typeAsString()	A type that specifies how a metric for a frame is analyzed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

frameName

public final String frameName()

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.

hasThreadStates

public final boolean hasThreadStates()

For responses, this returns true if the service returned a value for the ThreadStates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

threadStates

public final List<String> threadStates()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasThreadStates() method.

Returns:

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

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return MetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return MetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

toBuilder

public Metric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Metric.Builder,Metric>

builder

public static Metric.Builder builder()

serializableBuilderClass

public static Class<? extends Metric.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo