com.logicalclocks.hsfs

Class FeatureStore

java.lang.Object

com.logicalclocks.hsfs.FeatureStore

public class FeatureStore
extends Object

Constructor Summary

Constructors

Constructor and Description
FeatureStore()

Method Summary

Modifier and Type	Method and Description
ExternalFeatureGroup.ExternalFeatureGroupBuilder	createExternalFeatureGroup()
FeatureGroup.FeatureGroupBuilder	createFeatureGroup()
FeatureView.FeatureViewBuilder	createFeatureView()
ExternalFeatureGroup.ExternalFeatureGroupBuilder	createOnDemandFeatureGroup() Deprecated.
StreamFeatureGroup.StreamFeatureGroupBuilder	createStreamFeatureGroup()
TrainingDataset.TrainingDatasetBuilder	createTrainingDataset()
StorageConnector.AdlsConnector	getAdlsConnector(String name)
StorageConnector.BigqueryConnector	getBigqueryConnector(String name)
ExternalFeatureGroup	getExternalFeatureGroup(String name) Get a external feature group object with default version `1` from the feature store.
ExternalFeatureGroup	getExternalFeatureGroup(@NonNull String name, @NonNull Integer version) Get a external feature group object from the feature store.
scala.collection.Seq<ExternalFeatureGroup>	getExternalFeatureGroups(@NonNull String name) Get a list of all versions of an external feature group from the feature store.
FeatureGroup	getFeatureGroup(String name) Get a feature group object with default version `1` from the feature store.
FeatureGroup	getFeatureGroup(@NonNull String name, @NonNull Integer version) Get a feature group object from the feature store.
scala.collection.Seq<FeatureGroup>	getFeatureGroups(@NonNull String name) Get a list of all versions of a feature group from the feature store.
FeatureView	getFeatureView(String name) Get a feature view object with the default version `1` from the selected feature store.
FeatureView	getFeatureView(@NonNull String name, @NonNull Integer version) Get a feature view object from the selected feature store.
StorageConnector.GcsConnector	getGcsConnector(String name)
StorageConnector.HopsFsConnector	getHopsFsConnector(String name)
Integer	getId()
StorageConnector.JdbcConnector	getJdbcConnector(String name)
StorageConnector.KafkaConnector	getKafkaConnector(String name)
String	getName()
ExternalFeatureGroup	getOnDemandFeatureGroup(String name) Deprecated.
ExternalFeatureGroup	getOnDemandFeatureGroup(@NonNull String name, @NonNull Integer version) Deprecated.
scala.collection.Seq<ExternalFeatureGroup>	getOnDemandFeatureGroups(@NonNull String name) Deprecated.
StorageConnector.JdbcConnector	getOnlineStorageConnector()
FeatureGroup	getOrCreateFeatureGroup(String name, Integer version)
FeatureGroup	getOrCreateFeatureGroup(String name, Integer version, List<String> primaryKeys, boolean onlineEnabled, String eventTime)
FeatureGroup	getOrCreateFeatureGroup(String name, Integer version, List<String> primaryKeys, List<String> partitionKeys, boolean onlineEnabled, String eventTime)
FeatureGroup	getOrCreateFeatureGroup(String name, Integer version, String description, List<String> primaryKeys, List<String> partitionKeys, String hudiPrecombineKey, boolean onlineEnabled, TimeTravelFormat timeTravelFormat, StatisticsConfig statisticsConfig, String eventTime)
FeatureView	getOrCreateFeatureView(String name, Query query, Integer version) Get feature view metadata object or create a new one if it doesn't exist.
FeatureView	getOrCreateFeatureView(String name, Query query, Integer version, String description, List<String> labels) Get feature view metadata object or create a new one if it doesn't exist.
StreamFeatureGroup	getOrCreateStreamFeatureGroup(String name, Integer version)
StreamFeatureGroup	getOrCreateStreamFeatureGroup(String name, Integer version, List<String> primaryKeys, boolean onlineEnabled, String eventTime)
StreamFeatureGroup	getOrCreateStreamFeatureGroup(String name, Integer version, List<String> primaryKeys, List<String> partitionKeys, boolean onlineEnabled, String eventTime)
StreamFeatureGroup	getOrCreateStreamFeatureGroup(String name, Integer version, String description, List<String> primaryKeys, List<String> partitionKeys, String hudiPrecombineKey, boolean onlineEnabled, StatisticsConfig statisticsConfig, String eventTime)
Integer	getProjectId()
StorageConnector.RedshiftConnector	getRedshiftConnector(String name)
StorageConnector.S3Connector	getS3Connector(String name)
StorageConnector.SnowflakeConnector	getSnowflakeConnector(String name)
StorageConnector	getStorageConnector(String name)
StreamFeatureGroup	getStreamFeatureGroup(String name) Get a feature group object with default version `1` from the feature store.
StreamFeatureGroup	getStreamFeatureGroup(@NonNull String name, @NonNull Integer version) Get a feature group object from the feature store.
TrainingDataset	getTrainingDataset(String name) Get a training dataset object with the default version `1` from the selected feature store.
TrainingDataset	getTrainingDataset(@NonNull String name, @NonNull Integer version) Get a training dataset object from the selected feature store.
scala.collection.Seq<TrainingDataset>	getTrainingDatasets(@NonNull String name) Get all versions of a training dataset object from the selected feature store.
void	setId(Integer id)
void	setName(String name)
void	setProjectId(Integer projectId)
Object	sql(String query)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FeatureStore

