DescribeFeatureGroupResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
    - - software.amazon.awssdk.services.sagemaker.model.DescribeFeatureGroupResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeFeatureGroupResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeFeatureGroupResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeFeatureGroupResponse.Builder`	`builder()`
`Instant`	`creationTime()` A timestamp indicating when SageMaker created the `FeatureGroup`.
`String`	`description()` A free form description of the feature group.
`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 the `Features` in the `FeatureGroup`.
`String`	`featureGroupArn()` The Amazon Resource Name (ARN) of the `FeatureGroup`.
`String`	`featureGroupName()` he name of the `FeatureGroup`.
`FeatureGroupStatus`	`featureGroupStatus()` The status of the feature group.
`String`	`featureGroupStatusAsString()` The status of the feature group.
`<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()`
`Instant`	`lastModifiedTime()` A timestamp indicating when the feature group was last updated.
`LastUpdateStatus`	`lastUpdateStatus()` A value indicating whether the update made to the feature group was successful.
`String`	`nextToken()` A token to resume pagination of the list of `Features` (`FeatureDefinitions`).
`OfflineStoreConfig`	`offlineStoreConfig()` The configuration of the offline store.
`OfflineStoreStatus`	`offlineStoreStatus()` The status of the `OfflineStore`.
`OnlineStoreConfig`	`onlineStoreConfig()` The configuration for the `OnlineStore`.
`Long`	`onlineStoreTotalSizeBytes()` The size of the `OnlineStore` in bytes.
`String`	`recordIdentifierFeatureName()` The name of the `Feature` used for `RecordIdentifier`, whose value uniquely identifies a record stored in the feature store.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeFeatureGroupResponse.Builder>`	`serializableBuilderClass()`
`DescribeFeatureGroupResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 the FeatureGroup.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the FeatureGroup.
  - featureGroupName
```
public final String featureGroupName()
```
    he name of the FeatureGroup.
    
    Returns:
    
    he name of the FeatureGroup.
  - recordIdentifierFeatureName
```
public final String recordIdentifierFeatureName()
```
    The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.
    
    Returns:
    
    The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.
  - eventTimeFeatureName
```
public final String eventTimeFeatureName()
```
    The name of the feature that stores the EventTime of a Record in a FeatureGroup.
    
    An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.
    
    Returns:
    
    The name of the feature that stores the EventTime of a Record in a FeatureGroup .
    
    An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup 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 the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
    
    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 the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
  - creationTime
```
public final Instant creationTime()
```
    A timestamp indicating when SageMaker created the FeatureGroup.
    
    Returns:
    
    A timestamp indicating when SageMaker created the FeatureGroup.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    A timestamp indicating when the feature group was last updated.
    
    Returns:
    
    A timestamp indicating when the feature group was last updated.
  - onlineStoreConfig
```
public final OnlineStoreConfig onlineStoreConfig()
```
    The configuration for the OnlineStore.
    
    Returns:
    
    The configuration for the OnlineStore.
  - offlineStoreConfig
```
public final OfflineStoreConfig offlineStoreConfig()
```
    The configuration of the offline store. It includes the following configurations:
    - Amazon S3 location of the offline store.
    - Configuration of the Glue data catalog.
    - Table format of the offline store.
    - Option to disable the automatic creation of a Glue table for the offline store.
    - Encryption configuration.
    Returns:
    The configuration of the offline store. It includes the following configurations:
    
    Amazon S3 location of the offline store.
    
    Configuration of the Glue data catalog.
    
    Table format of the offline store.
    
    Option to disable the automatic creation of a Glue table for the offline store.
    
    Encryption configuration.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
  - featureGroupStatus
```
public final FeatureGroupStatus featureGroupStatus()
```
    The status of the feature group.
    
    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:
    
    The status of the feature group.
    
    See Also:
    
    FeatureGroupStatus
  - featureGroupStatusAsString
```
public final String featureGroupStatusAsString()
```
    The status of the feature group.
    
    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:
    
    The status of the feature group.
    
    See Also:
    
    FeatureGroupStatus
  - offlineStoreStatus
```
public final OfflineStoreStatus offlineStoreStatus()
```
    The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
    
    Returns:
    
    The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
  - lastUpdateStatus
```
public final LastUpdateStatus lastUpdateStatus()
```
    A value indicating whether the update made to the feature group was successful.
    
    Returns:
    
    A value indicating whether the update made to the feature group was successful.
  - failureReason
```
public final String failureReason()
```
    The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:
    - The FeatureGroup could not be created in the OfflineStore.
    - The FeatureGroup could not be deleted from the OfflineStore.
    Returns:
    The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:
    
    The FeatureGroup could not be created in the OfflineStore.
    
    The FeatureGroup could not be deleted from the OfflineStore.
  - description
```
public final String description()
```
    A free form description of the feature group.
    
    Returns:
    
    A free form description of the feature group.
  - nextToken
```
public final String nextToken()
```
    A token to resume pagination of the list of Features (FeatureDefinitions).
    
    Returns:
    
    A token to resume pagination of the list of Features (FeatureDefinitions).
  - onlineStoreTotalSizeBytes
```
public final Long onlineStoreTotalSizeBytes()
```
    The size of the OnlineStore in bytes.
    
    Returns:
    
    The size of the OnlineStore in bytes.
  - toBuilder
```
public DescribeFeatureGroupResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeFeatureGroupResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeFeatureGroupResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeFeatureGroupResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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

lastModifiedTime

onlineStoreConfig

offlineStoreConfig

roleArn

featureGroupStatus

featureGroupStatusAsString

offlineStoreStatus

lastUpdateStatus

failureReason

description

nextToken

onlineStoreTotalSizeBytes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields