Class AssessmentRunAgent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssessmentRunAgent.Builder,
AssessmentRunAgent>
Contains information about an Amazon Inspector agent. This data type is used as a response element in the ListAssessmentRunAgents action.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AgentHealth
The current health state of the agent.final String
The current health state of the agent.final AgentHealthCode
The detailed health state of the agent.final String
The detailed health state of the agent.final String
The description for the agent health code.final String
agentId()
The AWS account of the EC2 instance where the agent is installed.final String
The ARN of the assessment run that is associated with the agent.final String
The Auto Scaling group of the EC2 instance that is specified by the agent ID.static AssessmentRunAgent.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TelemetryMetadata property.static Class
<? extends AssessmentRunAgent.Builder> final List
<TelemetryMetadata> The Amazon Inspector application data metrics that are collected by the agent.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentId
The AWS account of the EC2 instance where the agent is installed.
- Returns:
- The AWS account of the EC2 instance where the agent is installed.
-
assessmentRunArn
The ARN of the assessment run that is associated with the agent.
- Returns:
- The ARN of the assessment run that is associated with the agent.
-
agentHealth
The current health state of the agent.
If the service returns an enum value that is not available in the current SDK version,
agentHealth
will returnAgentHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentHealthAsString()
.- Returns:
- The current health state of the agent.
- See Also:
-
agentHealthAsString
The current health state of the agent.
If the service returns an enum value that is not available in the current SDK version,
agentHealth
will returnAgentHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentHealthAsString()
.- Returns:
- The current health state of the agent.
- See Also:
-
agentHealthCode
The detailed health state of the agent.
If the service returns an enum value that is not available in the current SDK version,
agentHealthCode
will returnAgentHealthCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentHealthCodeAsString()
.- Returns:
- The detailed health state of the agent.
- See Also:
-
agentHealthCodeAsString
The detailed health state of the agent.
If the service returns an enum value that is not available in the current SDK version,
agentHealthCode
will returnAgentHealthCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentHealthCodeAsString()
.- Returns:
- The detailed health state of the agent.
- See Also:
-
agentHealthDetails
The description for the agent health code.
- Returns:
- The description for the agent health code.
-
autoScalingGroup
The Auto Scaling group of the EC2 instance that is specified by the agent ID.
- Returns:
- The Auto Scaling group of the EC2 instance that is specified by the agent ID.
-
hasTelemetryMetadata
public final boolean hasTelemetryMetadata()For responses, this returns true if the service returned a value for the TelemetryMetadata 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. -
telemetryMetadata
The Amazon Inspector application data metrics that are collected by the agent.
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
hasTelemetryMetadata()
method.- Returns:
- The Amazon Inspector application data metrics that are collected by the agent.
-
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<AssessmentRunAgent.Builder,
AssessmentRunAgent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-