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

Class ThroughputConfig

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<ThroughputConfig.Builder,​ThroughputConfig>
    @Generated("software.amazon.awssdk:codegen")
public final class ThroughputConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ThroughputConfig.Builder,​ThroughputConfig>

    Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

    Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

    See Also:
    Serialized Form

    • Method Detail

      • throughputMode

        public final ThroughputMode throughputMode()

        The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

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

        Returns:
        The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
        See Also:
        ThroughputMode

      • throughputModeAsString

        public final String throughputModeAsString()

        The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

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

        Returns:
        The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
        See Also:
        ThroughputMode

      • provisionedReadCapacityUnits

        public final Integer provisionedReadCapacityUnits()

        For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

        This field is not applicable for on-demand feature groups.

        Returns:
        For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

        This field is not applicable for on-demand feature groups.

      • provisionedWriteCapacityUnits

        public final Integer provisionedWriteCapacityUnits()

        For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

        This field is not applicable for on-demand feature groups.

        Returns:
        For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

        This field is not applicable for on-demand feature groups.

      • hashCode

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

      • equals

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

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