Scan (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.guardduty.model.Scan

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Scan
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a malware scan.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Scan()

Constructors
Constructor and Description
`Scan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Scan`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The ID for the account that belongs to the scan.
`String`	`getAdminDetectorId()` The unique detector ID of the administrator account that the request is associated with.
`List<VolumeDetail>`	`getAttachedVolumes()` List of volumes that were attached to the original instance to be scanned.
`String`	`getDetectorId()` The unique ID of the detector that the request is associated with.
`String`	`getFailureReason()` Represents the reason for FAILED scan status.
`Long`	`getFileCount()` Represents the number of files that were scanned.
`ResourceDetails`	`getResourceDetails()` Represents the resources that were scanned in the scan entry.
`Date`	`getScanEndTime()` The timestamp of when the scan was finished.
`String`	`getScanId()` The unique scan ID associated with a scan entry.
`ScanResultDetails`	`getScanResultDetails()` Represents the result of the scan.
`Date`	`getScanStartTime()` The timestamp of when the scan was triggered.
`String`	`getScanStatus()` An enum value representing possible scan statuses.
`Long`	`getTotalBytes()` Represents total bytes that were scanned.
`TriggerDetails`	`getTriggerDetails()` Represents the reason the scan was triggered.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The ID for the account that belongs to the scan.
`void`	`setAdminDetectorId(String adminDetectorId)` The unique detector ID of the administrator account that the request is associated with.
`void`	`setAttachedVolumes(Collection<VolumeDetail> attachedVolumes)` List of volumes that were attached to the original instance to be scanned.
`void`	`setDetectorId(String detectorId)` The unique ID of the detector that the request is associated with.
`void`	`setFailureReason(String failureReason)` Represents the reason for FAILED scan status.
`void`	`setFileCount(Long fileCount)` Represents the number of files that were scanned.
`void`	`setResourceDetails(ResourceDetails resourceDetails)` Represents the resources that were scanned in the scan entry.
`void`	`setScanEndTime(Date scanEndTime)` The timestamp of when the scan was finished.
`void`	`setScanId(String scanId)` The unique scan ID associated with a scan entry.
`void`	`setScanResultDetails(ScanResultDetails scanResultDetails)` Represents the result of the scan.
`void`	`setScanStartTime(Date scanStartTime)` The timestamp of when the scan was triggered.
`void`	`setScanStatus(String scanStatus)` An enum value representing possible scan statuses.
`void`	`setTotalBytes(Long totalBytes)` Represents total bytes that were scanned.
`void`	`setTriggerDetails(TriggerDetails triggerDetails)` Represents the reason the scan was triggered.
`String`	`toString()` Returns a string representation of this object.
`Scan`	`withAccountId(String accountId)` The ID for the account that belongs to the scan.
`Scan`	`withAdminDetectorId(String adminDetectorId)` The unique detector ID of the administrator account that the request is associated with.
`Scan`	`withAttachedVolumes(Collection<VolumeDetail> attachedVolumes)` List of volumes that were attached to the original instance to be scanned.
`Scan`	`withAttachedVolumes(VolumeDetail... attachedVolumes)` List of volumes that were attached to the original instance to be scanned.
`Scan`	`withDetectorId(String detectorId)` The unique ID of the detector that the request is associated with.
`Scan`	`withFailureReason(String failureReason)` Represents the reason for FAILED scan status.
`Scan`	`withFileCount(Long fileCount)` Represents the number of files that were scanned.
`Scan`	`withResourceDetails(ResourceDetails resourceDetails)` Represents the resources that were scanned in the scan entry.
`Scan`	`withScanEndTime(Date scanEndTime)` The timestamp of when the scan was finished.
`Scan`	`withScanId(String scanId)` The unique scan ID associated with a scan entry.
`Scan`	`withScanResultDetails(ScanResultDetails scanResultDetails)` Represents the result of the scan.
`Scan`	`withScanStartTime(Date scanStartTime)` The timestamp of when the scan was triggered.
`Scan`	`withScanStatus(ScanStatus scanStatus)` An enum value representing possible scan statuses.
`Scan`	`withScanStatus(String scanStatus)` An enum value representing possible scan statuses.
`Scan`	`withTotalBytes(Long totalBytes)` Represents total bytes that were scanned.
`Scan`	`withTriggerDetails(TriggerDetails triggerDetails)` Represents the reason the scan was triggered.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Scan
```
public Scan()
```
- Method Detail
  - setDetectorId
```
public void setDetectorId(String detectorId)
```
    The unique ID of the detector that the request is associated with.
    
    Parameters:
    
    detectorId - The unique ID of the detector that the request is associated with.
  - getDetectorId
```
public String getDetectorId()
```
    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.
  - withDetectorId
```
public Scan withDetectorId(String detectorId)
```
    The unique ID of the detector that the request is associated with.
    
    Parameters:
    
    detectorId - The unique ID of the detector that the request is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdminDetectorId
```
public void setAdminDetectorId(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.
    
    Parameters:
    
    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.
  - getAdminDetectorId
```
public String getAdminDetectorId()
```
    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.
  - withAdminDetectorId
```
public Scan withAdminDetectorId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScanId
```
public void setScanId(String scanId)
```
    The unique scan ID associated with a scan entry.
    
    Parameters:
    
    scanId - The unique scan ID associated with a scan entry.
  - getScanId
```
public String getScanId()
```
    The unique scan ID associated with a scan entry.
    
    Returns:
    
    The unique scan ID associated with a scan entry.
  - withScanId
```
public Scan withScanId(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.
  - setScanStatus
```
public void setScanStatus(String scanStatus)
```
    An enum value representing possible scan statuses.
    
    Parameters:
    
    scanStatus - An enum value representing possible scan statuses.
    
    See Also:
    
    ScanStatus
  - getScanStatus
```
public String getScanStatus()
```
    An enum value representing possible scan statuses.
    
    Returns:
    
    An enum value representing possible scan statuses.
    
    See Also:
    
    ScanStatus
  - withScanStatus
```
public Scan withScanStatus(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
  - withScanStatus
```
public Scan withScanStatus(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:
    
    ScanStatus
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    Represents the reason for FAILED scan status.
    
    Parameters:
    
    failureReason - Represents the reason for FAILED scan status.
  - getFailureReason
```
public String getFailureReason()
```
    Represents the reason for FAILED scan status.
    
    Returns:
    
    Represents the reason for FAILED scan status.
  - withFailureReason
```
public Scan withFailureReason(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.
  - setScanStartTime
```
public void setScanStartTime(Date scanStartTime)
```
    The timestamp of when the scan was triggered.
    
    Parameters:
    
    scanStartTime - The timestamp of when the scan was triggered.
  - getScanStartTime
```
public Date getScanStartTime()
```
    The timestamp of when the scan was triggered.
    
    Returns:
    
    The timestamp of when the scan was triggered.
  - withScanStartTime
```
public Scan withScanStartTime(Date 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.
  - setScanEndTime
```
public void setScanEndTime(Date scanEndTime)
```
    The timestamp of when the scan was finished.
    
    Parameters:
    
    scanEndTime - The timestamp of when the scan was finished.
  - getScanEndTime
```
public Date getScanEndTime()
```
    The timestamp of when the scan was finished.
    
    Returns:
    
    The timestamp of when the scan was finished.
  - withScanEndTime
```
public Scan withScanEndTime(Date 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.
  - setTriggerDetails
```
public void setTriggerDetails(TriggerDetails triggerDetails)
```
    Represents the reason the scan was triggered.
    
    Parameters:
    
    triggerDetails - Represents the reason the scan was triggered.
  - getTriggerDetails
```
public TriggerDetails getTriggerDetails()
```
    Represents the reason the scan was triggered.
    
    Returns:
    
    Represents the reason the scan was triggered.
  - withTriggerDetails
```
public Scan withTriggerDetails(TriggerDetails triggerDetails)
```
    Represents the reason the scan was triggered.
    
    Parameters:
    
    triggerDetails - Represents the reason the scan was triggered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceDetails
```
public void setResourceDetails(ResourceDetails resourceDetails)
```
    Represents the resources that were scanned in the scan entry.
    
    Parameters:
    
    resourceDetails - Represents the resources that were scanned in the scan entry.
  - getResourceDetails
```
public ResourceDetails getResourceDetails()
```
    Represents the resources that were scanned in the scan entry.
    
    Returns:
    
    Represents the resources that were scanned in the scan entry.
  - withResourceDetails
```
public Scan withResourceDetails(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.
  - setScanResultDetails
```
public void setScanResultDetails(ScanResultDetails scanResultDetails)
```
    Represents the result of the scan.
    
    Parameters:
    
    scanResultDetails - Represents the result of the scan.
  - getScanResultDetails
```
public ScanResultDetails getScanResultDetails()
```
    Represents the result of the scan.
    
    Returns:
    
    Represents the result of the scan.
  - withScanResultDetails
```
public Scan withScanResultDetails(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.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The ID for the account that belongs to the scan.
    
    Parameters:
    
    accountId - The ID for the account that belongs to the scan.
  - getAccountId
```
public String getAccountId()
```
    The ID for the account that belongs to the scan.
    
    Returns:
    
    The ID for the account that belongs to the scan.
  - withAccountId
```
public Scan withAccountId(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.
  - setTotalBytes
```
public void setTotalBytes(Long totalBytes)
```
    Represents total bytes that were scanned.
    
    Parameters:
    
    totalBytes - Represents total bytes that were scanned.
  - getTotalBytes
```
public Long getTotalBytes()
```
    Represents total bytes that were scanned.
    
    Returns:
    
    Represents total bytes that were scanned.
  - withTotalBytes
```
public Scan withTotalBytes(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.
  - setFileCount
```
public void setFileCount(Long fileCount)
```
    Represents the number of files that were scanned.
    
    Parameters:
    
    fileCount - Represents the number of files that were scanned.
  - getFileCount
```
public Long getFileCount()
```
    Represents the number of files that were scanned.
    
    Returns:
    
    Represents the number of files that were scanned.
  - withFileCount
```
public Scan withFileCount(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.
  - getAttachedVolumes
```
public List<VolumeDetail> getAttachedVolumes()
```
    List of volumes that were attached to the original instance to be scanned.
    
    Returns:
    
    List of volumes that were attached to the original instance to be scanned.
  - setAttachedVolumes
```
public void setAttachedVolumes(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.
  - withAttachedVolumes
```
public Scan withAttachedVolumes(VolumeDetail... attachedVolumes)
```
    List of volumes that were attached to the original instance to be scanned.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachedVolumes(java.util.Collection) or withAttachedVolumes(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAttachedVolumes
```
public Scan withAttachedVolumes(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Scan clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Scan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scan

Method Detail

setDetectorId

getDetectorId

withDetectorId

setAdminDetectorId

getAdminDetectorId

withAdminDetectorId

setScanId

getScanId

withScanId

setScanStatus

getScanStatus

withScanStatus

withScanStatus

setFailureReason

getFailureReason

withFailureReason

setScanStartTime

getScanStartTime

withScanStartTime

setScanEndTime

getScanEndTime

withScanEndTime

setTriggerDetails

getTriggerDetails

withTriggerDetails

setResourceDetails

getResourceDetails

withResourceDetails

setScanResultDetails

getScanResultDetails

withScanResultDetails

setAccountId

getAccountId

withAccountId

setTotalBytes

getTotalBytes

withTotalBytes

setFileCount

getFileCount

withFileCount

getAttachedVolumes

setAttachedVolumes

withAttachedVolumes

withAttachedVolumes

toString

equals

hashCode

clone

marshall