Class AgentRecommendationSummary

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

Summary of an agent optimization recommendation returned by list operations.

See Also:

  • Method Details

    • recommendationArn

      public final String recommendationArn()

      The Amazon Resource Name (ARN) of the recommendation.

      Returns:
      The Amazon Resource Name (ARN) of the recommendation.

    • profileArn

      public final String profileArn()

      The Amazon Resource Name (ARN) of the associated profile.

      Returns:
      The Amazon Resource Name (ARN) of the associated profile.

    • title

      public final String title()

      The title of the recommendation.

      Returns:
      The title of the recommendation.

    • description

      public final String description()

      A description of the recommendation.

      Returns:
      A description of the recommendation.

    • type

      public final RecommendationType type()

      The type of the recommendation.

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

      Returns:
      The type of the recommendation.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the recommendation.

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

      Returns:
      The type of the recommendation.
      See Also:

    • pillar

      public final Pillar pillar()

      The Well-Architected Tool Framework pillar that the recommendation addresses.

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

      Returns:
      The Well-Architected Tool Framework pillar that the recommendation addresses.
      See Also:

    • pillarAsString

      public final String pillarAsString()

      The Well-Architected Tool Framework pillar that the recommendation addresses.

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

      Returns:
      The Well-Architected Tool Framework pillar that the recommendation addresses.
      See Also:

    • priority

      public final Priority priority()

      The priority of the recommendation.

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

      Returns:
      The priority of the recommendation.
      See Also:

    • priorityAsString

      public final String priorityAsString()

      The priority of the recommendation.

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

      Returns:
      The priority of the recommendation.
      See Also:

    • effort

      public final Effort effort()

      The effort required to implement the recommendation.

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

      Returns:
      The effort required to implement the recommendation.
      See Also:

    • effortAsString

      public final String effortAsString()

      The effort required to implement the recommendation.

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

      Returns:
      The effort required to implement the recommendation.
      See Also:

    • status

      public final RecommendationStatus status()

      The current status of the recommendation.

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

      Returns:
      The current status of the recommendation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the recommendation.

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

      Returns:
      The current status of the recommendation.
      See Also:

    • state

      public final RecommendationState state()

      The current state of the recommendation.

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

      Returns:
      The current state of the recommendation.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the recommendation.

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

      Returns:
      The current state of the recommendation.
      See Also:

    • updateReason

      public final String updateReason()

      The free-text reason associated with the recommendation's most recent status update.

      Returns:
      The free-text reason associated with the recommendation's most recent status update.

    • impact

      public final ImpactCategory impact()

      The severity of the recommendation's impact.

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

      Returns:
      The severity of the recommendation's impact.
      See Also:

    • impactAsString

      public final String impactAsString()

      The severity of the recommendation's impact.

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

      Returns:
      The severity of the recommendation's impact.
      See Also:

    • roi

      public final Roi roi()

      The return on investment estimate for the recommendation.

      Returns:
      The return on investment estimate for the recommendation.

    • numberOfResources

      public final Integer numberOfResources()

      The number of Amazon Web Services resources this recommendation affects.

      Returns:
      The number of Amazon Web Services resources this recommendation affects.

    • hasAwsServices

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

    • awsServices

      public final List<String> awsServices()

      The Amazon Web Services services that the recommendation applies to.

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

      Returns:
      The Amazon Web Services services that the recommendation applies to.

    • hasBusinessUnits

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

    • businessUnits

      public final List<String> businessUnits()

      The business units that own the affected resources.

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

      Returns:
      The business units that own the affected resources.

    • hasApplications

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

    • applications

      public final List<String> applications()

      The applications that the recommendation targets.

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

      Returns:
      The applications that the recommendation targets.

    • createdBy

      public final String createdBy()

      The identifier of the user or system that created this recommendation.

      Returns:
      The identifier of the user or system that created this recommendation.

    • createdAt

      public final Instant createdAt()

      The timestamp when the recommendation was created.

      Returns:
      The timestamp when the recommendation was created.

    • lastModifiedBy

      public final String lastModifiedBy()

      The identifier of the user or system that last modified this recommendation.

      Returns:
      The identifier of the user or system that last modified this recommendation.

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The timestamp when the recommendation was last modified.

      Returns:
      The timestamp when the recommendation was last modified.

    • toBuilder

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

    • builder

      public static AgentRecommendationSummary.Builder builder()

    • serializableBuilderClass

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