Class SpendLimit
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SpendLimit.Builder,
SpendLimit>
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SpendLimit.Builder
builder()
final Long
The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Long
maxLimit()
The maximum amount of money that you are able to spend to send messages each month, in US dollars.final SpendLimitName
name()
The name for the SpendLimit.final String
The name for the SpendLimit.final Boolean
When set toTrue
, the value that has been specified in theEnforcedLimit
is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.static Class
<? extends SpendLimit.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name for the SpendLimit.
If the service returns an enum value that is not available in the current SDK version,
name
will returnSpendLimitName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name for the SpendLimit.
- See Also:
-
nameAsString
The name for the SpendLimit.
If the service returns an enum value that is not available in the current SDK version,
name
will returnSpendLimitName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name for the SpendLimit.
- See Also:
-
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
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
When set to
True
, the value that has been specified in theEnforcedLimit
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 theEnforcedLimit
is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
-
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 interfaceToCopyableBuilder<SpendLimit.Builder,
SpendLimit> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-