FeatureGroup (AWS Java SDK :: Services :: Amazon SageMaker 2.15.45 API)

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.FeatureGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FeatureGroup.Builder,FeatureGroup>
```
@Generated(value="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 and Description

static interface FeatureGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FeatureGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FeatureGroup.Builder`	`builder()`
`Instant`	`creationTime()` The time a `FeatureGroup` was created.
`String`	`description()` A free form description of a `FeatureGroup`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventTimeFeatureName()` The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup`.
`String`	`failureReason()` The reason that the `FeatureGroup` failed to be replicated in the `OfflineStore`.
`List<FeatureDefinition>`	`featureDefinitions()` A list of `Feature`s.
`String`	`featureGroupArn()` The Amazon Resource Name (ARN) of a `FeatureGroup`.
`String`	`featureGroupName()` The name of the `FeatureGroup`.
`FeatureGroupStatus`	`featureGroupStatus()` A `FeatureGroup` status.
`String`	`featureGroupStatusAsString()` A `FeatureGroup` status.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFeatureDefinitions()` Returns true if the FeatureDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `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 a `FeatureGroup`.
`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 String featureGroupArn()
```
    The Amazon Resource Name (ARN) of a FeatureGroup.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a FeatureGroup.
  - featureGroupName
```
public String featureGroupName()
```
    The name of the FeatureGroup.
    
    Returns:
    
    The name of the FeatureGroup.
  - recordIdentifierFeatureName
```
public 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 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 boolean hasFeatureDefinitions()
```
    Returns true if the FeatureDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - featureDefinitions
```
public 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.
    
    You can use hasFeatureDefinitions() to see if a value was sent in this field.
    
    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 Instant creationTime()
```
    The time a FeatureGroup was created.
    
    Returns:
    
    The time a FeatureGroup was created.
  - onlineStoreConfig
```
public OnlineStoreConfig onlineStoreConfig()
```
    Returns the value of the OnlineStoreConfig property for this object.
    
    Returns:
    
    The value of the OnlineStoreConfig property for this object.
  - offlineStoreConfig
```
public OfflineStoreConfig offlineStoreConfig()
```
    Returns the value of the OfflineStoreConfig property for this object.
    
    Returns:
    
    The value of the OfflineStoreConfig property for this object.
  - roleArn
```
public 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 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:
    
    FeatureGroupStatus
  - featureGroupStatusAsString
```
public 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:
    
    FeatureGroupStatus
  - offlineStoreStatus
```
public OfflineStoreStatus offlineStoreStatus()
```
    Returns the value of the OfflineStoreStatus property for this object.
    
    Returns:
    
    The value of the OfflineStoreStatus property for this object.
  - failureReason
```
public 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 String description()
```
    A free form description of a FeatureGroup.
    
    Returns:
    
    A free form description of a FeatureGroup.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<Tag> tags()
```
    Tags used to define a FeatureGroup.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Tags used to define a FeatureGroup.
  - toBuilder
```
public FeatureGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FeatureGroup.Builder,FeatureGroup>
  - builder
```
public static FeatureGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FeatureGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FeatureGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

featureGroupArn

featureGroupName

recordIdentifierFeatureName

eventTimeFeatureName

hasFeatureDefinitions

featureDefinitions

creationTime

onlineStoreConfig

offlineStoreConfig

roleArn

featureGroupStatus

featureGroupStatusAsString

offlineStoreStatus

failureReason

description

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields