Interface ProductFeed
-
- All Superinterfaces:
RecommendationsEntity
@ProviderType public interface ProductFeed extends RecommendationsEntity
Abstraction of a Target Recommendations product feed
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ProductFeed.FeedSchedule
Feed schedule enumeration.static class
ProductFeed.FeedType
Feed type enumeration
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>
getAttributeMapping()
Defines the mapping between the feed's fields and the Target Recommendation's entities.java.util.Map<java.lang.String,java.lang.String>
getConnectionProperties()
Defines the connection properties for the feeds requiring remote server connections Not all feed types support connection properties (e.g.int
getEnvironmentId()
Environment id of this feedint
getId()
Uniquely identifies aProductFeed
java.lang.String
getName()
Get the name of thisProductFeed
ProductFeed.FeedSchedule
getSchedule()
Product update frequencyProductFeed.FeedType
getType()
This feed's type-
Methods inherited from interface com.adobe.cq.targetrecommendations.api.model.RecommendationsEntity
toJson
-
-
-
-
Method Detail
-
getId
int getId()
Uniquely identifies aProductFeed
- Returns:
- a
Integer
value identifying thisProductFeed
-
getName
java.lang.String getName()
Get the name of thisProductFeed
- Returns:
- a
String
object containing this product feed's name
-
getType
ProductFeed.FeedType getType()
This feed's type- Returns:
- a
FeedType
value
-
getSchedule
ProductFeed.FeedSchedule getSchedule()
Product update frequency- Returns:
- a
FeedSchedule
value
-
getEnvironmentId
int getEnvironmentId()
Environment id of this feed- Returns:
- the environment id
-
getAttributeMapping
java.util.Map<java.lang.String,java.lang.String> getAttributeMapping()
Defines the mapping between the feed's fields and the Target Recommendation's entities. Not all field types support this mapping (e.g. csv)- Returns:
- a
Map
where keys point to feed field names and values to target recommendations entity names
-
getConnectionProperties
java.util.Map<java.lang.String,java.lang.String> getConnectionProperties()
Defines the connection properties for the feeds requiring remote server connections Not all feed types support connection properties (e.g. SAINT)- Returns:
- a
Map
containing the connection properties as key-value pairs
-
-