Package software.amazon.awssdk.services.rds.model

Class DBRecommendation

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

The recommendation for your DB instances, DB clusters, and DB parameter groups.

See Also:

  • Method Details

    • recommendationId

      public final String recommendationId()

      The unique identifier of the recommendation.

      Returns:
      The unique identifier of the recommendation.

    • typeId

      public final String typeId()

      A value that indicates the type of recommendation. This value determines how the description is rendered.

      Returns:
      A value that indicates the type of recommendation. This value determines how the description is rendered.

    • severity

      public final String severity()

      The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.

      Valid values:

      • high

      • medium

      • low

      • informational

      Returns:
      The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.

      Valid values:

      • high

      • medium

      • low

      • informational

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

      Returns:
      The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

    • status

      public final String status()

      The current status of the recommendation.

      Valid values:

      • active - The recommendations which are ready for you to apply.

      • pending - The applied or scheduled recommendations which are in progress.

      • resolved - The recommendations which are completed.

      • dismissed - The recommendations that you dismissed.

      Returns:
      The current status of the recommendation.

      Valid values:

      • active - The recommendations which are ready for you to apply.

      • pending - The applied or scheduled recommendations which are in progress.

      • resolved - The recommendations which are completed.

      • dismissed - The recommendations that you dismissed.

    • createdTime

      public final Instant createdTime()

      The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

      Returns:
      The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

    • updatedTime

      public final Instant updatedTime()

      The time when the recommendation was last updated.

      Returns:
      The time when the recommendation was last updated.

    • detection

      public final String detection()

      A short description of the issue identified for this recommendation. The description might contain markdown.

      Returns:
      A short description of the issue identified for this recommendation. The description might contain markdown.

    • recommendation

      public final String recommendation()

      A short description of the recommendation to resolve an issue. The description might contain markdown.

      Returns:
      A short description of the recommendation to resolve an issue. The description might contain markdown.

    • description

      public final String description()

      A detailed description of the recommendation. The description might contain markdown.

      Returns:
      A detailed description of the recommendation. The description might contain markdown.

    • reason

      public final String reason()

      The reason why this recommendation was created. The information might contain markdown.

      Returns:
      The reason why this recommendation was created. The information might contain markdown.

    • hasRecommendedActions

      public final boolean hasRecommendedActions()
      For responses, this returns true if the service returned a value for the RecommendedActions 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.

    • recommendedActions

      public final List<RecommendedAction> recommendedActions()

      A list of recommended actions.

      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 hasRecommendedActions() method.

      Returns:
      A list of recommended actions.

    • category

      public final String category()

      The category of the recommendation.

      Valid values:

      • performance efficiency

      • security

      • reliability

      • cost optimization

      • operational excellence

      • sustainability

      Returns:
      The category of the recommendation.

      Valid values:

      • performance efficiency

      • security

      • reliability

      • cost optimization

      • operational excellence

      • sustainability

    • source

      public final String source()

      The Amazon Web Services service that generated the recommendations.

      Returns:
      The Amazon Web Services service that generated the recommendations.

    • typeDetection

      public final String typeDetection()

      A short description of the recommendation type. The description might contain markdown.

      Returns:
      A short description of the recommendation type. The description might contain markdown.

    • typeRecommendation

      public final String typeRecommendation()

      A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

      Returns:
      A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

    • impact

      public final String impact()

      A short description that explains the possible impact of an issue.

      Returns:
      A short description that explains the possible impact of an issue.

    • additionalInfo

      public final String additionalInfo()

      Additional information about the recommendation. The information might contain markdown.

      Returns:
      Additional information about the recommendation. The information might contain markdown.

    • hasLinks

      public final boolean hasLinks()
      For responses, this returns true if the service returned a value for the Links 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.

    • links

      public final List<DocLink> links()

      A link to documentation that provides additional information about the recommendation.

      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 hasLinks() method.

      Returns:
      A link to documentation that provides additional information about the recommendation.

    • issueDetails

      public final IssueDetails issueDetails()

      Details of the issue that caused the recommendation.

      Returns:
      Details of the issue that caused the recommendation.

    • toBuilder

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

    • builder

      public static DBRecommendation.Builder builder()

    • serializableBuilderClass

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