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:

  • Method Details

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

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

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

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

    • toBuilder

      public ResourceScanSummary.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<ResourceScanSummary.Builder,ResourceScanSummary>
      Returns:
      a builder for type T

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

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