com.amazonaws.services.codeguruprofiler.model

Class ConfigureAgentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codeguruprofiler.model.ConfigureAgentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfigureAgentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The structure representing the configureAgentRequest.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ConfigureAgentRequest()

Method Summary

Modifier and Type	Method and Description
ConfigureAgentRequest	addMetadataEntry(String key, String value) Add a single Metadata entry
ConfigureAgentRequest	clearMetadataEntries() Removes all the entries added into Metadata.
ConfigureAgentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getFleetInstanceId() A universally unique identifier (UUID) for a profiling instance.
Map<String,String>	getMetadata() Metadata captured about the compute platform the agent is running on.
String	getProfilingGroupName() The name of the profiling group for which the configured agent is collecting profiling data.
int	hashCode()
void	setFleetInstanceId(String fleetInstanceId) A universally unique identifier (UUID) for a profiling instance.
void	setMetadata(Map<String,String> metadata) Metadata captured about the compute platform the agent is running on.
void	setProfilingGroupName(String profilingGroupName) The name of the profiling group for which the configured agent is collecting profiling data.
String	toString() Returns a string representation of this object.
ConfigureAgentRequest	withFleetInstanceId(String fleetInstanceId) A universally unique identifier (UUID) for a profiling instance.
ConfigureAgentRequest	withMetadata(Map<String,String> metadata) Metadata captured about the compute platform the agent is running on.
ConfigureAgentRequest	withProfilingGroupName(String profilingGroupName) The name of the profiling group for which the configured agent is collecting profiling data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigureAgentRequest

public ConfigureAgentRequest()

Method Detail

setFleetInstanceId

public void setFleetInstanceId(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.

getFleetInstanceId

public String getFleetInstanceId()

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.

withFleetInstanceId

public ConfigureAgentRequest withFleetInstanceId(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.

getMetadata

public Map<String,String> getMetadata()

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:

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.

setMetadata

public void setMetadata(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.

withMetadata

public ConfigureAgentRequest withMetadata(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.

addMetadataEntry

public ConfigureAgentRequest addMetadataEntry(String key,
                                              String value)

Add a single Metadata entry

See Also:

withMetadata(java.util.Map<java.lang.String, java.lang.String>)

clearMetadataEntries

public ConfigureAgentRequest clearMetadataEntries()

Removes all the entries added into Metadata.

Returns:

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

setProfilingGroupName

public void setProfilingGroupName(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.

getProfilingGroupName

public String getProfilingGroupName()

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.

withProfilingGroupName

public ConfigureAgentRequest withProfilingGroupName(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.

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 ConfigureAgentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()