Class SpendLimit

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

Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide.

See Also:

  • Method Details

    • name

      public final SpendLimitName name()

      The name for the SpendLimit.

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

      Returns:
      The name for the SpendLimit.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name for the SpendLimit.

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

      Returns:
      The name for the SpendLimit.
      See Also:

    • enforcedLimit

      public final Long enforcedLimit()

      The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

      Returns:
      The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

    • maxLimit

      public final Long maxLimit()

      The maximum amount of money that you are able to spend to send messages each month, in US dollars.

      Returns:
      The maximum amount of money that you are able to spend to send messages each month, in US dollars.

    • overridden

      public final Boolean overridden()

      When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

      Returns:
      When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

    • toBuilder

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

    • builder

      public static SpendLimit.Builder builder()

    • serializableBuilderClass

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