Class Finding

java.lang.Object
software.amazon.awssdk.services.securityagent.model.Finding
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Finding.Builder,Finding>
@Generated("software.amazon.awssdk:codegen") public final class Finding extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Finding.Builder,Finding>

Represents a security vulnerability or issue discovered during testing

See Also:

  • Method Details

    • findingId

      public final String findingId()

      Unique identifier for the finding

      Returns:
      Unique identifier for the finding

    • agentSpaceId

      public final String agentSpaceId()

      Identifier of the agent space that created this finding

      Returns:
      Identifier of the agent space that created this finding

    • pentestId

      public final String pentestId()

      Identifier of the parent pentest

      Returns:
      Identifier of the parent pentest

    • pentestJobId

      public final String pentestJobId()

      Identifier of the pentest job

      Returns:
      Identifier of the pentest job

    • taskId

      public final String taskId()

      Identifier of the associated task

      Returns:
      Identifier of the associated task

    • name

      public final String name()

      Name or title of the finding

      Returns:
      Name or title of the finding

    • description

      public final String description()

      Detailed description of the security vulnerability

      Returns:
      Detailed description of the security vulnerability

    • status

      public final FindingStatus status()

      Current status of the finding

      If the service returns an enum value that is not available in the current SDK version, status will return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the finding
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the finding

      If the service returns an enum value that is not available in the current SDK version, status will return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the finding
      See Also:

    • riskType

      public final String riskType()

      Type of security risk identified

      Returns:
      Type of security risk identified

    • riskLevel

      public final RiskLevel riskLevel()

      Severity level of the identified risk

      If the service returns an enum value that is not available in the current SDK version, riskLevel will return RiskLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from riskLevelAsString().

      Returns:
      Severity level of the identified risk
      See Also:

    • riskLevelAsString

      public final String riskLevelAsString()

      Severity level of the identified risk

      If the service returns an enum value that is not available in the current SDK version, riskLevel will return RiskLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from riskLevelAsString().

      Returns:
      Severity level of the identified risk
      See Also:

    • riskScore

      public final String riskScore()

      Risk score associated with the finding

      Returns:
      Risk score associated with the finding

    • reasoning

      public final String reasoning()

      Justification for the assigned risk score

      Returns:
      Justification for the assigned risk score

    • confidence

      public final ConfidenceLevel confidence()

      Confidence level of the finding

      If the service returns an enum value that is not available in the current SDK version, confidence will return ConfidenceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confidenceAsString().

      Returns:
      Confidence level of the finding
      See Also:

    • confidenceAsString

      public final String confidenceAsString()

      Confidence level of the finding

      If the service returns an enum value that is not available in the current SDK version, confidence will return ConfidenceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confidenceAsString().

      Returns:
      Confidence level of the finding
      See Also:

    • attackScript

      public final String attackScript()

      Proof-of-concept code demonstrating the vulnerability

      Returns:
      Proof-of-concept code demonstrating the vulnerability

    • codeRemediationTask

      public final CodeRemediationTask codeRemediationTask()

      Code remediation task associated with this finding

      Returns:
      Code remediation task associated with this finding

    • lastUpdatedBy

      public final String lastUpdatedBy()

      Identifier of the task or agent that last updated this finding

      Returns:
      Identifier of the task or agent that last updated this finding

    • createdAt

      public final Instant createdAt()

      Timestamp when the finding was created

      Returns:
      Timestamp when the finding was created

    • updatedAt

      public final Instant updatedAt()

      Timestamp when the finding was last updated

      Returns:
      Timestamp when the finding was last updated

    • toBuilder

      public Finding.Builder 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 interface ToCopyableBuilder<Finding.Builder,Finding>
      Returns:
      a builder for type T

    • builder

      public static Finding.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Finding.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.