ai.tecton.client.model

Class FeatureValue

java.lang.Object

ai.tecton.client.model.FeatureValue

public class FeatureValue
extends java.lang.Object

Class that represents each feature value in the feature vector returned in the GetFeaturesResponse

Constructor Summary

Constructors

Constructor and Description
FeatureValue(java.lang.Object featureObject, java.lang.String name, ValueType valueType, java.util.Optional<ValueType> elementValueType, java.lang.String effectiveTime, java.util.Optional<FeatureStatus> featureStatus)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	booleanValue() A Feature Value of type Boolean
java.util.List<java.lang.Float>	float32ArrayValue() A Feature Value of type ARRAY with FLOAT32 values
java.util.List<java.lang.Double>	float64ArrayValue() A Feature Value of type ARRAY with FLOAT64 values
java.lang.Double	float64Value() A Feature Value of type Float64 (Double)
java.util.Optional<java.time.Instant>	getEffectiveTime() Returns the effective serving time for this feature.
java.lang.String	getFeatureName() Returns the feature service name
java.lang.String	getFeatureNamespace() Returns the feature service namespace
java.util.Optional<FeatureStatus>	getFeatureStatus() Returns the feature status of the feature value.
java.util.Optional<ValueType>	getListElementType() Returns the individual array element type if the feature valueType is ARRAY.
ValueType	getValueType() Returns the ValueType representing the Tecton data_type for the feature value.
java.util.List<java.lang.Long>	int64ArrayValue() A Feature Value of type ARRAY with INT64 values
java.lang.Long	int64value() A Feature Value of type int64 (Long)
java.util.List<java.lang.String>	stringArrayValue() A Feature Value of type ARRAY with String values
java.lang.String	stringValue() A Feature Value of type String

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureValue

public FeatureValue(java.lang.Object featureObject,
                    java.lang.String name,
                    ValueType valueType,
                    java.util.Optional<ValueType> elementValueType,
                    java.lang.String effectiveTime,
                    java.util.Optional<FeatureStatus> featureStatus)

Method Detail

getValueType

public ValueType getValueType()

Returns the ValueType representing the Tecton data_type for the feature value. Currently supported types are ARRAY, STRING, INT64, BOOLEAN and FLOAT64

Returns:

ValueType of the feature value

getListElementType

public java.util.Optional<ValueType> getListElementType()

Returns the individual array element type if the feature valueType is ARRAY.

Returns:

ValueType of the feature values in the array wrapped in Optional if the getValueType() is ARRAY, Optional.empty() otherwise

getFeatureStatus

public java.util.Optional<FeatureStatus> getFeatureStatus()

Returns the feature status of the feature value. PRESENT if the feature value is retrieved and present in the online store or MISSING_DATA if the feature value is missing or outside TTL

Returns:

Optional<String> of the feature value statuses Optional.

getEffectiveTime

public java.util.Optional<java.time.Instant> getEffectiveTime()

Returns the effective serving time for this feature. This is the most recent time that's aligned to the interval for which a full aggregation is available for this feature. Note: Only present if MetadataOption.EFFECTIVE_TIME is included in the GetFeaturesRequest

Returns:

Optional<Instant> representing the effectiveTime if present, Optional.empty() otherwise

getFeatureName

public java.lang.String getFeatureName()

Returns the feature service name

getFeatureNamespace

public java.lang.String getFeatureNamespace()

Returns the feature service namespace

stringValue

public java.lang.String stringValue()
                             throws TectonClientException

A Feature Value of type String

Returns:

feature value cast to java.lang.String

Throws:

TectonClientException - if the method is called on a value whose ValueType is not STRING

int64value

public java.lang.Long int64value()
                          throws TectonClientException

A Feature Value of type int64 (Long)

Returns:

feature value cast to java.lang.Long

Throws:

TectonClientException - if the method is called on a value whose ValueType is not INT64

booleanValue

public java.lang.Boolean booleanValue()
                               throws TectonClientException

A Feature Value of type Boolean

Returns:

feature value cast to java.lang.Boolean

Throws:

TectonClientException - if the method is called on a value whose ValueType is not BOOLEAN

float64Value

public java.lang.Double float64Value()
                              throws TectonClientException

A Feature Value of type Float64 (Double)

Returns:

feature value cast to java.lang.Double

Throws:

TectonClientException - if the method is called on a value whose ValueType is not FLOAT64

float64ArrayValue

public java.util.List<java.lang.Double> float64ArrayValue()
                                                   throws TectonClientException

A Feature Value of type ARRAY with FLOAT64 values

Returns:

feature value cast to List<Double>

Throws:

TectonClientException - if the method is called on a value whose valueType is not ARRAY or listElementType is not FLOAT64

float32ArrayValue

public java.util.List<java.lang.Float> float32ArrayValue()
                                                  throws TectonClientException

A Feature Value of type ARRAY with FLOAT32 values

Returns:

feature value cast to List<Float>

Throws:

TectonClientException - if the method is called on a value whose valueType is not ARRAY or listElementType is not FLOAT32

int64ArrayValue

public java.util.List<java.lang.Long> int64ArrayValue()
                                               throws TectonClientException

A Feature Value of type ARRAY with INT64 values

Returns:

feature value cast to List<Long>

Throws:

TectonClientException - if the method is called on a value whose valueType is not ARRAY or listElementType is not INT64

stringArrayValue

public java.util.List<java.lang.String> stringArrayValue()
                                                  throws TectonClientException

A Feature Value of type ARRAY with String values

Returns:

feature value cast to List<String>

Throws:

TectonClientException - if the method is called on a value whose valueType is not ARRAY or listElementType is not STRING