Package software.amazon.awssdk.services.pinpoint.model

Class CampaignLimits

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.CampaignLimits

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CampaignLimits.Builder,CampaignLimits>

@Generated("software.amazon.awssdk:codegen")
public final class CampaignLimits
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignLimits.Builder,CampaignLimits>

For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CampaignLimits.Builder

Method Summary

Modifier and Type	Method	Description
static CampaignLimits.Builder	builder()
Integer	daily()	The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumDuration()	The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
Integer	messagesPerSecond()	The maximum number of messages that a campaign can send each second.
List<SdkField<?>>	sdkFields()
static Class<? extends CampaignLimits.Builder>	serializableBuilderClass()
Integer	session()	The maximum total number of messages that the campaign can send per user session.
CampaignLimits.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	total()	The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

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

daily

public final Integer daily()

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

Returns:

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

maximumDuration

public final Integer maximumDuration()

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

Returns:

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

messagesPerSecond

public final Integer messagesPerSecond()

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

Returns:

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

total

public final Integer total()

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

Returns:

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

session

public final Integer session()

The maximum total number of messages that the campaign can send per user session.

Returns:

The maximum total number of messages that the campaign can send per user session.

toBuilder

public CampaignLimits.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignLimits.Builder,CampaignLimits>

builder

public static CampaignLimits.Builder builder()

serializableBuilderClass

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