public FeatureStore()

Method Detail

getFeatureGroup

public FeatureGroup getFeatureGroup(@NonNull
                                    @NonNull String name,
                                    @NonNull
                                    @NonNull Integer version)
                             throws FeatureStoreException,
                                    IOException

Get a feature group object from the feature store.

Parameters:

name - the name of the feature group

version - the version of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getFeatureGroup

public FeatureGroup getFeatureGroup(String name)
                             throws FeatureStoreException,
                                    IOException

Get a feature group object with default version `1` from the feature store.

Parameters:

name - the name of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getFeatureGroups

public scala.collection.Seq<FeatureGroup> getFeatureGroups(@NonNull
                                                           @NonNull String name)
                                                    throws FeatureStoreException,
                                                           IOException

Get a list of all versions of a feature group from the feature store.

Parameters:

name - the name of the feature group

Returns:

list of FeatureGroups

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getStreamFeatureGroup

public StreamFeatureGroup getStreamFeatureGroup(@NonNull
                                                @NonNull String name,
                                                @NonNull
                                                @NonNull Integer version)
                                         throws FeatureStoreException,
                                                IOException

Get a feature group object from the feature store.

Parameters:

name - the name of the feature group

version - the version of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getStreamFeatureGroup

public StreamFeatureGroup getStreamFeatureGroup(String name)
                                         throws FeatureStoreException,
                                                IOException

Get a feature group object with default version `1` from the feature store.

Parameters:

name - the name of the feature group

Returns:

FeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getExternalFeatureGroup

public ExternalFeatureGroup getExternalFeatureGroup(@NonNull
                                                    @NonNull String name,
                                                    @NonNull
                                                    @NonNull Integer version)
                                             throws FeatureStoreException,
                                                    IOException

Get a external feature group object from the feature store.

Parameters:

name - the name of the feature group

version - the version of the feature group

Returns:

ExternalFeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getExternalFeatureGroup

public ExternalFeatureGroup getExternalFeatureGroup(String name)
                                             throws FeatureStoreException,
                                                    IOException

Get a external feature group object with default version `1` from the feature store.

Parameters:

name - the name of the feature group

Returns:

ExternalFeatureGroup

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getExternalFeatureGroups

public scala.collection.Seq<ExternalFeatureGroup> getExternalFeatureGroups(@NonNull
                                                                           @NonNull String name)
                                                                    throws FeatureStoreException,
                                                                           IOException

Get a list of all versions of an external feature group from the feature store.

Parameters:

name - the name of the feature group

Returns:

list of ExternalFeatureGroup objects

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getOnDemandFeatureGroup

@Deprecated
public ExternalFeatureGroup getOnDemandFeatureGroup(@NonNull
                                                                @NonNull String name,
                                                                @NonNull
                                                                @NonNull Integer version)
                                                         throws FeatureStoreException,
                                                                IOException

Deprecated.

Throws:

FeatureStoreException

IOException

getOnDemandFeatureGroup

@Deprecated
public ExternalFeatureGroup getOnDemandFeatureGroup(String name)
                                                         throws FeatureStoreException,
                                                                IOException

