Class FeatureDefinition

    • Method Detail

      • featureName

        public final String featureName()

        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.

        Returns:
        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.
      • featureType

        public final FeatureType featureType()

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

        If the service returns an enum value that is not available in the current SDK version, featureType will return FeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureTypeAsString().

        Returns:
        The value type of a feature. Valid values are Integral, Fractional, or String.
        See Also:
        FeatureType
      • featureTypeAsString

        public final String featureTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, featureType will return FeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureTypeAsString().

        Returns:
        The value type of a feature. Valid values are Integral, Fractional, or String.
        See Also:
        FeatureType
      • collectionType

        public final CollectionType 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.

        If the service returns an enum value that is not available in the current SDK version, collectionType will return CollectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from collectionTypeAsString().

        Returns:
        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.

        See Also:
        CollectionType
      • collectionTypeAsString

        public final String collectionTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, collectionType will return CollectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from collectionTypeAsString().

        Returns:
        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.

        See Also:
        CollectionType
      • collectionConfig

        public final CollectionConfig collectionConfig()

        Configuration for your collection.

        Returns:
        Configuration for your collection.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)