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

Interface JourneyLimits.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JourneyLimits.Builder,JourneyLimits>, SdkBuilder<JourneyLimits.Builder,JourneyLimits>, SdkPojo
Enclosing class:
JourneyLimits
public static interface JourneyLimits.Builder extends SdkPojo, CopyableBuilder<JourneyLimits.Builder,JourneyLimits>

  • Method Details

    • dailyCap

      JourneyLimits.Builder dailyCap(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endpointReentryCap

      JourneyLimits.Builder endpointReentryCap(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • messagesPerSecond

      JourneyLimits.Builder messagesPerSecond(Integer messagesPerSecond)

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

      Parameters:
      messagesPerSecond - The maximum number of messages that the journey can send each second.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointReentryInterval

      JourneyLimits.Builder endpointReentryInterval(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timeframeCap

      JourneyLimits.Builder timeframeCap(JourneyTimeframeCap timeframeCap)

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

      Parameters:
      timeframeCap - The number of messages that an endpoint can receive during the specified timeframe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeframeCap

      default JourneyLimits.Builder timeframeCap(Consumer<JourneyTimeframeCap.Builder> timeframeCap)

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

      This is a convenience method that creates an instance of the JourneyTimeframeCap.Builder avoiding the need to create one manually via JourneyTimeframeCap.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeframeCap(JourneyTimeframeCap).

      Parameters:
      timeframeCap - a consumer that will call methods on JourneyTimeframeCap.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalCap

      JourneyLimits.Builder totalCap(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.