Interface FindingSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FindingSummary.Builder,FindingSummary>, SdkBuilder<FindingSummary.Builder,FindingSummary>, SdkPojo
Enclosing class:
FindingSummary
@Mutable @NotThreadSafe public static interface FindingSummary.Builder extends SdkPojo, CopyableBuilder<FindingSummary.Builder,FindingSummary>

  • Method Details

    • findingId

      FindingSummary.Builder findingId(String findingId)

      The unique identifier of the finding.

      Parameters:
      findingId - The unique identifier of the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingArn

      FindingSummary.Builder findingArn(String findingArn)

      The ARN of the finding.

      Parameters:
      findingArn - The ARN of the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentId

      FindingSummary.Builder environmentId(String environmentId)

      The environment that owns the finding.

      Parameters:
      environmentId - The environment that owns the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      FindingSummary.Builder source(String source)

      The system that produced the finding.

      Parameters:
      source - The system that produced the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceFindingId

      FindingSummary.Builder sourceFindingId(String sourceFindingId)

      The producer's own identifier for the finding.

      Parameters:
      sourceFindingId - The producer's own identifier for the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportedAt

      FindingSummary.Builder reportedAt(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • status

      FindingSummary.Builder status(String status)

      The current lifecycle status of the finding.

      Parameters:
      status - The current lifecycle status of the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      FindingSummary.Builder status(FindingStatus status)

      The current lifecycle status of the finding.

      Parameters:
      status - The current lifecycle status of the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusUpdatedAt

      FindingSummary.Builder statusUpdatedAt(Instant statusUpdatedAt)

      The timestamp when the status last transitioned.

      Parameters:
      statusUpdatedAt - The timestamp when the status last transitioned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      FindingSummary.Builder createdAt(Instant createdAt)

      The timestamp when the finding was ingested.

      Parameters:
      createdAt - The timestamp when the finding was ingested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanRunId

      FindingSummary.Builder scanRunId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • statusMessage

      FindingSummary.Builder statusMessage(String statusMessage)

      Human-readable context about the current status.

      Parameters:
      statusMessage - Human-readable context about the current status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • discardReason

      FindingSummary.Builder discardReason(String discardReason)

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

      Parameters:
      discardReason - Why the finding was not escalated. Present only when status is DISCARDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • discardReason

      FindingSummary.Builder discardReason(FindingDiscardReason discardReason)

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

      Parameters:
      discardReason - Why the finding was not escalated. Present only when status is DISCARDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • discardReasoning

      FindingSummary.Builder discardReasoning(String discardReasoning)

      Customer-facing explanation accompanying discardReason.

      Parameters:
      discardReasoning - Customer-facing explanation accompanying discardReason.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • duplicateOfIssueId

      FindingSummary.Builder duplicateOfIssueId(String duplicateOfIssueId)

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

      Parameters:
      duplicateOfIssueId - The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdIssueId

      FindingSummary.Builder createdIssueId(String createdIssueId)

      The issue Continuum created from this finding.

      Parameters:
      createdIssueId - The issue Continuum created from this finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedAt

      FindingSummary.Builder completedAt(Instant completedAt)

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

      Parameters:
      completedAt - When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      FindingSummary.Builder type(String type)

      What kind of finding this is.

      Parameters:
      type - What kind of finding this is.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      FindingSummary.Builder type(FindingType type)

      What kind of finding this is.

      Parameters:
      type - What kind of finding this is.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • title

      FindingSummary.Builder title(String title)

      The producer's title for the finding.

      Parameters:
      title - The producer's title for the finding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severity

      FindingSummary.Builder severity(String severity)

      The finding's severity.

      Parameters:
      severity - The finding's severity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • severity

      FindingSummary.Builder severity(FindingSeverityId severity)

      The finding's severity.

      Parameters:
      severity - The finding's severity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • category

      FindingSummary.Builder category(String category)

      The producer's vulnerability category.

      Parameters:
      category - The producer's vulnerability category.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filePath

      FindingSummary.Builder filePath(String filePath)

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

      Parameters:
      filePath - The file the finding is about, when it has a code location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.