Package software.amazon.awssdk.services.personalizeruntime.model

Class Promotion

java.lang.Object

software.amazon.awssdk.services.personalizeruntime.model.Promotion

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Promotion.Builder,Promotion>

@Generated("software.amazon.awssdk:codegen")
public final class Promotion
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Promotion.Builder

Method Summary

Modifier and Type	Method	Description
static Promotion.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterArn()	The Amazon Resource Name (ARN) of the filter used by the promotion.
Map<String,String>	filterValues()	The values to use when promoting items.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilterValues()	For responses, this returns true if the service returned a value for the FilterValues property.
int	hashCode()
String	name()	The name of the promotion.
Integer	percentPromotedItems()	The percentage of recommended items to apply the promotion to.
List<SdkField<?>>	sdkFields()
static Class<? extends Promotion.Builder>	serializableBuilderClass()
Promotion.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the promotion.

Returns:

The name of the promotion.

percentPromotedItems

public final Integer percentPromotedItems()

The percentage of recommended items to apply the promotion to.

Returns:

The percentage of recommended items to apply the promotion to.

filterArn

public final String 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 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.

filterValues

public final Map<String,String> 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 an EXCLUDE element to exclude items, you can omit the filter-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 an EXCLUDE element to exclude items, you can omit the filter-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

public Promotion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Promotion.Builder,Promotion>

builder

public static Promotion.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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