Class OnDemandScan

java.lang.Object
software.amazon.awssdk.services.inspector2.model.OnDemandScan
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OnDemandScan.Builder,OnDemandScan>
@Generated("software.amazon.awssdk:codegen") public final class OnDemandScan extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OnDemandScan.Builder,OnDemandScan>

Details of a single on-demand scan of a resource.

See Also:

  • Method Details

    • scanId

      public final String scanId()

      The unique identifier of the on-demand scan.

      Returns:
      The unique identifier of the on-demand scan.

    • resourceId

      public final String resourceId()

      The ID of the resource that was scanned.

      Returns:
      The ID of the resource that was scanned.

    • resourceType

      public final OnDemandResourceType resourceType()

      The type of the resource that was scanned.

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

      Returns:
      The type of the resource that was scanned.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of the resource that was scanned.

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

      Returns:
      The type of the resource that was scanned.
      See Also:

    • scanStatus

      public final OnDemandScanStatus scanStatus()

      The current status of the on-demand scan.

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

      Returns:
      The current status of the on-demand scan.
      See Also:

    • scanStatusAsString

      public final String scanStatusAsString()

      The current status of the on-demand scan.

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

      Returns:
      The current status of the on-demand scan.
      See Also:

    • scanStatusReason

      public final OnDemandScanStatusReason scanStatusReason()

      The reason associated with the current on-demand scan status.

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

      Returns:
      The reason associated with the current on-demand scan status.
      See Also:

    • scanStatusReasonAsString

      public final String scanStatusReasonAsString()

      The reason associated with the current on-demand scan status.

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

      Returns:
      The reason associated with the current on-demand scan status.
      See Also:

    • startedAt

      public final Instant startedAt()

      The date and time, in ISO 8601 format, when the on-demand scan started.

      Returns:
      The date and time, in ISO 8601 format, when the on-demand scan started.

    • completedAt

      public final Instant completedAt()

      The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the scan has not completed.

      Returns:
      The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the scan has not completed.

    • toBuilder

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

    • builder

      public static OnDemandScan.Builder builder()

    • serializableBuilderClass

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