Deprecated.

Throws:

FeatureStoreException

IOException

getOnDemandFeatureGroups

@Deprecated
public scala.collection.Seq<ExternalFeatureGroup> getOnDemandFeatureGroups(@NonNull
                                                                                       @NonNull String name)
                                                                                throws FeatureStoreException,
                                                                                       IOException

Deprecated.

Throws:

FeatureStoreException

IOException

sql

public Object sql(String query)

getStorageConnector

public StorageConnector getStorageConnector(String name)
                                     throws FeatureStoreException,
                                            IOException

Throws:

FeatureStoreException

IOException

getJdbcConnector

public StorageConnector.JdbcConnector getJdbcConnector(String name)
                                                throws FeatureStoreException,
                                                       IOException

Throws:

FeatureStoreException

IOException

getS3Connector

public StorageConnector.S3Connector getS3Connector(String name)
                                            throws FeatureStoreException,
                                                   IOException

Throws:

FeatureStoreException

IOException

getHopsFsConnector

public StorageConnector.HopsFsConnector getHopsFsConnector(String name)
                                                    throws FeatureStoreException,
                                                           IOException

Throws:

FeatureStoreException

IOException

getRedshiftConnector

public StorageConnector.RedshiftConnector getRedshiftConnector(String name)
                                                        throws FeatureStoreException,
                                                               IOException

Throws:

FeatureStoreException

IOException

getSnowflakeConnector

public StorageConnector.SnowflakeConnector getSnowflakeConnector(String name)
                                                          throws FeatureStoreException,
                                                                 IOException

Throws:

FeatureStoreException

IOException

getAdlsConnector

public StorageConnector.AdlsConnector getAdlsConnector(String name)
                                                throws FeatureStoreException,
                                                       IOException

Throws:

FeatureStoreException

IOException

getKafkaConnector

public StorageConnector.KafkaConnector getKafkaConnector(String name)
                                                  throws FeatureStoreException,
                                                         IOException

Throws:

FeatureStoreException

IOException

getBigqueryConnector

public StorageConnector.BigqueryConnector getBigqueryConnector(String name)
                                                        throws FeatureStoreException,
                                                               IOException

Throws:

FeatureStoreException

IOException

getOnlineStorageConnector

public StorageConnector.JdbcConnector getOnlineStorageConnector()
                                                         throws FeatureStoreException,
                                                                IOException

Throws:

FeatureStoreException

IOException

getGcsConnector

public StorageConnector.GcsConnector getGcsConnector(String name)
                                              throws FeatureStoreException,
                                                     IOException

Throws:

FeatureStoreException

IOException

createFeatureGroup

public FeatureGroup.FeatureGroupBuilder createFeatureGroup()

getOrCreateFeatureGroup

public FeatureGroup getOrCreateFeatureGroup(String name,
                                            Integer version)
                                     throws IOException,
                                            FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public FeatureGroup getOrCreateFeatureGroup(String name,
                                            Integer version,
                                            List<String> primaryKeys,
                                            boolean onlineEnabled,
                                            String eventTime)
                                     throws IOException,
                                            FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public FeatureGroup getOrCreateFeatureGroup(String name,
                                            Integer version,
                                            List<String> primaryKeys,
                                            List<String> partitionKeys,
                                            boolean onlineEnabled,
                                            String eventTime)
                                     throws IOException,
                                            FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateFeatureGroup

public FeatureGroup getOrCreateFeatureGroup(String name,
                                            Integer version,
                                            String description,
                                            List<String> primaryKeys,
                                            List<String> partitionKeys,
                                            String hudiPrecombineKey,
                                            boolean onlineEnabled,
                                            TimeTravelFormat timeTravelFormat,
                                            StatisticsConfig statisticsConfig,
                                            String eventTime)
                                     throws IOException,
                                            FeatureStoreException

Throws:

IOException

FeatureStoreException

createStreamFeatureGroup

public StreamFeatureGroup.StreamFeatureGroupBuilder createStreamFeatureGroup()

getOrCreateStreamFeatureGroup

