DescribeResourceScanResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cloudformation.model.DescribeResourceScanResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeResourceScanResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeResourceScanResult()

Constructors
Constructor and Description
`DescribeResourceScanResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeResourceScanResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getEndTime()` The time that the resource scan was finished.
`Double`	`getPercentageCompleted()` The percentage of the resource scan that has been completed.
`String`	`getResourceScanId()` The Amazon Resource Name (ARN) of the resource scan.
`Integer`	`getResourcesRead()` The number of resources that were read.
`Integer`	`getResourcesScanned()` The number of resources that were listed.
`List<String>`	`getResourceTypes()` The list of resource types for the specified scan.
`Date`	`getStartTime()` The time that the resource scan was started.
`String`	`getStatus()` Status of the resource scan.
`String`	`getStatusReason()` The reason for the resource scan status, providing more information if a failure happened.
`int`	`hashCode()`
`void`	`setEndTime(Date endTime)` The time that the resource scan was finished.
`void`	`setPercentageCompleted(Double percentageCompleted)` The percentage of the resource scan that has been completed.
`void`	`setResourceScanId(String resourceScanId)` The Amazon Resource Name (ARN) of the resource scan.
`void`	`setResourcesRead(Integer resourcesRead)` The number of resources that were read.
`void`	`setResourcesScanned(Integer resourcesScanned)` The number of resources that were listed.
`void`	`setResourceTypes(Collection<String> resourceTypes)` The list of resource types for the specified scan.
`void`	`setStartTime(Date startTime)` The time that the resource scan was started.
`void`	`setStatus(String status)` Status of the resource scan.
`void`	`setStatusReason(String statusReason)` The reason for the resource scan status, providing more information if a failure happened.
`String`	`toString()` Returns a string representation of this object.
`DescribeResourceScanResult`	`withEndTime(Date endTime)` The time that the resource scan was finished.
`DescribeResourceScanResult`	`withPercentageCompleted(Double percentageCompleted)` The percentage of the resource scan that has been completed.
`DescribeResourceScanResult`	`withResourceScanId(String resourceScanId)` The Amazon Resource Name (ARN) of the resource scan.
`DescribeResourceScanResult`	`withResourcesRead(Integer resourcesRead)` The number of resources that were read.
`DescribeResourceScanResult`	`withResourcesScanned(Integer resourcesScanned)` The number of resources that were listed.
`DescribeResourceScanResult`	`withResourceTypes(Collection<String> resourceTypes)` The list of resource types for the specified scan.
`DescribeResourceScanResult`	`withResourceTypes(String... resourceTypes)` The list of resource types for the specified scan.
`DescribeResourceScanResult`	`withStartTime(Date startTime)` The time that the resource scan was started.
`DescribeResourceScanResult`	`withStatus(ResourceScanStatus status)` Status of the resource scan.
`DescribeResourceScanResult`	`withStatus(String status)` Status of the resource scan.
`DescribeResourceScanResult`	`withStatusReason(String statusReason)` The reason for the resource scan status, providing more information if a failure happened.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeResourceScanResult
```
public DescribeResourceScanResult()
```
- Method Detail
  - setResourceScanId
```
public void setResourceScanId(String resourceScanId)
```
    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
    
    Parameters:
    
    resourceScanId - The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
  - getResourceScanId
```
public String getResourceScanId()
```
    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
  - withResourceScanId
```
public DescribeResourceScanResult withResourceScanId(String resourceScanId)
```
    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
    
    Parameters:
    
    resourceScanId - The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Parameters:
    
    status - Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    See Also:
    
    ResourceScanStatus
  - getStatus
```
public String getStatus()
```
    Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Returns:
    
    Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    See Also:
    
    ResourceScanStatus
  - withStatus
```
public DescribeResourceScanResult withStatus(String status)
```
    Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Parameters:
    
    status - Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceScanStatus
  - withStatus
```
public DescribeResourceScanResult withStatus(ResourceScanStatus status)
```
    Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Parameters:
    
    status - Status of the resource scan.
    
    INPROGRESS
    
    The resource scan is still in progress.
    
    COMPLETE
    
    The resource scan is complete.
    
    EXPIRED
    
    The resource scan has expired.
    
    FAILED
    
    The resource scan has failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceScanStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The reason for the resource scan status, providing more information if a failure happened.
    
    Parameters:
    
    statusReason - The reason for the resource scan status, providing more information if a failure happened.
  - getStatusReason
