Struct aws_sdk_codeguruprofiler::types::builders::AgentConfigurationBuilder

#[non_exhaustive]
pub struct AgentConfigurationBuilder { /* private fields */ }

A builder for AgentConfiguration.

Implementations

impl AgentConfigurationBuilder

pub fn should_profile(self, input: bool) -> Self

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

This field is required.

pub fn set_should_profile(self, input: Option<bool>) -> Self

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

pub fn get_should_profile(&self) -> &Option<bool>

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

pub fn period_in_seconds(self, input: i32) -> Self

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.

This field is required.

pub fn set_period_in_seconds(self, input: Option<i32>) -> Self

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.

pub fn get_period_in_seconds(&self) -> &Option<i32>

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.

pub fn agent_parameters( self, k: AgentParameterField, v: impl Into<String>, ) -> Self

Adds a key-value pair to agent_parameters.

To override the contents of this collection use set_agent_parameters.

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.

pub fn set_agent_parameters( self, input: Option<HashMap<AgentParameterField, String>>, ) -> Self

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.

pub fn get_agent_parameters( &self, ) -> &Option<HashMap<AgentParameterField, String>>

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.

pub fn build(self) -> Result<AgentConfiguration, BuildError>

Consumes the builder and constructs a AgentConfiguration. This method will fail if any of the following fields are not set:

• should_profile
• period_in_seconds

Trait Implementations

impl Clone for AgentConfigurationBuilder

fn clone(&self) -> AgentConfigurationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AgentConfigurationBuilder

fn default() -> AgentConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for AgentConfigurationBuilder

fn eq(&self, other: &AgentConfigurationBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AgentConfigurationBuilder