Class GetRecommenderResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
software.amazon.awssdk.services.customerprofiles.model.GetRecommenderResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRecommenderResponse.Builder,GetRecommenderResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetRecommenderResponse extends CustomerProfilesResponse implements ToCopyableBuilder<GetRecommenderResponse.Builder,GetRecommenderResponse>

  • Method Details

    • recommenderName

      public final String recommenderName()

      The name of the recommender.

      Returns:
      The name of the recommender.

    • recommenderRecipeName

      public final RecommenderRecipeName recommenderRecipeName()

      The name of the recipe used by the recommender to generate recommendations.

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

      Returns:
      The name of the recipe used by the recommender to generate recommendations.
      See Also:

    • recommenderRecipeNameAsString

      public final String recommenderRecipeNameAsString()

      The name of the recipe used by the recommender to generate recommendations.

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

      Returns:
      The name of the recipe used by the recommender to generate recommendations.
      See Also:

    • recommenderConfig

      public final RecommenderConfig recommenderConfig()

      The configuration settings for the recommender, including parameters and settings that define its behavior.

      Returns:
      The configuration settings for the recommender, including parameters and settings that define its behavior.

    • description

      public final String description()

      A detailed description of the recommender providing information about its purpose and functionality.

      Returns:
      A detailed description of the recommender providing information about its purpose and functionality.

    • status

      public final RecommenderStatus status()

      The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

      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 status of the recommender, indicating whether it is active, creating, updating, or in another state.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

      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 status of the recommender, indicating whether it is active, creating, updating, or in another state.
      See Also:

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of when the recommender was edited.

      Returns:
      The timestamp of when the recommender was edited.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the recommender was created.

      Returns:
      The timestamp of when the recommender was created.

    • failureReason

      public final String failureReason()

      If the recommender fails, provides the reason for the failure.

      Returns:
      If the recommender fails, provides the reason for the failure.

    • latestRecommenderUpdate

      public final RecommenderUpdate latestRecommenderUpdate()

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

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

    • hasTrainingMetrics

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

    • trainingMetrics

      public final List<TrainingMetrics> trainingMetrics()

      A set of metrics that provide information about the recommender's training performance and accuracy.

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

      Returns:
      A set of metrics that provide information about the recommender's training performance and accuracy.

    • 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.

    • toBuilder

      public GetRecommenderResponse.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<GetRecommenderResponse.Builder,GetRecommenderResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetRecommenderResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetRecommenderResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.