aws-sdk-codeguruprofiler 1.98.0

AWS SDK for Amazon CodeGuru Profiler
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>The structure representing the configureAgentRequest.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ConfigureAgentInput {
    /// <p>The name of the profiling group for which the configured agent is collecting profiling data.</p>
    pub profiling_group_name: ::std::option::Option<::std::string::String>,
    /// <p>A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.</p>
    pub fleet_instance_id: ::std::option::Option<::std::string::String>,
    /// <p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p>
    /// <ul>
    /// <li>
    /// <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>
    /// <li>
    /// <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>
    /// <li>
    /// <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>
    /// <li>
    /// <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>
    /// <li>
    /// <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>
    /// <li>
    /// <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li>
    /// </ul>
    pub metadata: ::std::option::Option<::std::collections::HashMap<crate::types::MetadataField, ::std::string::String>>,
}
impl ConfigureAgentInput {
    /// <p>The name of the profiling group for which the configured agent is collecting profiling data.</p>
    pub fn profiling_group_name(&self) -> ::std::option::Option<&str> {
        self.profiling_group_name.as_deref()
    }
    /// <p>A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.</p>
    pub fn fleet_instance_id(&self) -> ::std::option::Option<&str> {
        self.fleet_instance_id.as_deref()
    }
    /// <p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p>
    /// <ul>
    /// <li>
    /// <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>
    /// <li>
    /// <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>
    /// <li>
    /// <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>
    /// <li>
    /// <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>
    /// <li>
    /// <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>
    /// <li>
    /// <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li>
    /// </ul>
    pub fn metadata(&self) -> ::std::option::Option<&::std::collections::HashMap<crate::types::MetadataField, ::std::string::String>> {
        self.metadata.as_ref()
    }
}
impl ConfigureAgentInput {
    /// Creates a new builder-style object to manufacture [`ConfigureAgentInput`](crate::operation::configure_agent::ConfigureAgentInput).
    pub fn builder() -> crate::operation::configure_agent::builders::ConfigureAgentInputBuilder {
        crate::operation::configure_agent::builders::ConfigureAgentInputBuilder::default()
    }
}

/// A builder for [`ConfigureAgentInput`](crate::operation::configure_agent::ConfigureAgentInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ConfigureAgentInputBuilder {
    pub(crate) profiling_group_name: ::std::option::Option<::std::string::String>,
    pub(crate) fleet_instance_id: ::std::option::Option<::std::string::String>,
    pub(crate) metadata: ::std::option::Option<::std::collections::HashMap<crate::types::MetadataField, ::std::string::String>>,
}
impl ConfigureAgentInputBuilder {
    /// <p>The name of the profiling group for which the configured agent is collecting profiling data.</p>
    /// This field is required.
    pub fn profiling_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.profiling_group_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the profiling group for which the configured agent is collecting profiling data.</p>
    pub fn set_profiling_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.profiling_group_name = input;
        self
    }
    /// <p>The name of the profiling group for which the configured agent is collecting profiling data.</p>
    pub fn get_profiling_group_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.profiling_group_name
    }
    /// <p>A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.</p>
    pub fn fleet_instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.fleet_instance_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.</p>
    pub fn set_fleet_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.fleet_instance_id = input;
        self
    }
    /// <p>A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.</p>
    pub fn get_fleet_instance_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.fleet_instance_id
    }
    /// Adds a key-value pair to `metadata`.
    ///
    /// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
    ///
    /// <p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p>
    /// <ul>
    /// <li>
    /// <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>
    /// <li>
    /// <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>
    /// <li>
    /// <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>
    /// <li>
    /// <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>
    /// <li>
    /// <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>
    /// <li>
    /// <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li>
    /// </ul>
    pub fn metadata(mut self, k: crate::types::MetadataField, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.metadata.unwrap_or_default();
        hash_map.insert(k, v.into());
        self.metadata = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p>
    /// <ul>
    /// <li>
    /// <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>
    /// <li>
    /// <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>
    /// <li>
    /// <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>
    /// <li>
    /// <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>
    /// <li>
    /// <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>
    /// <li>
    /// <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li>
    /// </ul>
    pub fn set_metadata(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<crate::types::MetadataField, ::std::string::String>>,
    ) -> Self {
        self.metadata = input;
        self
    }
    /// <p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p>
    /// <ul>
    /// <li>
    /// <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>
    /// <li>
    /// <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>
    /// <li>
    /// <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>
    /// <li>
    /// <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>
    /// <li>
    /// <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>
    /// <li>
    /// <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>
    /// <li>
    /// <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li>
    /// </ul>
    pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<crate::types::MetadataField, ::std::string::String>> {
        &self.metadata
    }
    /// Consumes the builder and constructs a [`ConfigureAgentInput`](crate::operation::configure_agent::ConfigureAgentInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::configure_agent::ConfigureAgentInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::configure_agent::ConfigureAgentInput {
            profiling_group_name: self.profiling_group_name,
            fleet_instance_id: self.fleet_instance_id,
            metadata: self.metadata,
        })
    }
}