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

Class ThroughputConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.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:

  • Method Details

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

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

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

    • toBuilder

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

    • builder

      public static ThroughputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ThroughputConfig.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.