Class GetScanResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.codegurusecurity.model.CodeGuruSecurityResponse
software.amazon.awssdk.services.codegurusecurity.model.GetScanResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScanResponse.Builder,GetScanResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetScanResponse extends CodeGuruSecurityResponse implements ToCopyableBuilder<GetScanResponse.Builder,GetScanResponse>

  • Method Details

    • scanName

      public final String scanName()

      The name of the scan.

      Returns:
      The name of the scan.

    • runId

      public final String runId()

      UUID that identifies the individual scan run.

      Returns:
      UUID that identifies the individual scan run.

    • scanState

      public final ScanState scanState()

      The current state of the scan. Returns either InProgress, Successful, or Failed.

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

      Returns:
      The current state of the scan. Returns either InProgress, Successful, or Failed.
      See Also:

    • scanStateAsString

      public final String scanStateAsString()

      The current state of the scan. Returns either InProgress, Successful, or Failed.

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

      Returns:
      The current state of the scan. Returns either InProgress, Successful, or Failed.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time the scan was created.

      Returns:
      The time the scan was created.

    • analysisType

      public final AnalysisType analysisType()

      The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

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

      Returns:
      The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.
      See Also:

    • analysisTypeAsString

      public final String analysisTypeAsString()

      The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

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

      Returns:
      The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The time when the scan was last updated. Only available for STANDARD scan types.

      Returns:
      The time when the scan was last updated. Only available for STANDARD scan types.

    • numberOfRevisions

      public final Long numberOfRevisions()

      The number of times a scan has been re-run on a revised resource.

      Returns:
      The number of times a scan has been re-run on a revised resource.

    • scanNameArn

      public final String scanNameArn()

      The ARN for the scan name.

      Returns:
      The ARN for the scan name.

    • errorMessage

      public final String errorMessage()

      Details about the error that causes a scan to fail to be retrieved.

      Returns:
      Details about the error that causes a scan to fail to be retrieved.

    • toBuilder

      public GetScanResponse.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<GetScanResponse.Builder,GetScanResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetScanResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetScanResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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