Class FeatureGroup

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

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

See Also:

  • Method Details

    • featureGroupArn

      public final String featureGroupArn()

      The Amazon Resource Name (ARN) of a FeatureGroup.

      Returns:
      The Amazon Resource Name (ARN) of a FeatureGroup.

    • featureGroupName

      public final String featureGroupName()

      The name of the FeatureGroup.

      Returns:
      The name of the FeatureGroup.

    • recordIdentifierFeatureName

      public final String recordIdentifierFeatureName()

      The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

      Returns:
      The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

    • eventTimeFeatureName

      public final String eventTimeFeatureName()

      The name of the feature that stores the EventTime of a Record in a FeatureGroup.

      A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

      Returns:
      The name of the feature that stores the EventTime of a Record in a FeatureGroup .

      A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

    • hasFeatureDefinitions

      public final boolean hasFeatureDefinitions()
      For responses, this returns true if the service returned a value for the FeatureDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • featureDefinitions

      public final List<FeatureDefinition> featureDefinitions()

      A list of Features. Each Feature must include a FeatureName and a FeatureType.

      Valid FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeatureDefinitions() method.

      Returns:
      A list of Features. Each Feature must include a FeatureName and a FeatureType.

      Valid FeatureTypes are Integral, Fractional and String.

      FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

      You can create up to 2,500 FeatureDefinitions per FeatureGroup.

    • creationTime

      public final Instant creationTime()

      The time a FeatureGroup was created.

      Returns:
      The time a FeatureGroup was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp indicating the last time you updated the feature group.

      Returns:
      A timestamp indicating the last time you updated the feature group.

    • onlineStoreConfig

      public final OnlineStoreConfig onlineStoreConfig()
      Returns the value of the OnlineStoreConfig property for this object.
      Returns:
      The value of the OnlineStoreConfig property for this object.

    • offlineStoreConfig

      public final OfflineStoreConfig offlineStoreConfig()
      Returns the value of the OfflineStoreConfig property for this object.
      Returns:
      The value of the OfflineStoreConfig property for this object.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

      Returns:
      The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

    • featureGroupStatus

      public final FeatureGroupStatus featureGroupStatus()

      A FeatureGroup status.

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

      Returns:
      A FeatureGroup status.
      See Also:

    • featureGroupStatusAsString

      public final String featureGroupStatusAsString()

      A FeatureGroup status.

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

      Returns:
      A FeatureGroup status.
      See Also:

    • offlineStoreStatus

      public final OfflineStoreStatus offlineStoreStatus()
      Returns the value of the OfflineStoreStatus property for this object.
      Returns:
      The value of the OfflineStoreStatus property for this object.

    • lastUpdateStatus

      public final LastUpdateStatus lastUpdateStatus()

      A value that indicates whether the feature group was updated successfully.

      Returns:
      A value that indicates whether the feature group was updated successfully.

    • failureReason

      public final String failureReason()

      The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

      Returns:
      The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

    • description

      public final String description()

      A free form description of a FeatureGroup.

      Returns:
      A free form description of a FeatureGroup.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Tags used to define a FeatureGroup.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags used to define a FeatureGroup.

    • toBuilder

      public FeatureGroup.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<FeatureGroup.Builder,FeatureGroup>
      Returns:
      a builder for type T

    • builder

      public static FeatureGroup.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FeatureGroup.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.