software.amazon.awssdk.services.pinpoint.model

Class JourneyLimits

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.JourneyLimits

All Implemented Interfaces:

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

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

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JourneyLimits.Builder

Method Summary

Modifier and Type	Method and Description
static JourneyLimits.Builder	builder()
Integer	dailyCap() The maximum number of messages that the journey can send to a single participant during a 24-hour period.
Integer	endpointReentryCap() The maximum number of times that a participant can enter the journey.
String	endpointReentryInterval() Minimum time that must pass before an endpoint can re-enter a given journey.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	messagesPerSecond() The maximum number of messages that the journey can send each second.
List<SdkField<?>>	sdkFields()
static Class<? extends JourneyLimits.Builder>	serializableBuilderClass()
JourneyTimeframeCap	timeframeCap() The number of messages that an endpoint can receive during the specified timeframe.
JourneyLimits.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalCap() The maximum number of messages a journey can sent to a single endpoint.

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

dailyCap

public final Integer dailyCap()

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

Returns:

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

endpointReentryCap

public final Integer endpointReentryCap()

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

Returns:

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

messagesPerSecond

public final Integer messagesPerSecond()

The maximum number of messages that the journey can send each second.

Returns:

The maximum number of messages that the journey can send each second.

endpointReentryInterval

public final String endpointReentryInterval()

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

Returns:

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

timeframeCap

public final JourneyTimeframeCap timeframeCap()

The number of messages that an endpoint can receive during the specified timeframe.

Returns:

The number of messages that an endpoint can receive during the specified timeframe.

totalCap

public final Integer totalCap()

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

Returns:

The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

toBuilder

public JourneyLimits.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JourneyLimits.Builder,JourneyLimits>

builder

public static JourneyLimits.Builder builder()

serializableBuilderClass

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