Package software.amazon.awssdk.services.codegurureviewer.model

Class RecommendationSummary

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

Information about recommendations.

See Also:

  • Method Details

    • filePath

      public final String filePath()

      Name of the file on which a recommendation is provided.

      Returns:
      Name of the file on which a recommendation is provided.

    • recommendationId

      public final String recommendationId()

      The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

      Returns:
      The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

    • startLine

      public final Integer startLine()

      Start line from where the recommendation is applicable in the source commit or source branch.

      Returns:
      Start line from where the recommendation is applicable in the source commit or source branch.

    • endLine

      public final Integer endLine()

      Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

      Returns:
      Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

    • description

      public final String description()

      A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

      Returns:
      A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

    • recommendationCategory

      public final RecommendationCategory recommendationCategory()

      The type of a recommendation.

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

      Returns:
      The type of a recommendation.
      See Also:

    • recommendationCategoryAsString

      public final String recommendationCategoryAsString()

      The type of a recommendation.

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

      Returns:
      The type of a recommendation.
      See Also:

    • ruleMetadata

      public final RuleMetadata ruleMetadata()

      Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

      Returns:
      Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

    • severity

      public final Severity severity()

      The severity of the issue in the code that generated this recommendation.

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

      Returns:
      The severity of the issue in the code that generated this recommendation.
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity of the issue in the code that generated this recommendation.

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

      Returns:
      The severity of the issue in the code that generated this recommendation.
      See Also:

    • toBuilder

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

    • builder

      public static RecommendationSummary.Builder builder()

    • serializableBuilderClass

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