Class GetMalwareScanResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.guardduty.model.GuardDutyResponse
software.amazon.awssdk.services.guardduty.model.GetMalwareScanResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMalwareScanResponse.Builder,GetMalwareScanResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMalwareScanResponse extends GuardDutyResponse implements ToCopyableBuilder<GetMalwareScanResponse.Builder,GetMalwareScanResponse>

  • Method Details

    • scanId

      public final String scanId()

      A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

      Returns:
      A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

    • detectorId

      public final String detectorId()

      The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.

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

      Returns:
      The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.

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

    • adminDetectorId

      public final 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. If the customer is not a GuardDuty customer, this field will not be present..

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

      Returns:
      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. If the customer is not a GuardDuty customer, this field will not be present. .

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

    • resourceArn

      public final String resourceArn()

      Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.

      Returns:
      Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.

    • resourceType

      public final MalwareProtectionResourceType resourceType()

      The type of resource that was scanned for malware.

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

      Returns:
      The type of resource that was scanned for malware.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource that was scanned for malware.

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

      Returns:
      The type of resource that was scanned for malware.
      See Also:

    • scannedResourcesCount

      public final Integer scannedResourcesCount()

      The total number of resources that were successfully scanned. This is dependent on the resource type.

      Returns:
      The total number of resources that were successfully scanned. This is dependent on the resource type.

    • skippedResourcesCount

      public final Integer skippedResourcesCount()

      The total number of resources that were skipped during the scan.

      Returns:
      The total number of resources that were skipped during the scan.

    • failedResourcesCount

      public final Integer failedResourcesCount()

      The total number of resources that failed to be scanned.

      Returns:
      The total number of resources that failed to be scanned.

    • hasScannedResources

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

    • scannedResources

      public final List<ScannedResource> scannedResources()

      A list of resources along with their metadata that were scanned as part of the malware scan operation.

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

      Returns:
      A list of resources along with their metadata that were scanned as part of the malware scan operation.

    • scanConfiguration

      public final ScanConfiguration scanConfiguration()

      Information about the scan configuration used for the malware scan.

      Returns:
      Information about the scan configuration used for the malware scan.

    • scanCategory

      public final ScanCategory scanCategory()

      The category of the malware scan, indicating the type of scan performed.

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

      Returns:
      The category of the malware scan, indicating the type of scan performed.
      See Also:

    • scanCategoryAsString

      public final String scanCategoryAsString()

      The category of the malware scan, indicating the type of scan performed.

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

      Returns:
      The category of the malware scan, indicating the type of scan performed.
      See Also:

    • scanStatus

      public final MalwareProtectionScanStatus scanStatus()

      A value representing the current status of the malware scan.

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

      Returns:
      A value representing the current status of the malware scan.
      See Also:

    • scanStatusAsString

      public final String scanStatusAsString()

      A value representing the current status of the malware scan.

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

      Returns:
      A value representing the current status of the malware scan.
      See Also:

    • scanStatusReason

      public final ScanStatusReason scanStatusReason()

      Represents the reason for the current scan status, if applicable.

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

      Returns:
      Represents the reason for the current scan status, if applicable.
      See Also:

    • scanStatusReasonAsString

      public final String scanStatusReasonAsString()

      Represents the reason for the current scan status, if applicable.

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

      Returns:
      Represents the reason for the current scan status, if applicable.
      See Also:

    • scanType

      public final MalwareProtectionScanType scanType()

      A value representing the initiator of the scan.

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

      Returns:
      A value representing the initiator of the scan.
      See Also:

    • scanTypeAsString

      public final String scanTypeAsString()

      A value representing the initiator of the scan.

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

      Returns:
      A value representing the initiator of the scan.
      See Also:

    • scanStartedAt

      public final Instant scanStartedAt()

      The timestamp representing when the malware scan was started.

      Returns:
      The timestamp representing when the malware scan was started.

    • scanCompletedAt

      public final Instant scanCompletedAt()

      The timestamp representing when the malware scan was completed.

      Returns:
      The timestamp representing when the malware scan was completed.

    • scanResultDetails

      public final GetMalwareScanResultDetails scanResultDetails()

      Detailed information about the results of the malware scan, if the scan completed.

      Returns:
      Detailed information about the results of the malware scan, if the scan completed.

    • toBuilder

      public GetMalwareScanResponse.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<GetMalwareScanResponse.Builder,GetMalwareScanResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetMalwareScanResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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