Class JourneyLimits
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic JourneyLimits.Builder
builder()
final Integer
dailyCap()
The maximum number of messages that the journey can send to a single participant during a 24-hour period.final Integer
The maximum number of times that a participant can enter the journey.final String
Minimum time that must pass before an endpoint can re-enter a given journey.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 Integer
The maximum number of messages that the journey can send each second.static Class
<? extends JourneyLimits.Builder> final JourneyTimeframeCap
The number of messages that an endpoint can receive during the specified timeframe.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.final Integer
totalCap()
The maximum number of messages a journey can sent to a single endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
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<JourneyLimits.Builder,
JourneyLimits> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-