Promotion (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalizeruntime.model.Promotion

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Promotion
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Promotion()

Constructors
Constructor and Description
`Promotion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Promotion`	`addFilterValuesEntry(String key, String value)` Add a single FilterValues entry
`Promotion`	`clearFilterValuesEntries()` Removes all the entries added into FilterValues.
`Promotion`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFilterArn()` The Amazon Resource Name (ARN) of the filter used by the promotion.
`Map<String,String>`	`getFilterValues()` The values to use when promoting items.
`String`	`getName()` The name of the promotion.
`Integer`	`getPercentPromotedItems()` The percentage of recommended items to apply the promotion to.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFilterArn(String filterArn)` The Amazon Resource Name (ARN) of the filter used by the promotion.
`void`	`setFilterValues(Map<String,String> filterValues)` The values to use when promoting items.
`void`	`setName(String name)` The name of the promotion.
`void`	`setPercentPromotedItems(Integer percentPromotedItems)` The percentage of recommended items to apply the promotion to.
`String`	`toString()` Returns a string representation of this object.
`Promotion`	`withFilterArn(String filterArn)` The Amazon Resource Name (ARN) of the filter used by the promotion.
`Promotion`	`withFilterValues(Map<String,String> filterValues)` The values to use when promoting items.
`Promotion`	`withName(String name)` The name of the promotion.
`Promotion`	`withPercentPromotedItems(Integer percentPromotedItems)` The percentage of recommended items to apply the promotion to.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Promotion
```
public Promotion()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the promotion.
    
    Parameters:
    
    name - The name of the promotion.
  - getName
```
public String getName()
```
    The name of the promotion.
    
    Returns:
    
    The name of the promotion.
  - withName
```
public Promotion withName(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.
  - setPercentPromotedItems
```
public void setPercentPromotedItems(Integer percentPromotedItems)
```
    The percentage of recommended items to apply the promotion to.
    
    Parameters:
    
    percentPromotedItems - The percentage of recommended items to apply the promotion to.
  - getPercentPromotedItems
```
public Integer getPercentPromotedItems()
```
    The percentage of recommended items to apply the promotion to.
    
    Returns:
    
    The percentage of recommended items to apply the promotion to.
  - withPercentPromotedItems
```
public Promotion withPercentPromotedItems(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.
  - setFilterArn
```
public void setFilterArn(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.
  - getFilterArn
```
public String getFilterArn()
```
    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.
  - withFilterArn
```
public Promotion withFilterArn(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.
  - getFilterValues
```
public Map<String,String> getFilterValues()
```
    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:
    
    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.
  - setFilterValues
```
public void setFilterValues(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.
  - withFilterValues
```
public Promotion withFilterValues(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.
  - addFilterValuesEntry
```
public Promotion addFilterValuesEntry(String key,
                                      String value)
```
    Add a single FilterValues entry
    
    See Also:
    
    withFilterValues(java.util.Map<java.lang.String, java.lang.String>)
  - clearFilterValuesEntries
```
public Promotion clearFilterValuesEntries()
```
    Removes all the entries added into FilterValues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Promotion clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Promotion

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Promotion

Method Detail

setName

getName

withName

setPercentPromotedItems

getPercentPromotedItems

withPercentPromotedItems

setFilterArn

getFilterArn

withFilterArn

getFilterValues

setFilterValues

withFilterValues

addFilterValuesEntry

clearFilterValuesEntries

toString

equals

hashCode

clone

marshall