Class RecommenderSummary

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

Provides a summary of a recommender's configuration and current state.

See Also:

  • Method Details

    • recommenderName

      public final String recommenderName()

      The name of the recommender.

      Returns:
      The name of the recommender.

    • recipeName

      public final RecommenderRecipeName recipeName()

      The name of the recipe used by this recommender.

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

      Returns:
      The name of the recipe used by this recommender.
      See Also:

    • recipeNameAsString

      public final String recipeNameAsString()

      The name of the recipe used by this recommender.

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

      Returns:
      The name of the recipe used by this recommender.
      See Also:

    • recommenderConfig

      public final RecommenderConfig recommenderConfig()

      The configuration settings applied to this recommender.

      Returns:
      The configuration settings applied to this recommender.

    • createdAt

      public final Instant createdAt()

      The timestamp when the recommender was created.

      Returns:
      The timestamp when the recommender was created.

    • description

      public final String description()

      A description of the recommender's purpose and characteristics.

      Returns:
      A description of the recommender's purpose and characteristics.

    • status

      public final RecommenderStatus status()

      The current operational status of the recommender.

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

      Returns:
      The current operational status of the recommender.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current operational status of the recommender.

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

      Returns:
      The current operational status of the recommender.
      See Also:

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of when the recommender was edited.

      Returns:
      The timestamp of when the recommender was edited.

    • 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 Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

      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 used to organize, track, or control access for this resource.

    • failureReason

      public final String failureReason()

      If the recommender is in a failed state, provides the reason for the failure.

      Returns:
      If the recommender is in a failed state, provides the reason for the failure.

    • latestRecommenderUpdate

      public final RecommenderUpdate latestRecommenderUpdate()

      Information about the most recent update performed on the recommender, including its status and timing.

      Returns:
      Information about the most recent update performed on the recommender, including its status and timing.

    • toBuilder

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

    • builder

      public static RecommenderSummary.Builder builder()

    • serializableBuilderClass

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