Class OfflineStoreConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.OfflineStoreConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OfflineStoreConfig.Builder,OfflineStoreConfig>
@Generated("software.amazon.awssdk:codegen") public final class OfflineStoreConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OfflineStoreConfig.Builder,OfflineStoreConfig>

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

See Also:

  • Method Details

    • s3StorageConfig

      public final S3StorageConfig s3StorageConfig()

      The Amazon Simple Storage (Amazon S3) location of OfflineStore.

      Returns:
      The Amazon Simple Storage (Amazon S3) location of OfflineStore.

    • disableGlueTableCreation

      public final Boolean disableGlueTableCreation()

      Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated with the feature group. The Iceberg table format is only supported when this is set to False.

      If set to False and DataCatalogConfig is provided, Feature Store creates the table using the specified names. If set to False without DataCatalogConfig, Feature Store auto-generates the table name following Athena's naming recommendations. This applies to both Glue and Apache Iceberg table formats.

      The default value is False.

      Returns:
      Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated with the feature group. The Iceberg table format is only supported when this is set to False.

      If set to False and DataCatalogConfig is provided, Feature Store creates the table using the specified names. If set to False without DataCatalogConfig, Feature Store auto-generates the table name following Athena's naming recommendations. This applies to both Glue and Apache Iceberg table formats.

      The default value is False.

    • dataCatalogConfig

      public final DataCatalogConfig dataCatalogConfig()

      The meta data of the Glue table for the OfflineStore. If not provided, Feature Store auto-generates the table name, database, and catalog when the OfflineStore is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.

      Returns:
      The meta data of the Glue table for the OfflineStore. If not provided, Feature Store auto-generates the table name, database, and catalog when the OfflineStore is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.

    • tableFormat

      public final TableFormat tableFormat()

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

      If the service returns an enum value that is not available in the current SDK version, tableFormat will return TableFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tableFormatAsString().

      Returns:
      Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
      See Also:

    • tableFormatAsString

      public final String tableFormatAsString()

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

      If the service returns an enum value that is not available in the current SDK version, tableFormat will return TableFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tableFormatAsString().

      Returns:
      Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
      See Also:

    • toBuilder

      public OfflineStoreConfig.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<OfflineStoreConfig.Builder,OfflineStoreConfig>
      Returns:
      a builder for type T

    • builder

      public static OfflineStoreConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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