public StreamFeatureGroup getOrCreateStreamFeatureGroup(String name,
                                                        Integer version)
                                                 throws IOException,
                                                        FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public StreamFeatureGroup getOrCreateStreamFeatureGroup(String name,
                                                        Integer version,
                                                        List<String> primaryKeys,
                                                        boolean onlineEnabled,
                                                        String eventTime)
                                                 throws IOException,
                                                        FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public StreamFeatureGroup getOrCreateStreamFeatureGroup(String name,
                                                        Integer version,
                                                        List<String> primaryKeys,
                                                        List<String> partitionKeys,
                                                        boolean onlineEnabled,
                                                        String eventTime)
                                                 throws IOException,
                                                        FeatureStoreException

Throws:

IOException

FeatureStoreException

getOrCreateStreamFeatureGroup

public StreamFeatureGroup getOrCreateStreamFeatureGroup(String name,
                                                        Integer version,
                                                        String description,
                                                        List<String> primaryKeys,
                                                        List<String> partitionKeys,
                                                        String hudiPrecombineKey,
                                                        boolean onlineEnabled,
                                                        StatisticsConfig statisticsConfig,
                                                        String eventTime)
                                                 throws IOException,
                                                        FeatureStoreException

Throws:

IOException

FeatureStoreException

createExternalFeatureGroup

public ExternalFeatureGroup.ExternalFeatureGroupBuilder createExternalFeatureGroup()

createOnDemandFeatureGroup

@Deprecated
public ExternalFeatureGroup.ExternalFeatureGroupBuilder createOnDemandFeatureGroup()

Deprecated.

createFeatureView

public FeatureView.FeatureViewBuilder createFeatureView()

getOrCreateFeatureView

public FeatureView getOrCreateFeatureView(String name,
                                          Query query,
                                          Integer version)
                                   throws FeatureStoreException,
                                          IOException

Get feature view metadata object or create a new one if it doesn't exist. This method doesn't update existing feature view metadata object.

Parameters:

name - name of the feature view

query - Query object

version - version of the feature view

Returns:

FeatureView

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getOrCreateFeatureView

public FeatureView getOrCreateFeatureView(String name,
                                          Query query,
                                          Integer version,
                                          String description,
                                          List<String> labels)
                                   throws FeatureStoreException,
                                          IOException

Get feature view metadata object or create a new one if it doesn't exist. This method doesn't update existing feature view metadata object.

Parameters:

name - name of the feature view

query - Query object

version - version of the feature view

description - description of the feature view

labels - list of label features

Returns:

FeatureView

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getFeatureView

public FeatureView getFeatureView(@NonNull
                                  @NonNull String name,
                                  @NonNull
                                  @NonNull Integer version)
                           throws FeatureStoreException,
                                  IOException

Get a feature view object from the selected feature store.

Parameters:

name - name of the feature view

version - version to get

Returns:

FeatureView

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getFeatureView

public FeatureView getFeatureView(String name)
                           throws FeatureStoreException,
                                  IOException

Get a feature view object with the default version `1` from the selected feature store.

Parameters:

name - name of the feature view

Returns:

FeatureView

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

createTrainingDataset

public TrainingDataset.TrainingDatasetBuilder createTrainingDataset()

getTrainingDataset

public TrainingDataset getTrainingDataset(@NonNull
                                          @NonNull String name,
                                          @NonNull
                                          @NonNull Integer version)
                                   throws FeatureStoreException,
                                          IOException

Get a training dataset object from the selected feature store.

Parameters:

name - name of the training dataset

version - version to get

Returns:

TrainingDataset

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getTrainingDataset

public TrainingDataset getTrainingDataset(String name)
                                   throws FeatureStoreException,
                                          IOException

Get a training dataset object with the default version `1` from the selected feature store.

Parameters:

name - name of the training dataset

Returns:

TrainingDataset

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

getTrainingDatasets

public scala.collection.Seq<TrainingDataset> getTrainingDatasets(@NonNull
                                                                 @NonNull String name)
                                                          throws FeatureStoreException,
                                                                 IOException

Get all versions of a training dataset object from the selected feature store.

Parameters:

name - name of the training dataset

Returns:

TrainingDataset

Throws:

FeatureStoreException - FeatureStoreException

IOException - IOException

toString

public String toString()

Overrides:

toString in class Object

getId

public Integer getId()

setId

public void setId(Integer id)

getName

public String getName()

setName

public void setName(String name)

getProjectId

public Integer getProjectId()

setProjectId

public void setProjectId(Integer projectId)