Package software.amazon.awssdk.services.guardduty.model

Class Scan

    • Method Detail

      • detectorId

        public final String detectorId()

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

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

      • adminDetectorId

        public final String adminDetectorId()

        The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for DetectorId if the account is an administrator.

        Returns:
        The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for DetectorId if the account is an administrator.

      • scanId

        public final String scanId()

        The unique scan ID associated with a scan entry.

        Returns:
        The unique scan ID associated with a scan entry.

      • scanStatusAsString

        public final String scanStatusAsString()

        An enum value representing possible scan statuses.

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

        Returns:
        An enum value representing possible scan statuses.
        See Also:
        ScanStatus

      • failureReason

        public final String failureReason()

        Represents the reason for FAILED scan status.

        Returns:
        Represents the reason for FAILED scan status.

      • scanStartTime

        public final Instant scanStartTime()

        The timestamp of when the scan was triggered.

        Returns:
        The timestamp of when the scan was triggered.

      • scanEndTime

        public final Instant scanEndTime()

        The timestamp of when the scan was finished.

        Returns:
        The timestamp of when the scan was finished.

      • triggerDetails

        public final TriggerDetails triggerDetails()

        Specifies the reason why the scan was initiated.

        Returns:
        Specifies the reason why the scan was initiated.

      • resourceDetails

        public final ResourceDetails resourceDetails()

        Represents the resources that were scanned in the scan entry.

        Returns:
        Represents the resources that were scanned in the scan entry.

      • scanResultDetails

        public final ScanResultDetails scanResultDetails()

        Represents the result of the scan.

        Returns:
        Represents the result of the scan.

      • accountId

        public final String accountId()

        The ID for the account that belongs to the scan.

        Returns:
        The ID for the account that belongs to the scan.

      • totalBytes

        public final Long totalBytes()

        Represents total bytes that were scanned.

        Returns:
        Represents total bytes that were scanned.

      • fileCount

        public final Long fileCount()

        Represents the number of files that were scanned.

        Returns:
        Represents the number of files that were scanned.

      • hasAttachedVolumes

        public final boolean hasAttachedVolumes()
        For responses, this returns true if the service returned a value for the AttachedVolumes 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.

      • attachedVolumes

        public final List<VolumeDetail> attachedVolumes()

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

        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 hasAttachedVolumes() method.

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

      • scanType

        public final ScanType scanType()

        Specifies the scan type that invoked the malware scan.

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

        Returns:
        Specifies the scan type that invoked the malware scan.
        See Also:
        ScanType

      • scanTypeAsString

        public final String scanTypeAsString()

        Specifies the scan type that invoked the malware scan.

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

        Returns:
        Specifies the scan type that invoked the malware scan.
        See Also:
        ScanType

      • serializableBuilderClass

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)