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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FeatureGroup.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FeatureGroup.Builder
builder()
Instant
creationTime()
The time aFeatureGroup
was created.String
description()
A free form description of aFeatureGroup
.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
eventTimeFeatureName()
The name of the feature that stores theEventTime
of a Record in aFeatureGroup
.String
failureReason()
The reason that theFeatureGroup
failed to be replicated in theOfflineStore
.List<FeatureDefinition>
featureDefinitions()
A list ofFeature
s.String
featureGroupArn()
The Amazon Resource Name (ARN) of aFeatureGroup
.String
featureGroupName()
The name of theFeatureGroup
.FeatureGroupStatus
featureGroupStatus()
AFeatureGroup
status.String
featureGroupStatusAsString()
AFeatureGroup
status.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFeatureDefinitions()
For responses, this returns true if the service returned a value for the FeatureDefinitions property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Instant
lastModifiedTime()
A timestamp indicating the last time you updated the feature group.LastUpdateStatus
lastUpdateStatus()
A value that indicates whether the feature group was updated successfully.OfflineStoreConfig
offlineStoreConfig()
Returns the value of the OfflineStoreConfig property for this object.OfflineStoreStatus
offlineStoreStatus()
Returns the value of the OfflineStoreStatus property for this object.OnlineStoreConfig
onlineStoreConfig()
Returns the value of the OnlineStoreConfig property for this object.String
recordIdentifierFeatureName()
The name of theFeature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.String
roleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.List<SdkField<?>>
sdkFields()
static Class<? extends FeatureGroup.Builder>
serializableBuilderClass()
List<Tag>
tags()
Tags used to define aFeatureGroup
.FeatureGroup.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 aRecord
defined in theFeatureGroup
FeatureDefinitions
.- Returns:
- The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.
-
eventTimeFeatureName
public final String 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
public final List<FeatureDefinition> 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
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 returnFeatureGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureGroupStatusAsString()
.- Returns:
- A
FeatureGroup
status. - See Also:
FeatureGroupStatus
-
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 returnFeatureGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureGroupStatusAsString()
.- Returns:
- A
FeatureGroup
status. - See Also:
FeatureGroupStatus
-
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 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
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 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
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<FeatureGroup.Builder,FeatureGroup>
-
builder
public static FeatureGroup.Builder builder()
-
serializableBuilderClass
public static Class<? extends FeatureGroup.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-