software.amazon.awssdk.services.codeguruprofiler.model

Class Pattern

java.lang.Object

software.amazon.awssdk.services.codeguruprofiler.model.Pattern

All Implemented Interfaces:

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

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

A set of rules used to make a recommendation during an analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Pattern.Builder

Method Summary

Modifier and Type	Method and Description
static Pattern.Builder	builder()
List<String>	countersToAggregate() A list of the different counters used to determine if there is a match.
String	description() The description of the recommendation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCountersToAggregate() For responses, this returns true if the service returned a value for the CountersToAggregate property.
int	hashCode()
boolean	hasTargetFrames() For responses, this returns true if the service returned a value for the TargetFrames property.
String	id() The universally unique identifier (UUID) of this pattern.
String	name() The name for this pattern.
String	resolutionSteps() A string that contains the steps recommended to address the potential inefficiency.
List<SdkField<?>>	sdkFields()
static Class<? extends Pattern.Builder>	serializableBuilderClass()
List<List<String>>	targetFrames() A list of frame names that were searched during the analysis that generated a recommendation.
Double	thresholdPercent() The percentage of time an application spends in one method that triggers a recommendation.
Pattern.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasCountersToAggregate

public final boolean hasCountersToAggregate()

For responses, this returns true if the service returned a value for the CountersToAggregate 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.

countersToAggregate

public final List<String> countersToAggregate()

A list of the different counters used to determine if there is a match.

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 hasCountersToAggregate() method.

Returns:

A list of the different counters used to determine if there is a match.

description

public final String description()

The description of the recommendation. This explains a potential inefficiency in a profiled application.

Returns:

The description of the recommendation. This explains a potential inefficiency in a profiled application.

id

public final String id()

The universally unique identifier (UUID) of this pattern.

Returns:

The universally unique identifier (UUID) of this pattern.

name

public final String name()

The name for this pattern.

Returns:

The name for this pattern.

resolutionSteps

public final String resolutionSteps()

A string that contains the steps recommended to address the potential inefficiency.

Returns:

A string that contains the steps recommended to address the potential inefficiency.

hasTargetFrames

public final boolean hasTargetFrames()

For responses, this returns true if the service returned a value for the TargetFrames 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.

targetFrames

public final List<List<String>> targetFrames()

A list of frame names that were searched during the analysis that generated a recommendation.

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 hasTargetFrames() method.

Returns:

A list of frame names that were searched during the analysis that generated a recommendation.

thresholdPercent

public final Double thresholdPercent()

The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

Returns:

The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

toBuilder

public Pattern.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Pattern.Builder,Pattern>

builder

public static Pattern.Builder builder()

serializableBuilderClass

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