Class Recommender
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Recommender.Builder,
Recommender>
Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Recommender.Builder
builder()
final Instant
The date and time (in Unix format) that the recommender was created.final String
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If a recommender fails, the reason behind the failure.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ModelMetrics property.final Instant
The date and time (in Unix format) that the recommender was last updated.final RecommenderUpdateSummary
Provides a summary of the latest updates to the recommender.Provides evaluation metrics that help you determine the performance of a recommender.final String
name()
The name of the recommender.final String
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.final String
The Amazon Resource Name (ARN) of the recommender.final RecommenderConfig
The configuration details of the recommender.static Class
<? extends Recommender.Builder> final String
status()
The status of the recommender.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
recommenderArn
The Amazon Resource Name (ARN) of the recommender.
- Returns:
- The Amazon Resource Name (ARN) of the recommender.
-
datasetGroupArn
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
- Returns:
- The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
-
name
The name of the recommender.
- Returns:
- The name of the recommender.
-
recipeArn
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
- Returns:
- The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
-
recommenderConfig
The configuration details of the recommender.
- Returns:
- The configuration details of the recommender.
-
creationDateTime
The date and time (in Unix format) that the recommender was created.
- Returns:
- The date and time (in Unix format) that the recommender was created.
-
lastUpdatedDateTime
The date and time (in Unix format) that the recommender was last updated.
- Returns:
- The date and time (in Unix format) that the recommender was last updated.
-
status
The status of the recommender.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
- Returns:
- The status of the recommender.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
-
-
-
failureReason
If a recommender fails, the reason behind the failure.
- Returns:
- If a recommender fails, the reason behind the failure.
-
latestRecommenderUpdate
Provides a summary of the latest updates to the recommender.
- Returns:
- Provides a summary of the latest updates to the recommender.
-
hasModelMetrics
public final boolean hasModelMetrics()For responses, this returns true if the service returned a value for the ModelMetrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
modelMetrics
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
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
hasModelMetrics()
method.- Returns:
- Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
-
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 interfaceToCopyableBuilder<Recommender.Builder,
Recommender> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-