software.amazon.awssdk.services.codeguruprofiler.model

Class AgentConfiguration

java.lang.Object

software.amazon.awssdk.services.codeguruprofiler.model.AgentConfiguration

All Implemented Interfaces:

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

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

The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AgentConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Map<AgentParameterField,String>	agentParameters() Parameters used by the profiler.
Map<String,String>	agentParametersAsStrings() Parameters used by the profiler.
static AgentConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentParameters() For responses, this returns true if the service returned a value for the AgentParameters property.
int	hashCode()
Integer	periodInSeconds() How long a profiling agent should send profiling data using ConfigureAgent .
List<SdkField<?>>	sdkFields()
static Class<? extends AgentConfiguration.Builder>	serializableBuilderClass()
Boolean	shouldProfile() A Boolean that specifies whether the profiling agent collects profiling data or not.
AgentConfiguration.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

agentParameters

public final Map<AgentParameterField,String> agentParameters()

Parameters used by the profiler. The valid parameters are:

• MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.

• MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

• MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

• ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

• SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

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

Returns:

Parameters used by the profiler. The valid parameters are:

• MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.

• MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

• MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

• ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

• SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

hasAgentParameters

public final boolean hasAgentParameters()

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

agentParametersAsStrings

public final Map<String,String> agentParametersAsStrings()

Parameters used by the profiler. The valid parameters are:

• MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.

• MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

• MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

• ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

• SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

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

Returns:

Parameters used by the profiler. The valid parameters are:

• MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.

• MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

• MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

• ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

• SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

periodInSeconds

public final Integer periodInSeconds()

How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period.

Returns:

How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period.

shouldProfile

public final Boolean shouldProfile()

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

Returns:

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

toBuilder

public AgentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AgentConfiguration.Builder,AgentConfiguration>

builder

public static AgentConfiguration.Builder builder()

serializableBuilderClass

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