Class DescribeFeatureGroupResponse

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("software.amazon.awssdk:codegen") public final class DescribeFeatureGroupResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>

  • Method Details

    • 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.

    • throughputConfig

      public final ThroughputConfigDescription throughputConfig()
      Returns the value of the ThroughputConfig property for this object.
      Returns:
      The value of the ThroughputConfig property for this object.

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.