Class AgentProfileSummary

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

Summary of an optimization profile, including its configuration, metadata, and audit information.

See Also:

  • Method Details

    • name

      public final String name()

      The system name of the profile.

      Returns:
      The system name of the profile.

    • displayName

      public final String displayName()

      The display name of the profile shown to users.

      Returns:
      The display name of the profile shown to users.

    • description

      public final String description()

      A description of the profile.

      Returns:
      A description of the profile.

    • businessOverview

      public final String businessOverview()

      The business overview for this profile.

      Returns:
      The business overview for this profile.

    • pillars

      public final List<Pillar> pillars()

      The Well-Architected Tool Framework pillars associated with this profile.

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

      Returns:
      The Well-Architected Tool Framework pillars associated with this profile.

    • hasPillars

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

    • pillarsAsStrings

      public final List<String> pillarsAsStrings()

      The Well-Architected Tool Framework pillars associated with this profile.

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

      Returns:
      The Well-Architected Tool Framework pillars associated with this profile.

    • deletionProtection

      public final Boolean deletionProtection()

      Indicates whether deletion protection is enabled for the profile.

      Returns:
      Indicates whether deletion protection is enabled for the profile.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the IAM execution role used for recommendation actions.

      Returns:
      The ARN of the IAM execution role used for recommendation actions.

    • hasAggregationConfiguration

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

    • aggregationConfiguration

      public final List<AggregationConfiguration> aggregationConfiguration()

      The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

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

      Returns:
      The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

    • arn

      public final String arn()

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

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

    • eligibleForScheduledGeneration

      public final Boolean eligibleForScheduledGeneration()

      Indicates whether the profile is valid for scheduled recommendation generation.

      Returns:
      Indicates whether the profile is valid for scheduled recommendation generation.

    • eligibleForArchitectureGeneration

      public final Boolean eligibleForArchitectureGeneration()

      Indicates whether the profile is valid for manual architecture generation.

      Returns:
      Indicates whether the profile is valid for manual architecture generation.

    • hasFieldErrors

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

    • fieldErrors

      public final Map<String,String> fieldErrors()

      A map of field paths to error messages for invalid or missing input fields.

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

      Returns:
      A map of field paths to error messages for invalid or missing input fields.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags associated with the profile.

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

      Returns:
      The tags associated with the profile.

    • createdBy

      public final String createdBy()

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

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

    • createdAt

      public final Instant createdAt()

      The timestamp when the profile was created.

      Returns:
      The timestamp when the profile was created.

    • lastModifiedBy

      public final String lastModifiedBy()

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

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

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The timestamp when the profile was last modified.

      Returns:
      The timestamp when the profile was last modified.

    • toBuilder

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

    • builder

      public static AgentProfileSummary.Builder builder()

    • serializableBuilderClass

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