software.amazon.awssdk.services.inspector.model

Class AssessmentRunAgent

java.lang.Object

software.amazon.awssdk.services.inspector.model.AssessmentRunAgent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssessmentRunAgent.Builder,AssessmentRunAgent>

@Generated(value="software.amazon.awssdk:codegen")
public final class AssessmentRunAgent
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssessmentRunAgent.Builder

Method Summary

Modifier and Type	Method and Description
AgentHealth	agentHealth() The current health state of the agent.
String	agentHealthAsString() The current health state of the agent.
AgentHealthCode	agentHealthCode() The detailed health state of the agent.
String	agentHealthCodeAsString() The detailed health state of the agent.
String	agentHealthDetails() The description for the agent health code.
String	agentId() The AWS account of the EC2 instance where the agent is installed.
String	assessmentRunArn() The ARN of the assessment run that is associated with the agent.
String	autoScalingGroup() The Auto Scaling group of the EC2 instance that is specified by the agent ID.
static AssessmentRunAgent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTelemetryMetadata() For responses, this returns true if the service returned a value for the TelemetryMetadata property.
List<SdkField<?>>	sdkFields()
static Class<? extends AssessmentRunAgent.Builder>	serializableBuilderClass()
List<TelemetryMetadata>	telemetryMetadata() The Amazon Inspector application data metrics that are collected by the agent.
AssessmentRunAgent.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

agentId

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

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

public final AgentHealth 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 return AgentHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentHealthAsString().

Returns:

The current health state of the agent.

See Also:

AgentHealth

agentHealthAsString

public final String 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 return AgentHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentHealthAsString().

Returns:

The current health state of the agent.

See Also:

AgentHealth

agentHealthCode

public final AgentHealthCode 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 return AgentHealthCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentHealthCodeAsString().

Returns:

The detailed health state of the agent.

See Also:

AgentHealthCode

agentHealthCodeAsString

public final String 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 return AgentHealthCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentHealthCodeAsString().

Returns:

The detailed health state of the agent.

See Also:

AgentHealthCode

agentHealthDetails

public final String agentHealthDetails()

The description for the agent health code.

Returns:

The description for the agent health code.

autoScalingGroup

public final String 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 the isEmpty() 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

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

public AssessmentRunAgent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssessmentRunAgent.Builder,AssessmentRunAgent>

builder

public static AssessmentRunAgent.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo