java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
    - - software.amazon.awssdk.services.cloudformation.model.DescribeResourceScanResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeResourceScanResponse
extends CloudFormationResponse
implements ToCopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeResourceScanResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeResourceScanResponse.Builder`	`builder()`
`Instant`	`endTime()`	The time that the resource scan was finished.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasResourceTypes()`	For responses, this returns true if the service returned a value for the ResourceTypes property.
`Double`	`percentageCompleted()`	The percentage of the resource scan that has been completed.
`String`	`resourceScanId()`	The Amazon Resource Name (ARN) of the resource scan.
`Integer`	`resourcesRead()`	The number of resources that were read.
`Integer`	`resourcesScanned()`	The number of resources that were listed.
`List<String>`	`resourceTypes()`	The list of resource types for the specified scan.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeResourceScanResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The time that the resource scan was started.
`ResourceScanStatus`	`status()`	Status of the resource scan.
`String`	`statusAsString()`	Status of the resource scan.
`String`	`statusReason()`	The reason for the resource scan status, providing more information if a failure happened.
`DescribeResourceScanResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - resourceScanId
```
public final 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 .
    
    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 .
  - status
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceScanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusAsString
```
public final String statusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceScanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusReason
```
public final String statusReason()
```
    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.
  - startTime
```
public final Instant startTime()
```
    The time that the resource scan was started.
    
    Returns:
    
    The time that the resource scan was started.
  - endTime
```
public final Instant endTime()
```
    The time that the resource scan was finished.
    
    Returns:
    
    The time that the resource scan was finished.
  - percentageCompleted
```
public final Double percentageCompleted()
```
    The percentage of the resource scan that has been completed.
    
    Returns:
    
    The percentage of the resource scan that has been completed.
  - hasResourceTypes
```
public final boolean hasResourceTypes()
```
    For responses, this returns true if the service returned a value for the ResourceTypes 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.
  - resourceTypes
```
public final List<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 .
    
    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 hasResourceTypes() method.
    
    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 .
  - resourcesScanned
```
public final Integer resourcesScanned()
```
    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 .
  - resourcesRead
```
public final 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.
    
    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.
  - toBuilder
```
public DescribeResourceScanResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeResourceScanResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeResourceScanResponse.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeResourceScanResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resourceScanId

status

statusAsString

statusReason

startTime

endTime

percentageCompleted

hasResourceTypes

resourceTypes

resourcesScanned

resourcesRead

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields