Class ScanResult

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

Contains the results of a security scan, including scanner information, scan state, and any findings discovered.

See Also:

  • Method Details

    • malwareScanner

      public final MalwareScanner malwareScanner()

      The malware scanner used to perform the scan. Currently only GUARDDUTY is supported.

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

      Returns:
      The malware scanner used to perform the scan. Currently only GUARDDUTY is supported.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      The malware scanner used to perform the scan. Currently only GUARDDUTY is supported.

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

      Returns:
      The malware scanner used to perform the scan. Currently only GUARDDUTY is supported.
      See Also:

    • scanJobState

      public final ScanJobState scanJobState()

      The final state of the scan job.

      Valid values: COMPLETED | FAILED | CANCELED.

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

      Returns:
      The final state of the scan job.

      Valid values: COMPLETED | FAILED | CANCELED.

      See Also:

    • scanJobStateAsString

      public final String scanJobStateAsString()

      The final state of the scan job.

      Valid values: COMPLETED | FAILED | CANCELED.

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

      Returns:
      The final state of the scan job.

      Valid values: COMPLETED | FAILED | CANCELED.

      See Also:

    • lastScanTimestamp

      public final Instant lastScanTimestamp()

      The timestamp of when the last scan was performed, in Unix format and Coordinated Universal Time (UTC).

      Returns:
      The timestamp of when the last scan was performed, in Unix format and Coordinated Universal Time (UTC).

    • findings

      public final List<ScanFinding> findings()

      An array of findings discovered during the scan.

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

      Returns:
      An array of findings discovered during the scan.

    • hasFindings

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

    • findingsAsStrings

      public final List<String> findingsAsStrings()

      An array of findings discovered during the scan.

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

      Returns:
      An array of findings discovered during the scan.

    • toBuilder

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

    • builder

      public static ScanResult.Builder builder()

    • serializableBuilderClass

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