Class ApplicationComponentDetail

    • Method Detail

      • analysisStatusAsString

        public final String analysisStatusAsString()

        The status of analysis, if the application component has source code or an associated database.

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

        Returns:
        The status of analysis, if the application component has source code or an associated database.
        See Also:
        SrcCodeOrDbAnalysisStatus
      • antipatternReportS3Object

        public final S3Object antipatternReportS3Object()

        The S3 bucket name and the Amazon S3 key name for the anti-pattern report.

        Returns:
        The S3 bucket name and the Amazon S3 key name for the anti-pattern report.
      • antipatternReportStatusMessage

        public final String antipatternReportStatusMessage()

        The status message for the anti-pattern.

        Returns:
        The status message for the anti-pattern.
      • appType

        public final AppType appType()

        The type of application component.

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

        Returns:
        The type of application component.
        See Also:
        AppType
      • appTypeAsString

        public final String appTypeAsString()

        The type of application component.

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

        Returns:
        The type of application component.
        See Also:
        AppType
      • appUnitError

        public final AppUnitError appUnitError()

        The error in the analysis of the source code or database.

        Returns:
        The error in the analysis of the source code or database.
      • associatedServerId

        public final String associatedServerId()

        The ID of the server that the application component is running on.

        Returns:
        The ID of the server that the application component is running on.
      • databaseConfigDetail

        public final DatabaseConfigDetail databaseConfigDetail()

        Configuration details for the database associated with the application component.

        Returns:
        Configuration details for the database associated with the application component.
      • id

        public final String id()

        The ID of the application component.

        Returns:
        The ID of the application component.
      • inclusionStatus

        public final InclusionStatus inclusionStatus()

        Indicates whether the application component has been included for server recommendation or not.

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

        Returns:
        Indicates whether the application component has been included for server recommendation or not.
        See Also:
        InclusionStatus
      • inclusionStatusAsString

        public final String inclusionStatusAsString()

        Indicates whether the application component has been included for server recommendation or not.

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

        Returns:
        Indicates whether the application component has been included for server recommendation or not.
        See Also:
        InclusionStatus
      • lastAnalyzedTimestamp

        public final Instant lastAnalyzedTimestamp()

        The timestamp of when the application component was assessed.

        Returns:
        The timestamp of when the application component was assessed.
      • hasListAntipatternSeveritySummary

        public final boolean hasListAntipatternSeveritySummary()
        For responses, this returns true if the service returned a value for the ListAntipatternSeveritySummary property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • listAntipatternSeveritySummary

        public final List<AntipatternSeveritySummary> listAntipatternSeveritySummary()

        A list of anti-pattern severity summaries.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasListAntipatternSeveritySummary() method.

        Returns:
        A list of anti-pattern severity summaries.
      • moreServerAssociationExists

        public final Boolean moreServerAssociationExists()

        Set to true if the application component is running on multiple servers.

        Returns:
        Set to true if the application component is running on multiple servers.
      • name

        public final String name()

        The name of application component.

        Returns:
        The name of application component.
      • osDriver

        public final String osDriver()

        OS driver.

        Returns:
        OS driver.
      • osVersion

        public final String osVersion()

        OS version.

        Returns:
        OS version.
      • recommendationSet

        public final RecommendationSet recommendationSet()

        The top recommendation set for the application component.

        Returns:
        The top recommendation set for the application component.
      • hasResultList

        public final boolean hasResultList()
        For responses, this returns true if the service returned a value for the ResultList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • resultList

        public final List<Result> resultList()

        A list of the analysis results.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResultList() method.

        Returns:
        A list of the analysis results.
      • runtimeStatusMessage

        public final String runtimeStatusMessage()

        The status message for the application unit.

        Returns:
        The status message for the application unit.
      • hasSourceCodeRepositories

        public final boolean hasSourceCodeRepositories()
        For responses, this returns true if the service returned a value for the SourceCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • sourceCodeRepositories

        public final List<SourceCodeRepository> sourceCodeRepositories()

        Details about the source code repository associated with the application component.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceCodeRepositories() method.

        Returns:
        Details about the source code repository associated with the application component.
      • statusMessage

        public final String statusMessage()

        A detailed description of the analysis status and any failure message.

        Returns:
        A detailed description of the analysis status and any failure message.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)