Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpendLimit.Builder

Method Summary

Modifier and Type	Method	Description
static SpendLimit.Builder	builder()
Long	enforcedLimit()	The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	maxLimit()	The maximum amount of money that you are able to spend to send messages each month, in US dollars.
SpendLimitName	name()	The name for the SpendLimit.
String	nameAsString()	The name for the SpendLimit.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends SpendLimit.Builder>	serializableBuilderClass()
SpendLimit.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SpendLimitName

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:

SpendLimitName

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

Specified by:

toBuilder in interface ToCopyableBuilder<SpendLimit.Builder,SpendLimit>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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