software.amazon.awssdk.services.codeguruprofiler.model

Class ConfigureAgentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerRequest

software.amazon.awssdk.services.codeguruprofiler.model.ConfigureAgentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ConfigureAgentRequest
extends CodeGuruProfilerRequest
implements ToCopyableBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>

The structure representing the configureAgentRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigureAgentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ConfigureAgentRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetInstanceId() A universally unique identifier (UUID) for a profiling instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata() Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<MetadataField,String>	metadata() Metadata captured about the compute platform the agent is running on.
Map<String,String>	metadataAsStrings() Metadata captured about the compute platform the agent is running on.
String	profilingGroupName() The name of the profiling group for which the configured agent is collecting profiling data.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigureAgentRequest.Builder>	serializableBuilderClass()
ConfigureAgentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fleetInstanceId

public final 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.

Returns:

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.

metadata

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetadata() to see if a value was sent in this field.

Returns:

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.

hasMetadata

public final boolean hasMetadata()

Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metadataAsStrings

public final Map<String,String> metadataAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetadata() to see if a value was sent in this field.

Returns:

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.

profilingGroupName

public final String profilingGroupName()

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

Returns:

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

toBuilder

public ConfigureAgentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigureAgentRequest.Builder,ConfigureAgentRequest>

Specified by:

toBuilder in class CodeGuruProfilerRequest

builder

public static ConfigureAgentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ConfigureAgentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo