Class Promotion
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Promotion.Builder,
Promotion>
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Promotion.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the filter used by the promotion.The values to use when promoting items.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FilterValues property.final int
hashCode()
final String
name()
The name of the promotion.final Integer
The percentage of recommended items to apply the promotion to.static Class
<? extends Promotion.Builder> 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
-
name
The name of the promotion.
- Returns:
- The name of the promotion.
-
percentPromotedItems
The percentage of recommended items to apply the promotion to.
- Returns:
- The percentage of recommended items to apply the promotion to.
-
filterArn
The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.
- Returns:
- The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.
-
hasFilterValues
public final boolean hasFilterValues()For responses, this returns true if the service returned a value for the FilterValues 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. -
filterValues
The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an
INCLUDE
element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDE
element to exclude items, you can omit thefilter-values
. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.For more information on creating filters, see Filtering recommendations and user segments.
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
hasFilterValues()
method.- Returns:
- The values to use when promoting items. For each placeholder parameter in your promotion's filter
expression, provide the parameter name (in matching case) as a key and the filter value(s) as the
corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an
INCLUDE
element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDE
element to exclude items, you can omit thefilter-values
. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.For more information on creating filters, see Filtering recommendations and user segments.
-
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<Promotion.Builder,
Promotion> - 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
-