Class FeatureGroup
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FeatureGroup.Builder
builder()
final Instant
The time aFeatureGroup
was created.final String
A free form description of aFeatureGroup
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the feature that stores theEventTime
of a Record in aFeatureGroup
.final String
The reason that theFeatureGroup
failed to be replicated in theOfflineStore
.final List
<FeatureDefinition> A list ofFeature
s.final String
The Amazon Resource Name (ARN) of aFeatureGroup
.final String
The name of theFeatureGroup
.final FeatureGroupStatus
AFeatureGroup
status.final String
AFeatureGroup
status.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FeatureDefinitions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
A timestamp indicating the last time you updated the feature group.final LastUpdateStatus
A value that indicates whether the feature group was updated successfully.final OfflineStoreConfig
Returns the value of the OfflineStoreConfig property for this object.final OfflineStoreStatus
Returns the value of the OfflineStoreStatus property for this object.final OnlineStoreConfig
Returns the value of the OnlineStoreConfig property for this object.final String
The name of theFeature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.static Class
<? extends FeatureGroup.Builder> tags()
Tags used to define aFeatureGroup
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
featureGroupArn
The Amazon Resource Name (ARN) of a
FeatureGroup
.- Returns:
- The Amazon Resource Name (ARN) of a
FeatureGroup
.
-
featureGroupName
The name of the
FeatureGroup
.- Returns:
- The name of the
FeatureGroup
.
-
recordIdentifierFeatureName
The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.- Returns:
- The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.
-
eventTimeFeatureName
The name of the feature that stores the
EventTime
of a Record in aFeatureGroup
.A
EventTime
is point in time when a new event occurs that corresponds to the creation or update of aRecord
inFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.- Returns:
- The name of the feature that stores the
EventTime
of a Record in aFeatureGroup
.A
EventTime
is point in time when a new event occurs that corresponds to the creation or update of aRecord
inFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.
-
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 theisEmpty()
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
A list of
Feature
s. EachFeature
must include aFeatureName
and aFeatureType
.Valid
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.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
Feature
s. EachFeature
must include aFeatureName
and aFeatureType
.Valid
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.
-
creationTime
The time a
FeatureGroup
was created.- Returns:
- The time a
FeatureGroup
was created.
-
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
Returns the value of the OnlineStoreConfig property for this object.- Returns:
- The value of the OnlineStoreConfig property for this object.
-
offlineStoreConfig
Returns the value of the OfflineStoreConfig property for this object.- Returns:
- The value of the OfflineStoreConfig property for this object.
-
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
A
FeatureGroup
status.If the service returns an enum value that is not available in the current SDK version,
featureGroupStatus
will returnFeatureGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureGroupStatusAsString()
.- Returns:
- A
FeatureGroup
status. - See Also:
-
featureGroupStatusAsString
A
FeatureGroup
status.If the service returns an enum value that is not available in the current SDK version,
featureGroupStatus
will returnFeatureGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureGroupStatusAsString()
.- Returns:
- A
FeatureGroup
status. - See Also:
-
offlineStoreStatus
Returns the value of the OfflineStoreStatus property for this object.- Returns:
- The value of the OfflineStoreStatus property for this object.
-
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
The reason that the
FeatureGroup
failed to be replicated in theOfflineStore
. This is failure may be due to a failure to create aFeatureGroup
in or delete aFeatureGroup
from theOfflineStore
.- Returns:
- The reason that the
FeatureGroup
failed to be replicated in theOfflineStore
. This is failure may be due to a failure to create aFeatureGroup
in or delete aFeatureGroup
from theOfflineStore
.
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<FeatureGroup.Builder,
FeatureGroup> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-