@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FeatureGroup extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
FeatureGroup() |
| Modifier and Type | Method and Description |
|---|---|
FeatureGroup |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationTime()
The time a
FeatureGroup was created. |
String |
getDescription()
A free form description of a
FeatureGroup. |
String |
getEventTimeFeatureName()
The name of the feature that stores the
EventTime of a Record in a FeatureGroup. |
String |
getFailureReason()
The reason that the
FeatureGroup failed to be replicated in the OfflineStore. |
List<FeatureDefinition> |
getFeatureDefinitions()
A list of
Features. |
String |
getFeatureGroupArn()
The Amazon Resource Name (ARN) of a
FeatureGroup. |
String |
getFeatureGroupName()
The name of the
FeatureGroup. |
String |
getFeatureGroupStatus()
A
FeatureGroup status. |
Date |
getLastModifiedTime()
A timestamp indicating the last time you updated the feature group.
|
LastUpdateStatus |
getLastUpdateStatus()
A value that indicates whether the feature group was updated successfully.
|
OfflineStoreConfig |
getOfflineStoreConfig() |
OfflineStoreStatus |
getOfflineStoreStatus() |
OnlineStoreConfig |
getOnlineStoreConfig() |
String |
getRecordIdentifierFeatureName()
The name of the
Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions. |
String |
getRoleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
|
List<Tag> |
getTags()
Tags used to define a
FeatureGroup. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCreationTime(Date creationTime)
The time a
FeatureGroup was created. |
void |
setDescription(String description)
A free form description of a
FeatureGroup. |
void |
setEventTimeFeatureName(String eventTimeFeatureName)
The name of the feature that stores the
EventTime of a Record in a FeatureGroup. |
void |
setFailureReason(String failureReason)
The reason that the
FeatureGroup failed to be replicated in the OfflineStore. |
void |
setFeatureDefinitions(Collection<FeatureDefinition> featureDefinitions)
A list of
Features. |
void |
setFeatureGroupArn(String featureGroupArn)
The Amazon Resource Name (ARN) of a
FeatureGroup. |
void |
setFeatureGroupName(String featureGroupName)
The name of the
FeatureGroup. |
void |
setFeatureGroupStatus(String featureGroupStatus)
A
FeatureGroup status. |
void |
setLastModifiedTime(Date lastModifiedTime)
A timestamp indicating the last time you updated the feature group.
|
void |
setLastUpdateStatus(LastUpdateStatus lastUpdateStatus)
A value that indicates whether the feature group was updated successfully.
|
void |
setOfflineStoreConfig(OfflineStoreConfig offlineStoreConfig) |
void |
setOfflineStoreStatus(OfflineStoreStatus offlineStoreStatus) |
void |
setOnlineStoreConfig(OnlineStoreConfig onlineStoreConfig) |
void |
setRecordIdentifierFeatureName(String recordIdentifierFeatureName)
The name of the
Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions. |
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
|
void |
setTags(Collection<Tag> tags)
Tags used to define a
FeatureGroup. |
String |
toString()
Returns a string representation of this object.
|
FeatureGroup |
withCreationTime(Date creationTime)
The time a
FeatureGroup was created. |
FeatureGroup |
withDescription(String description)
A free form description of a
FeatureGroup. |
FeatureGroup |
withEventTimeFeatureName(String eventTimeFeatureName)
The name of the feature that stores the
EventTime of a Record in a FeatureGroup. |
FeatureGroup |
withFailureReason(String failureReason)
The reason that the
FeatureGroup failed to be replicated in the OfflineStore. |
FeatureGroup |
withFeatureDefinitions(Collection<FeatureDefinition> featureDefinitions)
A list of
Features. |
FeatureGroup |
withFeatureDefinitions(FeatureDefinition... featureDefinitions)
A list of
Features. |
FeatureGroup |
withFeatureGroupArn(String featureGroupArn)
The Amazon Resource Name (ARN) of a
FeatureGroup. |
FeatureGroup |
withFeatureGroupName(String featureGroupName)
The name of the
FeatureGroup. |
FeatureGroup |
withFeatureGroupStatus(FeatureGroupStatus featureGroupStatus)
A
FeatureGroup status. |
FeatureGroup |
withFeatureGroupStatus(String featureGroupStatus)
A
FeatureGroup status. |
FeatureGroup |
withLastModifiedTime(Date lastModifiedTime)
A timestamp indicating the last time you updated the feature group.
|
FeatureGroup |
withLastUpdateStatus(LastUpdateStatus lastUpdateStatus)
A value that indicates whether the feature group was updated successfully.
|
FeatureGroup |
withOfflineStoreConfig(OfflineStoreConfig offlineStoreConfig) |
FeatureGroup |
withOfflineStoreStatus(OfflineStoreStatus offlineStoreStatus) |
FeatureGroup |
withOnlineStoreConfig(OnlineStoreConfig onlineStoreConfig) |
FeatureGroup |
withRecordIdentifierFeatureName(String recordIdentifierFeatureName)
The name of the
Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions. |
FeatureGroup |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
|
FeatureGroup |
withTags(Collection<Tag> tags)
Tags used to define a
FeatureGroup. |
FeatureGroup |
withTags(Tag... tags)
Tags used to define a
FeatureGroup. |
public void setFeatureGroupArn(String featureGroupArn)
The Amazon Resource Name (ARN) of a FeatureGroup.
featureGroupArn - The Amazon Resource Name (ARN) of a FeatureGroup.public String getFeatureGroupArn()
The Amazon Resource Name (ARN) of a FeatureGroup.
FeatureGroup.public FeatureGroup withFeatureGroupArn(String featureGroupArn)
The Amazon Resource Name (ARN) of a FeatureGroup.
featureGroupArn - The Amazon Resource Name (ARN) of a FeatureGroup.public void setFeatureGroupName(String featureGroupName)
The name of the FeatureGroup.
featureGroupName - The name of the FeatureGroup.public String getFeatureGroupName()
The name of the FeatureGroup.
FeatureGroup.public FeatureGroup withFeatureGroupName(String featureGroupName)
The name of the FeatureGroup.
featureGroupName - The name of the FeatureGroup.public void setRecordIdentifierFeatureName(String recordIdentifierFeatureName)
The name of the Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.
recordIdentifierFeatureName - The name of the Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.public String getRecordIdentifierFeatureName()
The name of the Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.
Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.public FeatureGroup withRecordIdentifierFeatureName(String recordIdentifierFeatureName)
The name of the Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.
recordIdentifierFeatureName - The name of the Feature whose value uniquely identifies a Record defined in the
FeatureGroup FeatureDefinitions.public void setEventTimeFeatureName(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.
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.
public String getEventTimeFeatureName()
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.
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.
public FeatureGroup withEventTimeFeatureName(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.
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.
public List<FeatureDefinition> getFeatureDefinitions()
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.
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.
public void setFeatureDefinitions(Collection<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.
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.
public FeatureGroup withFeatureDefinitions(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.
NOTE: This method appends the values to the existing list (if any). Use
setFeatureDefinitions(java.util.Collection) or withFeatureDefinitions(java.util.Collection) if
you want to override the existing values.
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.
public FeatureGroup withFeatureDefinitions(Collection<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.
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.
public void setCreationTime(Date creationTime)
The time a FeatureGroup was created.
creationTime - The time a FeatureGroup was created.public Date getCreationTime()
The time a FeatureGroup was created.
FeatureGroup was created.public FeatureGroup withCreationTime(Date creationTime)
The time a FeatureGroup was created.
creationTime - The time a FeatureGroup was created.public void setLastModifiedTime(Date lastModifiedTime)
A timestamp indicating the last time you updated the feature group.
lastModifiedTime - A timestamp indicating the last time you updated the feature group.public Date getLastModifiedTime()
A timestamp indicating the last time you updated the feature group.
public FeatureGroup withLastModifiedTime(Date lastModifiedTime)
A timestamp indicating the last time you updated the feature group.
lastModifiedTime - A timestamp indicating the last time you updated the feature group.public void setOnlineStoreConfig(OnlineStoreConfig onlineStoreConfig)
onlineStoreConfig - public OnlineStoreConfig getOnlineStoreConfig()
public FeatureGroup withOnlineStoreConfig(OnlineStoreConfig onlineStoreConfig)
onlineStoreConfig - public void setOfflineStoreConfig(OfflineStoreConfig offlineStoreConfig)
offlineStoreConfig - public OfflineStoreConfig getOfflineStoreConfig()
public FeatureGroup withOfflineStoreConfig(OfflineStoreConfig offlineStoreConfig)
offlineStoreConfig - public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.public String getRoleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
public FeatureGroup withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.public void setFeatureGroupStatus(String featureGroupStatus)
A FeatureGroup status.
featureGroupStatus - A FeatureGroup status.FeatureGroupStatuspublic String getFeatureGroupStatus()
A FeatureGroup status.
FeatureGroup status.FeatureGroupStatuspublic FeatureGroup withFeatureGroupStatus(String featureGroupStatus)
A FeatureGroup status.
featureGroupStatus - A FeatureGroup status.FeatureGroupStatuspublic FeatureGroup withFeatureGroupStatus(FeatureGroupStatus featureGroupStatus)
A FeatureGroup status.
featureGroupStatus - A FeatureGroup status.FeatureGroupStatuspublic void setOfflineStoreStatus(OfflineStoreStatus offlineStoreStatus)
offlineStoreStatus - public OfflineStoreStatus getOfflineStoreStatus()
public FeatureGroup withOfflineStoreStatus(OfflineStoreStatus offlineStoreStatus)
offlineStoreStatus - public void setLastUpdateStatus(LastUpdateStatus lastUpdateStatus)
A value that indicates whether the feature group was updated successfully.
lastUpdateStatus - A value that indicates whether the feature group was updated successfully.public LastUpdateStatus getLastUpdateStatus()
A value that indicates whether the feature group was updated successfully.
public FeatureGroup withLastUpdateStatus(LastUpdateStatus lastUpdateStatus)
A value that indicates whether the feature group was updated successfully.
lastUpdateStatus - A value that indicates whether the feature group was updated successfully.public void setFailureReason(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.
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.public String getFailureReason()
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.
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.public FeatureGroup withFailureReason(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.
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.public void setDescription(String description)
A free form description of a FeatureGroup.
description - A free form description of a FeatureGroup.public String getDescription()
A free form description of a FeatureGroup.
FeatureGroup.public FeatureGroup withDescription(String description)
A free form description of a FeatureGroup.
description - A free form description of a FeatureGroup.public List<Tag> getTags()
Tags used to define a FeatureGroup.
FeatureGroup.public void setTags(Collection<Tag> tags)
Tags used to define a FeatureGroup.
tags - Tags used to define a FeatureGroup.public FeatureGroup withTags(Tag... tags)
Tags used to define a FeatureGroup.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - Tags used to define a FeatureGroup.public FeatureGroup withTags(Collection<Tag> tags)
Tags used to define a FeatureGroup.
tags - Tags used to define a FeatureGroup.public String toString()
toString in class ObjectObject.toString()public FeatureGroup clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.