Package software.amazon.awssdk.services.cloudformation.model

Class ResourceScanSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ResourceScanSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceScanSummary.Builder,ResourceScanSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ResourceScanSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceScanSummary.Builder,ResourceScanSummary>

A summary of the resource scan. This is returned by the ListResourceScan API action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceScanSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceScanSummary.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()
Double	percentageCompleted()	The percentage of the resource scan that has been completed.
String	resourceScanId()	The Amazon Resource Name (ARN) of the resource scan.
ScanType	scanType()	The scan type that has been completed.
String	scanTypeAsString()	The scan type that has been completed.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceScanSummary.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.
ResourceScanSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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.

Returns:

The Amazon Resource Name (ARN) of the resource scan.

status

public final ResourceScanStatus status()

Status of the resource scan.

IN_PROGRESS

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.

IN_PROGRESS

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.

IN_PROGRESS

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.

IN_PROGRESS

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.

scanType

public final ScanType scanType()

The scan type that has been completed.

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

Returns:

The scan type that has been completed.

See Also:

ScanType

scanTypeAsString

public final String scanTypeAsString()

The scan type that has been completed.

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

Returns:

The scan type that has been completed.

See Also:

ScanType

toBuilder

public ResourceScanSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceScanSummary.Builder,ResourceScanSummary>

builder

public static ResourceScanSummary.Builder builder()

serializableBuilderClass

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

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo