Class FeatureDefinition

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.FeatureDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FeatureDefinition.Builder,FeatureDefinition>
@Generated("software.amazon.awssdk:codegen") public final class FeatureDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FeatureDefinition.Builder,FeatureDefinition>

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

See Also:

  • Method Details

    • 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.

      The name:

      • Must start with an alphanumeric character.

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

      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.

      The name:

      • Must start with an alphanumeric character.

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

    • 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:

    • 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:

    • 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:

    • 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:

    • collectionConfig

      public final CollectionConfig collectionConfig()

      Configuration for your collection.

      Returns:
      Configuration for your collection.

    • toBuilder

      public FeatureDefinition.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FeatureDefinition.Builder,FeatureDefinition>
      Returns:
      a builder for type T

    • builder

      public static FeatureDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FeatureDefinition.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.