```
public String getStatusReason()
```
    The reason for the resource scan status, providing more information if a failure happened.
    
    Returns:
    
    The reason for the resource scan status, providing more information if a failure happened.
  - withStatusReason
```
public DescribeResourceScanResult withStatusReason(String statusReason)
```
    The reason for the resource scan status, providing more information if a failure happened.
    
    Parameters:
    
    statusReason - The reason for the resource scan status, providing more information if a failure happened.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time that the resource scan was started.
    
    Parameters:
    
    startTime - The time that the resource scan was started.
  - getStartTime
```
public Date getStartTime()
```
    The time that the resource scan was started.
    
    Returns:
    
    The time that the resource scan was started.
  - withStartTime
```
public DescribeResourceScanResult withStartTime(Date startTime)
```
    The time that the resource scan was started.
    
    Parameters:
    
    startTime - The time that the resource scan was started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the resource scan was finished.
    
    Parameters:
    
    endTime - The time that the resource scan was finished.
  - getEndTime
```
public Date getEndTime()
```
    The time that the resource scan was finished.
    
    Returns:
    
    The time that the resource scan was finished.
  - withEndTime
```
public DescribeResourceScanResult withEndTime(Date endTime)
```
    The time that the resource scan was finished.
    
    Parameters:
    
    endTime - The time that the resource scan was finished.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPercentageCompleted
```
public void setPercentageCompleted(Double percentageCompleted)
```
    The percentage of the resource scan that has been completed.
    
    Parameters:
    
    percentageCompleted - The percentage of the resource scan that has been completed.
  - getPercentageCompleted
```
public Double getPercentageCompleted()
```
    The percentage of the resource scan that has been completed.
    
    Returns:
    
    The percentage of the resource scan that has been completed.
  - withPercentageCompleted
```
public DescribeResourceScanResult withPercentageCompleted(Double percentageCompleted)
```
    The percentage of the resource scan that has been completed.
    
    Parameters:
    
    percentageCompleted - The percentage of the resource scan that has been completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceTypes
```
public List<String> getResourceTypes()
```
    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    Returns:
    
    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
  - setResourceTypes
```
public void setResourceTypes(Collection<String> resourceTypes)
```
    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    Parameters:
    
    resourceTypes - The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
  - withResourceTypes
```
public DescribeResourceScanResult withResourceTypes(String... resourceTypes)
```
    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTypes(java.util.Collection) or withResourceTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTypes - The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceTypes
```
public DescribeResourceScanResult withResourceTypes(Collection<String> resourceTypes)
```
    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    Parameters:
    
    resourceTypes - The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourcesScanned
```
public void setResourcesScanned(Integer resourcesScanned)
```
    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    Parameters:
    
    resourcesScanned - The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
  - getResourcesScanned
```
public Integer getResourcesScanned()
```
    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    Returns:
    
    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
  - withResourcesScanned
```
public DescribeResourceScanResult withResourcesScanned(Integer resourcesScanned)
```
    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    Parameters:
    
    resourcesScanned - The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourcesRead
```
public void setResourcesRead(Integer resourcesRead)
```
    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
    
    Parameters:
    
    resourcesRead - The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
  - getResourcesRead
```
public Integer getResourcesRead()
```
    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
    
    Returns:
    
    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
  - withResourcesRead
```
public DescribeResourceScanResult withResourcesRead(Integer resourcesRead)
```
    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
    
    Parameters:
    
    resourcesRead - The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
    
    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
    
    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 DescribeResourceScanResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class DescribeResourceScanResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeResourceScanResult

Method Detail

setResourceScanId

getResourceScanId

withResourceScanId

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setPercentageCompleted

getPercentageCompleted

withPercentageCompleted

getResourceTypes

setResourceTypes

withResourceTypes

withResourceTypes

setResourcesScanned

getResourcesScanned

withResourcesScanned

setResourcesRead

getResourcesRead

withResourcesRead

toString

equals

hashCode

clone