Class CodeScanData

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

Complete customer-visible data for one environment scan.

Kept distinct from CodeScanSummary so GetCodeScan can grow independently of ListCodeScans without changing its response contract.

See Also:

  • Method Details

    • scanRunId

      public final String scanRunId()

      The unique scan identifier.

      Returns:
      The unique scan identifier.

    • status

      public final ScanStatus status()

      Current customer-visible status.

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

      Returns:
      Current customer-visible status.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current customer-visible status.

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

      Returns:
      Current customer-visible status.
      See Also:

    • origin

      public final ScanOrigin origin()

      Why the scan was created. Always present.

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

      Returns:
      Why the scan was created. Always present.
      See Also:

    • originAsString

      public final String originAsString()

      Why the scan was created. Always present.

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

      Returns:
      Why the scan was created. Always present.
      See Also:

    • createdAt

      public final Instant createdAt()

      Time at which Continuum accepted the scan request.

      Returns:
      Time at which Continuum accepted the scan request.

    • completedAt

      public final Instant completedAt()

      Time at which a terminal result was recorded.

      Returns:
      Time at which a terminal result was recorded.

    • failureMessage

      public final String failureMessage()

      Failure detail present for unsuccessful scans.

      Returns:
      Failure detail present for unsuccessful scans.

    • failureStage

      public final ScanFailureStage failureStage()

      Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.

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

      Returns:
      Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.
      See Also:

    • failureStageAsString

      public final String failureStageAsString()

      Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.

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

      Returns:
      Phase this scan failed in. Present only when status is FAILED, and absent for a scan that failed before this field existed.
      See Also:

    • toBuilder

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

    • builder

      public static CodeScanData.Builder builder()

    • serializableBuilderClass

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