Class ConfigureAgentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ConfigureAgentRequest.Builder,
ConfigureAgentRequest>
The structure representing the configureAgentRequest.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A universally unique identifier (UUID) for a profiling instance.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Metadata property.final Map
<MetadataField, String> metadata()
Metadata captured about the compute platform the agent is running on.Metadata captured about the compute platform the agent is running on.final String
The name of the profiling group for which the configured agent is collecting profiling data.static Class
<? extends ConfigureAgentRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetadata()
method.- 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()For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetadata()
method.- 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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConfigureAgentRequest.Builder,
ConfigureAgentRequest> - Specified by:
toBuilder
in classCodeGuruProfilerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-