com.linkedin.feathr.core.config.producer.anchors

Class AnchorConfigWithKey

java.lang.Object

com.linkedin.feathr.core.config.producer.anchors.AnchorConfig

com.linkedin.feathr.core.config.producer.anchors.AnchorConfigWithKey

All Implemented Interfaces:

ConfigObj, java.io.Serializable

public final class AnchorConfigWithKey
extends AnchorConfig

Represents the anchor definition (the object part) for the anchors that have the key specified. The anchors may be specified in the following ways: In the following, the fields type and default are optional.

 
 <anchor name 1>: {
   source: <source name>
   key: <key expression>
   keyAlias: <key alias expression>
   features: {
     <feature name>: {
       def: <feature expression>,
       type: <feature type>,
       default: <default value>
     }
     ...
   }
 }

 <anchor name 2>: {
   source: <source name 2>
   key: <key expression 2>
   keyAlias: <key alias expression>
   features: {
     <feature name>: <feature expression>,
     ...
   }
 }
 

In the following, the fields key.sqlExpr and def.sqlExpr should be used simultaneously. The fields type and default are optional.

 
 <anchor name 3>: {
   source: <source name>
   key.sqlExpr: <key expression>
   keyAlias: <key alias expression>
   features: {
     <feature name>: {
       def.sqlExpr: <feature expression>,
       type: <feature type>,
       default: <default value>
     }
     ...
   }
 }
 

In the following, the fields 'lateralViewParameters', 'filter', 'groupBy' and 'limit' are optional. Further, within 'lateralViewParameters', 'lateralViewFilter' is optional as well.

 
 <anchor name 4>: {
    source: <source name>
    key: <key field>
    keyAlias: <key alias expression>
    lateralViewParameters: {
      lateralViewDef: <view def expr>
      lateralViewItemAlias: <item alias>
      lateralViewFilter: <filter expr>
    }
    features: {
      <feature name>: {
        def: <column name>
        aggregation: <aggregation type>
        window: <length of window time>
        filter: <string>
        groupBy: <column name>
        limit: <int>
      }
    }
 }
 

See Also:

Serialized Form

Field Summary

Fields inherited from class com.linkedin.feathr.core.config.producer.anchors.AnchorConfig

EXTRACTOR, FEATURES, KEY, KEY_ALIAS, KEY_EXTRACTOR, KEY_MVEL, KEY_SQL_EXPR, LATERAL_VIEW_PARAMS, SOURCE, TRANSFORMER

Constructor Summary

Constructors

Constructor and Description
AnchorConfigWithKey(java.lang.String source, TypedKey typedKey, LateralViewParams lateralViewParams, java.util.Map<java.lang.String,FeatureConfig> features) Constructor
AnchorConfigWithKey(java.lang.String source, TypedKey typedKey, java.util.List<java.lang.String> keyAlias, LateralViewParams lateralViewParams, java.util.Map<java.lang.String,FeatureConfig> features) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	getKey()
java.util.Optional<java.util.List<java.lang.String>>	getKeyAlias()
java.util.Optional<LateralViewParams>	getLateralViewParams()
TypedKey	getTypedKey()
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.linkedin.feathr.core.config.producer.anchors.AnchorConfig

getFeatures, getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

AnchorConfigWithKey

public AnchorConfigWithKey(java.lang.String source,
                           TypedKey typedKey,
                           java.util.List<java.lang.String> keyAlias,
                           LateralViewParams lateralViewParams,
                           java.util.Map<java.lang.String,FeatureConfig> features)

Constructor

Parameters:

source - source name (defined in sources section) or HDFS/Dali path

typedKey - the TypedKey object

keyAlias - the list of key alias

lateralViewParams - LateralViewParams object

features - Map of feature names to FeatureConfig

AnchorConfigWithKey

public AnchorConfigWithKey(java.lang.String source,
                           TypedKey typedKey,
                           LateralViewParams lateralViewParams,
                           java.util.Map<java.lang.String,FeatureConfig> features)

Constructor

Parameters:

source - source name (defined in sources section) or HDFS/Dali path

typedKey - the TypedKey object

lateralViewParams - LateralViewParams object

features - Map of feature names to FeatureConfig

Method Detail

getKey

public java.util.List<java.lang.String> getKey()

getTypedKey

public TypedKey getTypedKey()

getKeyAlias

public java.util.Optional<java.util.List<java.lang.String>> getKeyAlias()

getLateralViewParams

public java.util.Optional<LateralViewParams> getLateralViewParams()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AnchorConfig

hashCode

public int hashCode()

Overrides:

hashCode in class AnchorConfig