software.amazon.awssdk.services.personalizeruntime.model

Interface Promotion.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Promotion.Builder,Promotion>, SdkBuilder<Promotion.Builder,Promotion>, SdkPojo

Enclosing class:

Promotion

public static interface Promotion.Builder
extends SdkPojo, CopyableBuilder<Promotion.Builder,Promotion>

Method Summary

Modifier and Type	Method and Description
Promotion.Builder	filterArn(String filterArn) The Amazon Resource Name (ARN) of the filter used by the promotion.
Promotion.Builder	filterValues(Map<String,String> filterValues) The values to use when promoting items.
Promotion.Builder	name(String name) The name of the promotion.
Promotion.Builder	percentPromotedItems(Integer percentPromotedItems) The percentage of recommended items to apply the promotion to.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

Promotion.Builder name(String name)

The name of the promotion.

Parameters:

name - The name of the promotion.

Returns:

Returns a reference to this object so that method calls can be chained together.

percentPromotedItems

Promotion.Builder percentPromotedItems(Integer percentPromotedItems)

The percentage of recommended items to apply the promotion to.

Parameters:

percentPromotedItems - The percentage of recommended items to apply the promotion to.

Returns:

Returns a reference to this object so that method calls can be chained together.

filterArn

Promotion.Builder filterArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

filterValues

Promotion.Builder filterValues(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.