software.amazon.awssdk.services.codeguruprofiler.model

Class FrameMetric

java.lang.Object

software.amazon.awssdk.services.codeguruprofiler.model.FrameMetric

All Implemented Interfaces:

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

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

The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FrameMetric.Builder

Method Summary

Modifier and Type	Method and Description
static FrameMetric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	frameName() Name of the method common across the multiple occurrences of a frame in an application 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.
List<SdkField<?>>	sdkFields()
static Class<? extends FrameMetric.Builder>	serializableBuilderClass()
List<String>	threadStates() List of application runtime thread states used to get the counts for a frame a derive a metric value.
FrameMetric.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
MetricType	type() A type of aggregation that specifies how a metric for a frame is analyzed.
String	typeAsString() 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

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

copy

Method Detail

frameName

public final String frameName()

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.

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()

List of application runtime thread states used to get the counts for a frame a derive a metric value.

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:

List of application runtime thread states used to get the counts for a frame a derive a metric value.

type

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

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

typeAsString

public final String typeAsString()

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.

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

toBuilder

public FrameMetric.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FrameMetric.Builder,FrameMetric>

Returns:

a builder for type T

builder

public static FrameMetric.Builder builder()

serializableBuilderClass

public static Class<? extends FrameMetric.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.