Struct FeatureDefinition

#[non_exhaustive]
pub struct FeatureDefinition {
    pub feature_name: Option<String>,
    pub feature_type: Option<FeatureType>,
    pub collection_type: Option<CollectionType>,
    pub collection_config: Option<CollectionConfig>,
}

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

feature_name: Option<String>

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

• Must start with an alphanumeric character.

• Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

feature_type: Option<FeatureType>

The value type of a feature. Valid values are Integral, Fractional, or String.

collection_type: Option<CollectionType>

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

• List: An ordered collection of elements.

• Set: An unordered collection of unique elements.

• Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

collection_config: Option<CollectionConfig>

Configuration for your collection.

Implementations

impl FeatureDefinition

pub fn feature_name(&self) -> Option<&str>

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

• Must start with an alphanumeric character.

• Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

pub fn feature_type(&self) -> Option<&FeatureType>

The value type of a feature. Valid values are Integral, Fractional, or String.

pub fn collection_type(&self) -> Option<&CollectionType>

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

• List: An ordered collection of elements.

• Set: An unordered collection of unique elements.

• Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

pub fn collection_config(&self) -> Option<&CollectionConfig>

Configuration for your collection.

impl FeatureDefinition

pub fn builder() -> FeatureDefinitionBuilder

Creates a new builder-style object to manufacture FeatureDefinition.

Trait Implementations

impl Clone for FeatureDefinition

fn clone(&self) -> FeatureDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FeatureDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FeatureDefinition

fn eq(&self, other: &FeatureDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FeatureDefinition