Interface Scan.Builder

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

  • Method Details

    • detectorId

      Scan.Builder detectorId(String detectorId)

      The unique ID of the detector that is associated with the request.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

      Parameters:
      detectorId - The unique ID of the detector that is associated with the request.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminDetectorId

      Scan.Builder adminDetectorId(String adminDetectorId)

      The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

      Parameters:
      adminDetectorId - The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanId

      Scan.Builder scanId(String scanId)

      The unique scan ID associated with a scan entry.

      Parameters:
      scanId - The unique scan ID associated with a scan entry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanStatus

      Scan.Builder scanStatus(String scanStatus)

      An enum value representing possible scan statuses.

      Parameters:
      scanStatus - An enum value representing possible scan statuses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanStatus

      Scan.Builder scanStatus(ScanStatus scanStatus)

      An enum value representing possible scan statuses.

      Parameters:
      scanStatus - An enum value representing possible scan statuses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      Scan.Builder failureReason(String failureReason)

      Represents the reason for FAILED scan status.

      Parameters:
      failureReason - Represents the reason for FAILED scan status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanStartTime

      Scan.Builder scanStartTime(Instant scanStartTime)

      The timestamp of when the scan was triggered.

      Parameters:
      scanStartTime - The timestamp of when the scan was triggered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanEndTime

      Scan.Builder scanEndTime(Instant scanEndTime)

      The timestamp of when the scan was finished.

      Parameters:
      scanEndTime - The timestamp of when the scan was finished.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerDetails

      Scan.Builder triggerDetails(TriggerDetails triggerDetails)

      Specifies the reason why the scan was initiated.

      Parameters:
      triggerDetails - Specifies the reason why the scan was initiated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerDetails

      default Scan.Builder triggerDetails(Consumer<TriggerDetails.Builder> triggerDetails)

      Specifies the reason why the scan was initiated.

      This is a convenience method that creates an instance of the TriggerDetails.Builder avoiding the need to create one manually via TriggerDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to triggerDetails(TriggerDetails).

      Parameters:
      triggerDetails - a consumer that will call methods on TriggerDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceDetails

      Scan.Builder resourceDetails(ResourceDetails resourceDetails)

      Represents the resources that were scanned in the scan entry.

      Parameters:
      resourceDetails - Represents the resources that were scanned in the scan entry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceDetails

      default Scan.Builder resourceDetails(Consumer<ResourceDetails.Builder> resourceDetails)

      Represents the resources that were scanned in the scan entry.

      This is a convenience method that creates an instance of the ResourceDetails.Builder avoiding the need to create one manually via ResourceDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceDetails(ResourceDetails).

      Parameters:
      resourceDetails - a consumer that will call methods on ResourceDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanResultDetails

      Scan.Builder scanResultDetails(ScanResultDetails scanResultDetails)

      Represents the result of the scan.

      Parameters:
      scanResultDetails - Represents the result of the scan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanResultDetails

      default Scan.Builder scanResultDetails(Consumer<ScanResultDetails.Builder> scanResultDetails)

      Represents the result of the scan.

      This is a convenience method that creates an instance of the ScanResultDetails.Builder avoiding the need to create one manually via ScanResultDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scanResultDetails(ScanResultDetails).

      Parameters:
      scanResultDetails - a consumer that will call methods on ScanResultDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accountId

      Scan.Builder accountId(String accountId)

      The ID for the account that belongs to the scan.

      Parameters:
      accountId - The ID for the account that belongs to the scan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalBytes

      Scan.Builder totalBytes(Long totalBytes)

      Represents total bytes that were scanned.

      Parameters:
      totalBytes - Represents total bytes that were scanned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileCount

      Scan.Builder fileCount(Long fileCount)

      Represents the number of files that were scanned.

      Parameters:
      fileCount - Represents the number of files that were scanned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachedVolumes

      Scan.Builder attachedVolumes(Collection<VolumeDetail> attachedVolumes)

      List of volumes that were attached to the original instance to be scanned.

      Parameters:
      attachedVolumes - List of volumes that were attached to the original instance to be scanned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachedVolumes

      Scan.Builder attachedVolumes(VolumeDetail... attachedVolumes)

      List of volumes that were attached to the original instance to be scanned.

      Parameters:
      attachedVolumes - List of volumes that were attached to the original instance to be scanned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachedVolumes

      Scan.Builder attachedVolumes(Consumer<VolumeDetail.Builder>... attachedVolumes)

      List of volumes that were attached to the original instance to be scanned.

      This is a convenience method that creates an instance of the VolumeDetail.Builder avoiding the need to create one manually via VolumeDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachedVolumes(List<VolumeDetail>).

      Parameters:
      attachedVolumes - a consumer that will call methods on VolumeDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanType

      Scan.Builder scanType(String scanType)

      Specifies the scan type that invoked the malware scan.

      Parameters:
      scanType - Specifies the scan type that invoked the malware scan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanType

      Scan.Builder scanType(ScanType scanType)

      Specifies the scan type that invoked the malware scan.

      Parameters:
      scanType - Specifies the scan type that invoked the malware scan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: