Class FindingSummary

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

A summary of a finding returned in list responses. Shares FindingLifecycleFields with the read operations so the list and get projections cannot drift. Carries a lean content subset -- fetch the finding for its full contents.

See Also:

  • Method Details

    • findingId

      public final String findingId()

      The unique identifier of the finding.

      Returns:
      The unique identifier of the finding.

    • findingArn

      public final String findingArn()

      The ARN of the finding.

      Returns:
      The ARN of the finding.

    • environmentId

      public final String environmentId()

      The environment that owns the finding.

      Returns:
      The environment that owns the finding.

    • source

      public final String source()

      The system that produced the finding.

      Returns:
      The system that produced the finding.

    • sourceFindingId

      public final String sourceFindingId()

      The producer's own identifier for the finding.

      Returns:
      The producer's own identifier for the finding.

    • reportedAt

      public final Instant reportedAt()

      When the producer reported the finding -- its own clock, which is not Continuum's ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one.

      For CreateCodeFinding, this is the submitted OCSF document's own top-level time. For findings Continuum's scanner produces, it is the finding's own creation time.

      Continuum does not validate it for plausibility: a producer's value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.

      Returns:
      When the producer reported the finding -- its own clock, which is not Continuum's ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one.

      For CreateCodeFinding, this is the submitted OCSF document's own top-level time. For findings Continuum's scanner produces, it is the finding's own creation time.

      Continuum does not validate it for plausibility: a producer's value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.

    • status

      public final FindingStatus status()

      The current lifecycle 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:
      The current lifecycle status of the finding.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle 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:
      The current lifecycle status of the finding.
      See Also:

    • statusUpdatedAt

      public final Instant statusUpdatedAt()

      The timestamp when the status last transitioned.

      Returns:
      The timestamp when the status last transitioned.

    • createdAt

      public final Instant createdAt()

      The timestamp when the finding was ingested.

      Returns:
      The timestamp when the finding was ingested.

    • scanRunId

      public final String scanRunId()

      The scan that produced the finding, when it came from one. For a finding Continuum's scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document's metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.

      Returns:
      The scan that produced the finding, when it came from one. For a finding Continuum's scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document's metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.

    • statusMessage

      public final String statusMessage()

      Human-readable context about the current status.

      Returns:
      Human-readable context about the current status.

    • discardReason

      public final FindingDiscardReason discardReason()

      Why the finding was not escalated. Present only when status is DISCARDED.

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

      Returns:
      Why the finding was not escalated. Present only when status is DISCARDED.
      See Also:

    • discardReasonAsString

      public final String discardReasonAsString()

      Why the finding was not escalated. Present only when status is DISCARDED.

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

      Returns:
      Why the finding was not escalated. Present only when status is DISCARDED.
      See Also:

    • discardReasoning

      public final String discardReasoning()

      Customer-facing explanation accompanying discardReason.

      Returns:
      Customer-facing explanation accompanying discardReason.

    • duplicateOfIssueId

      public final String duplicateOfIssueId()

      The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

      Returns:
      The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.

    • createdIssueId

      public final String createdIssueId()

      The issue Continuum created from this finding.

      Returns:
      The issue Continuum created from this finding.

    • completedAt

      public final Instant completedAt()

      When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

      Returns:
      When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.

    • type

      public final FindingType type()

      What kind of finding this is.

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

      Returns:
      What kind of finding this is.
      See Also:

    • typeAsString

      public final String typeAsString()

      What kind of finding this is.

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

      Returns:
      What kind of finding this is.
      See Also:

    • title

      public final String title()

      The producer's title for the finding.

      Returns:
      The producer's title for the finding.

    • severity

      public final FindingSeverityId severity()

      The finding's severity.

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

      Returns:
      The finding's severity.
      See Also:

    • severityAsString

      public final String severityAsString()

      The finding's severity.

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

      Returns:
      The finding's severity.
      See Also:

    • category

      public final String category()

      The producer's vulnerability category.

      Returns:
      The producer's vulnerability category.

    • filePath

      public final String filePath()

      The file the finding is about, when it has a code location.

      Returns:
      The file the finding is about, when it has a code location.

    • toBuilder

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

    • builder

      public static FindingSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FindingSummary.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.