AgentConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codeguruprofiler.model.AgentConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AgentConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AgentConfiguration()

Constructors
Constructor and Description
`AgentConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AgentConfiguration`	`addAgentParametersEntry(String key, String value)` Add a single AgentParameters entry
`AgentConfiguration`	`clearAgentParametersEntries()` Removes all the entries added into AgentParameters.
`AgentConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAgentParameters()` Parameters used by the profiler.
`Integer`	`getPeriodInSeconds()` How long a profiling agent should send profiling data using `ConfigureAgent` .
`Boolean`	`getShouldProfile()` A `Boolean` that specifies whether the profiling agent collects profiling data or not.
`int`	`hashCode()`
`Boolean`	`isShouldProfile()` A `Boolean` that specifies whether the profiling agent collects profiling data or not.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAgentParameters(Map<String,String> agentParameters)` Parameters used by the profiler.
`void`	`setPeriodInSeconds(Integer periodInSeconds)` How long a profiling agent should send profiling data using `ConfigureAgent` .
`void`	`setShouldProfile(Boolean shouldProfile)` A `Boolean` that specifies whether the profiling agent collects profiling data or not.
`String`	`toString()` Returns a string representation of this object.
`AgentConfiguration`	`withAgentParameters(Map<String,String> agentParameters)` Parameters used by the profiler.
`AgentConfiguration`	`withPeriodInSeconds(Integer periodInSeconds)` How long a profiling agent should send profiling data using `ConfigureAgent` .
`AgentConfiguration`	`withShouldProfile(Boolean shouldProfile)` A `Boolean` that specifies whether the profiling agent collects profiling data or not.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AgentConfiguration
```
public AgentConfiguration()
```
- Method Detail
  - getAgentParameters
```
public Map<String,String> getAgentParameters()
```
    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:
    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.
  - setAgentParameters
```
public void setAgentParameters(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.
  - withAgentParameters
```
public AgentConfiguration withAgentParameters(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.
  - addAgentParametersEntry
```
public AgentConfiguration addAgentParametersEntry(String key,
                                                  String value)
```
    Add a single AgentParameters entry
    
    See Also:
    
    withAgentParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearAgentParametersEntries
```
public AgentConfiguration clearAgentParametersEntries()
```
    Removes all the entries added into AgentParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPeriodInSeconds
```
public void setPeriodInSeconds(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.
  - getPeriodInSeconds
```
public Integer getPeriodInSeconds()
```
    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.
  - withPeriodInSeconds
```
public AgentConfiguration withPeriodInSeconds(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.
  - setShouldProfile
```
public void setShouldProfile(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.
  - getShouldProfile
```
public Boolean getShouldProfile()
```
    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.
  - withShouldProfile
```
public AgentConfiguration withShouldProfile(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.
  - isShouldProfile
```
public Boolean isShouldProfile()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AgentConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AgentConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AgentConfiguration

Method Detail

getAgentParameters

setAgentParameters

withAgentParameters

addAgentParametersEntry

clearAgentParametersEntries

setPeriodInSeconds

getPeriodInSeconds

withPeriodInSeconds

setShouldProfile

getShouldProfile

withShouldProfile

isShouldProfile

toString

equals

hashCode

clone

marshall