software.amazon.awssdk.services.codeguruprofiler.model

Interface ConfigureAgentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodeGuruProfilerRequest.Builder, CopyableBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>, SdkBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ConfigureAgentRequest

public static interface ConfigureAgentRequest.Builder
extends CodeGuruProfilerRequest.Builder, SdkPojo, CopyableBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>

Method Summary

Modifier and Type	Method and Description
ConfigureAgentRequest.Builder	fleetInstanceId(String fleetInstanceId) A universally unique identifier (UUID) for a profiling instance.
ConfigureAgentRequest.Builder	metadata(Map<MetadataField,String> metadata) Metadata captured about the compute platform the agent is running on.
ConfigureAgentRequest.Builder	metadataWithStrings(Map<String,String> metadata) Metadata captured about the compute platform the agent is running on.
ConfigureAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ConfigureAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ConfigureAgentRequest.Builder	profilingGroupName(String profilingGroupName) The name of the profiling group for which the configured agent is collecting profiling data.

Methods inherited from interface software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

fleetInstanceId

ConfigureAgentRequest.Builder fleetInstanceId(String fleetInstanceId)

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.

Parameters:

fleetInstanceId - 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.

Returns:

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

metadataWithStrings

ConfigureAgentRequest.Builder metadataWithStrings(Map<String,String> metadata)

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

• COMPUTE_PLATFORM - The compute platform on which the agent is running

• AGENT_ID - The ID for an agent instance.

• AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

• EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

• LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

• LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

• LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

• LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

• LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

Parameters:

metadata - Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

• COMPUTE_PLATFORM - The compute platform on which the agent is running

• AGENT_ID - The ID for an agent instance.

• AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

• EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

• LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

• LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

• LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

• LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

• LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

Returns:

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

metadata

ConfigureAgentRequest.Builder metadata(Map<MetadataField,String> metadata)

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

• COMPUTE_PLATFORM - The compute platform on which the agent is running

• AGENT_ID - The ID for an agent instance.

• AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

• EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

• LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

• LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

• LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

• LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

• LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

Parameters:

metadata - Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

• COMPUTE_PLATFORM - The compute platform on which the agent is running

• AGENT_ID - The ID for an agent instance.

• AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

• EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

• LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

• LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

• LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

• LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

• LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

Returns:

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

profilingGroupName

ConfigureAgentRequest.Builder profilingGroupName(String profilingGroupName)

The name of the profiling group for which the configured agent is collecting profiling data.

Parameters:

profilingGroupName - The name of the profiling group for which the configured agent is collecting profiling data.

Returns:

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

overrideConfiguration

ConfigureAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ConfigureAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.