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

Class AnchorConfigWithExtractor

java.lang.Object

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

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

All Implemented Interfaces:

ConfigObj, java.io.Serializable

public class AnchorConfigWithExtractor
extends AnchorConfig

Represents the anchor definition (the object part) for the anchors that have the extractor specified (in lieu of the key). The features may be specified in two ways as shown below, where the keyExtractor and (keyAlias and/or key) fields are mutually exclusive. If using keyAlias or keys, the extractor can only be of AnchorExtractor type. If using keyExtractor, the extractor can only be of SimpleAnchorExtractorSpark or GenericAnchorExtractorSpark.

 <anchor name 1>: {
   source: <source name>
   keyExtractor: <full extractor class name>
   extractor: <full extractor class name>
   features: {
     <feature name 1> : {
       default: <default value>
     },
     <feature name 2>: {
       default: <default value>
     },
     ...
   }
 }

 

A concise format when there is no default value defined for each feature on this anchor

 
 <anchor name 2>: {
   source: <source name 2>
   keyExtractor: <full extractor class name>
   extractor: <full extractor class name 2>
   features: [
     <feature name 1>,
     <feature name 2>,
     ...
   ]
 }

One example of using keyAlias

 
 <anchor name 2>: {
   source: <source name 2>
   key: <key list>
   keyAlias: <key alias list>
   extractor: <full extractor class name 2>
   features: [
     <feature name 1>,
     <feature name 2>,
     ...
   ]
 }

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
AnchorConfigWithExtractor(java.lang.String source, java.lang.String extractor, java.util.Map<java.lang.String,FeatureConfig> features) Constructor
AnchorConfigWithExtractor(java.lang.String source, java.lang.String keyExtractor, java.lang.String extractor, java.util.Map<java.lang.String,FeatureConfig> features) Constructor
AnchorConfigWithExtractor(java.lang.String source, java.lang.String keyExtractor, TypedKey typedKey, java.util.List<java.lang.String> keyAlias, java.lang.String extractor, java.util.Map<java.lang.String,FeatureConfig> features) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getExtractor()
java.util.Optional<java.util.List<java.lang.String>>	getKeyAlias()
java.util.Optional<java.lang.String>	getKeyExtractor()
java.util.Optional<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

AnchorConfigWithExtractor

public AnchorConfigWithExtractor(java.lang.String source,
                                 java.lang.String keyExtractor,
                                 TypedKey typedKey,
                                 java.util.List<java.lang.String> keyAlias,
                                 java.lang.String extractor,
                                 java.util.Map<java.lang.String,FeatureConfig> features)

Constructor

Parameters:

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

keyExtractor - name of Java class that is used to extract the key(s)

typedKey - the TypedKey object

keyAlias - list of key alias

extractor - Name of Java class that is used to extract the feature(s)

features - Map of feature names to FeatureConfig object

AnchorConfigWithExtractor

public AnchorConfigWithExtractor(java.lang.String source,
                                 java.lang.String keyExtractor,
                                 java.lang.String extractor,
                                 java.util.Map<java.lang.String,FeatureConfig> features)

Constructor

Parameters:

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

keyExtractor - name of Java class that is used to extract the key(s)

extractor - Name of Java class that is used to extract the feature(s)

features - Map of feature names to FeatureConfig object

AnchorConfigWithExtractor

public AnchorConfigWithExtractor(java.lang.String source,
                                 java.lang.String extractor,
                                 java.util.Map<java.lang.String,FeatureConfig> features)

Constructor

Parameters:

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

extractor - Name of Java class that is used to extract the feature(s)

features - Map of feature names to FeatureConfig object

Method Detail

getKeyExtractor

public java.util.Optional<java.lang.String> getKeyExtractor()

getKeyAlias

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

getTypedKey

public java.util.Optional<TypedKey> getTypedKey()

getExtractor

public java.lang.String getExtractor()

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