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

Interface AgentConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AgentConfiguration.Builder,AgentConfiguration>, SdkBuilder<AgentConfiguration.Builder,AgentConfiguration>, SdkPojo

Enclosing class:

AgentConfiguration

public static interface AgentConfiguration.Builder
extends SdkPojo, CopyableBuilder<AgentConfiguration.Builder,AgentConfiguration>

Method Summary

Modifier and Type	Method	Description
AgentConfiguration.Builder	agentParameters(Map<AgentParameterField,String> agentParameters)	Parameters used by the profiler.
AgentConfiguration.Builder	agentParametersWithStrings(Map<String,String> agentParameters)	Parameters used by the profiler.
AgentConfiguration.Builder	periodInSeconds(Integer periodInSeconds)	How long a profiling agent should send profiling data using ConfigureAgent .
AgentConfiguration.Builder	shouldProfile(Boolean shouldProfile)	A Boolean that specifies whether the profiling agent collects profiling data or not.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

agentParametersWithStrings

AgentConfiguration.Builder agentParametersWithStrings(Map<String,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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentParameters

AgentConfiguration.Builder agentParameters(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

periodInSeconds

AgentConfiguration.Builder periodInSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

shouldProfile

AgentConfiguration.Builder shouldProfile(Boolean shouldProfile)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.