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

Class CreateFeatureGroupRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.CreateFeatureGroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFeatureGroupRequest extends SageMakerRequest implements ToCopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>

  • Method Details

    • featureGroupName

      public final String featureGroupName()

      The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

      • Must start and end with an alphanumeric character.

      • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

      Returns:
      The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

      • Must start and end with an alphanumeric character.

      • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

    • recordIdentifierFeatureName

      public final String recordIdentifierFeatureName()

      The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

      You use the RecordIdentifierFeatureName to access data in a FeatureStore.

      This name:

      • Must start and end with an alphanumeric character.

      • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

      Returns:
      The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

      You use the RecordIdentifierFeatureName to access data in a FeatureStore.

      This name:

      • Must start and end with an alphanumeric character.

      • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

    • 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 must have a corresponding EventTime.

      An EventTime can be a String or Fractional.

      • Fractional: EventTime feature values must be a Unix timestamp in seconds.

      • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

      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 must have a corresponding EventTime.

      An EventTime can be a String or Fractional.

      • Fractional: EventTime feature values must be a Unix timestamp in seconds.

      • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

    • 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 Feature names and types. Name and Type is compulsory per Feature.

      Valid feature 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.

      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 Feature names and types. Name and Type is compulsory per Feature.

      Valid feature 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.

    • onlineStoreConfig

      public final OnlineStoreConfig onlineStoreConfig()

      You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

      You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

      The default value is False.

      Returns:
      You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

      You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

      The default value is False.

    • offlineStoreConfig

      public final OfflineStoreConfig offlineStoreConfig()

      Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

      • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

      • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

      • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

      • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

      To learn more about this parameter, see OfflineStoreConfig.

      Returns:
      Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

      • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

      • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

      • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

      • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

      To learn more about this parameter, see OfflineStoreConfig.

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

    • description

      public final String description()

      A free-form description of a FeatureGroup.

      Returns:
      A free-form description of a FeatureGroup.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      Tags used to identify Features in each FeatureGroup.

      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 hasTags() method.

      Returns:
      Tags used to identify Features in each FeatureGroup.

    • toBuilder

      public CreateFeatureGroupRequest.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<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateFeatureGroupRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateFeatureGroupRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.