Class AgentConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Map
<AgentParameterField, String> Parameters used by the profiler.Parameters used by the profiler.static AgentConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AgentParameters property.final int
hashCode()
final Integer
How long a profiling agent should send profiling data usingConfigureAgent
.static Class
<? extends AgentConfiguration.Builder> final Boolean
ABoolean
that specifies whether the profiling agent collects profiling data or not.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 methodA
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the profiler evaluatesA
andB
. -
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 methodA
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the profiler evaluatesA
andB
. -
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 theisEmpty()
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
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 methodA
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the profiler evaluatesA
andB
. -
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 methodA
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the profiler evaluatesA
andB
. -
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
How long a profiling agent should send profiling data using
ConfigureAgent
. For example, if this is set to 300, the profiling agent callsConfigureAgent
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 callsConfigureAgent
every 5 minutes to submit the profiled data collected during that period.
-
shouldProfile
A
Boolean
that specifies whether the profiling agent collects profiling data or not. Set totrue
to enable profiling.- Returns:
- A
Boolean
that specifies whether the profiling agent collects profiling data or not. Set totrue
to enable profiling.
-
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 interfaceToCopyableBuilder<AgentConfiguration.Builder,
AgentConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-