Class JourneyLimits

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.JourneyLimits
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JourneyLimits.Builder,JourneyLimits>
@Generated("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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<JourneyLimits.Builder,JourneyLimits>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.