Package software.amazon.awssdk.services.sagemaker.model

Interface DescribeFeatureGroupResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeFeatureGroupResponse
public static interface DescribeFeatureGroupResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeFeatureGroupResponse.Builder,DescribeFeatureGroupResponse>

  • Method Details

    • featureGroupArn

      DescribeFeatureGroupResponse.Builder featureGroupArn(String featureGroupArn)

      The Amazon Resource Name (ARN) of the FeatureGroup.

      Parameters:
      featureGroupArn - The Amazon Resource Name (ARN) of the FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureGroupName

      DescribeFeatureGroupResponse.Builder featureGroupName(String featureGroupName)

      he name of the FeatureGroup.

      Parameters:
      featureGroupName - he name of the FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordIdentifierFeatureName

      DescribeFeatureGroupResponse.Builder recordIdentifierFeatureName(String recordIdentifierFeatureName)

      The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

      Parameters:
      recordIdentifierFeatureName - The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTimeFeatureName

      DescribeFeatureGroupResponse.Builder eventTimeFeatureName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      DescribeFeatureGroupResponse.Builder featureDefinitions(Collection<FeatureDefinition> featureDefinitions)

      A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

      Parameters:
      featureDefinitions - A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      DescribeFeatureGroupResponse.Builder featureDefinitions(FeatureDefinition... featureDefinitions)

      A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

      Parameters:
      featureDefinitions - A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureDefinitions

      DescribeFeatureGroupResponse.Builder featureDefinitions(Consumer<FeatureDefinition.Builder>... featureDefinitions)

      A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

      This is a convenience method that creates an instance of the FeatureDefinition.Builder avoiding the need to create one manually via FeatureDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to featureDefinitions(List<FeatureDefinition>).

      Parameters:
      featureDefinitions - a consumer that will call methods on FeatureDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationTime

      DescribeFeatureGroupResponse.Builder creationTime(Instant creationTime)

      A timestamp indicating when SageMaker created the FeatureGroup.

      Parameters:
      creationTime - A timestamp indicating when SageMaker created the FeatureGroup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      DescribeFeatureGroupResponse.Builder lastModifiedTime(Instant lastModifiedTime)

      A timestamp indicating when the feature group was last updated.

      Parameters:
      lastModifiedTime - A timestamp indicating when the feature group was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlineStoreConfig

      DescribeFeatureGroupResponse.Builder onlineStoreConfig(OnlineStoreConfig onlineStoreConfig)

      The configuration for the OnlineStore.

      Parameters:
      onlineStoreConfig - The configuration for the OnlineStore.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlineStoreConfig

      default DescribeFeatureGroupResponse.Builder onlineStoreConfig(Consumer<OnlineStoreConfig.Builder> onlineStoreConfig)

      The configuration for the OnlineStore.

      This is a convenience method that creates an instance of the OnlineStoreConfig.Builder avoiding the need to create one manually via OnlineStoreConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onlineStoreConfig(OnlineStoreConfig).

      Parameters:
      onlineStoreConfig - a consumer that will call methods on OnlineStoreConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offlineStoreConfig

      DescribeFeatureGroupResponse.Builder offlineStoreConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • offlineStoreConfig

      default DescribeFeatureGroupResponse.Builder offlineStoreConfig(Consumer<OfflineStoreConfig.Builder> 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.

      This is a convenience method that creates an instance of the OfflineStoreConfig.Builder avoiding the need to create one manually via OfflineStoreConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offlineStoreConfig(OfflineStoreConfig).

      Parameters:
      offlineStoreConfig - a consumer that will call methods on OfflineStoreConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • throughputConfig

      DescribeFeatureGroupResponse.Builder throughputConfig(ThroughputConfigDescription throughputConfig)
      Sets the value of the ThroughputConfig property for this object.
      Parameters:
      throughputConfig - The new value for the ThroughputConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throughputConfig

      default DescribeFeatureGroupResponse.Builder throughputConfig(Consumer<ThroughputConfigDescription.Builder> throughputConfig)
      Sets the value of the ThroughputConfig property for this object. This is a convenience method that creates an instance of the ThroughputConfigDescription.Builder avoiding the need to create one manually via ThroughputConfigDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to throughputConfig(ThroughputConfigDescription).

      Parameters:
      throughputConfig - a consumer that will call methods on ThroughputConfigDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      DescribeFeatureGroupResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureGroupStatus

      DescribeFeatureGroupResponse.Builder featureGroupStatus(String featureGroupStatus)

      The status of the feature group.

      Parameters:
      featureGroupStatus - The status of the feature group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • featureGroupStatus

      DescribeFeatureGroupResponse.Builder featureGroupStatus(FeatureGroupStatus featureGroupStatus)

      The status of the feature group.

      Parameters:
      featureGroupStatus - The status of the feature group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offlineStoreStatus

      DescribeFeatureGroupResponse.Builder offlineStoreStatus(OfflineStoreStatus offlineStoreStatus)

      The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

      Parameters:
      offlineStoreStatus - The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • offlineStoreStatus

      default DescribeFeatureGroupResponse.Builder offlineStoreStatus(Consumer<OfflineStoreStatus.Builder> offlineStoreStatus)

      The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

      This is a convenience method that creates an instance of the OfflineStoreStatus.Builder avoiding the need to create one manually via OfflineStoreStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offlineStoreStatus(OfflineStoreStatus).

      Parameters:
      offlineStoreStatus - a consumer that will call methods on OfflineStoreStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastUpdateStatus

      DescribeFeatureGroupResponse.Builder lastUpdateStatus(LastUpdateStatus lastUpdateStatus)

      A value indicating whether the update made to the feature group was successful.

      Parameters:
      lastUpdateStatus - A value indicating whether the update made to the feature group was successful.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateStatus

      default DescribeFeatureGroupResponse.Builder lastUpdateStatus(Consumer<LastUpdateStatus.Builder> lastUpdateStatus)

      A value indicating whether the update made to the feature group was successful.

      This is a convenience method that creates an instance of the LastUpdateStatus.Builder avoiding the need to create one manually via LastUpdateStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastUpdateStatus(LastUpdateStatus).

      Parameters:
      lastUpdateStatus - a consumer that will call methods on LastUpdateStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      DescribeFeatureGroupResponse.Builder failureReason(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribeFeatureGroupResponse.Builder description(String description)

      A free form description of the feature group.

      Parameters:
      description - A free form description of the feature group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeFeatureGroupResponse.Builder nextToken(String nextToken)

      A token to resume pagination of the list of Features (FeatureDefinitions).

      Parameters:
      nextToken - A token to resume pagination of the list of Features (FeatureDefinitions).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlineStoreTotalSizeBytes

      DescribeFeatureGroupResponse.Builder onlineStoreTotalSizeBytes(Long onlineStoreTotalSizeBytes)

      The size of the OnlineStore in bytes.

      Parameters:
      onlineStoreTotalSizeBytes - The size of the OnlineStore in bytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.