JourneyLimits (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.JourneyLimits

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JourneyLimits
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JourneyLimits()

Constructors
Constructor and Description
`JourneyLimits()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JourneyLimits`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getDailyCap()` The maximum number of messages that the journey can send to a single participant during a 24-hour period.
`Integer`	`getEndpointReentryCap()` The maximum number of times that a participant can enter the journey.
`String`	`getEndpointReentryInterval()` Minimum time that must pass before an endpoint can re-enter a given journey.
`Integer`	`getMessagesPerSecond()` The maximum number of messages that the journey can send each second.
`JourneyTimeframeCap`	`getTimeframeCap()` The number of messages that an endpoint can receive during the specified timeframe.
`Integer`	`getTotalCap()` The maximum number of messages a journey can sent to a single endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDailyCap(Integer dailyCap)` The maximum number of messages that the journey can send to a single participant during a 24-hour period.
`void`	`setEndpointReentryCap(Integer endpointReentryCap)` The maximum number of times that a participant can enter the journey.
`void`	`setEndpointReentryInterval(String endpointReentryInterval)` Minimum time that must pass before an endpoint can re-enter a given journey.
`void`	`setMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages that the journey can send each second.
`void`	`setTimeframeCap(JourneyTimeframeCap timeframeCap)` The number of messages that an endpoint can receive during the specified timeframe.
`void`	`setTotalCap(Integer totalCap)` The maximum number of messages a journey can sent to a single endpoint.
`String`	`toString()` Returns a string representation of this object.
`JourneyLimits`	`withDailyCap(Integer dailyCap)` The maximum number of messages that the journey can send to a single participant during a 24-hour period.
`JourneyLimits`	`withEndpointReentryCap(Integer endpointReentryCap)` The maximum number of times that a participant can enter the journey.
`JourneyLimits`	`withEndpointReentryInterval(String endpointReentryInterval)` Minimum time that must pass before an endpoint can re-enter a given journey.
`JourneyLimits`	`withMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages that the journey can send each second.
`JourneyLimits`	`withTimeframeCap(JourneyTimeframeCap timeframeCap)` The number of messages that an endpoint can receive during the specified timeframe.
`JourneyLimits`	`withTotalCap(Integer totalCap)` The maximum number of messages a journey can sent to a single endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JourneyLimits
```
public JourneyLimits()
```
- Method Detail
  - setDailyCap
```
public void setDailyCap(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.
  - getDailyCap
```
public Integer getDailyCap()
```
    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.
  - withDailyCap
```
public JourneyLimits withDailyCap(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.
  - setEndpointReentryCap
```
public void setEndpointReentryCap(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.
  - getEndpointReentryCap
```
public Integer getEndpointReentryCap()
```
    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.
  - withEndpointReentryCap
```
public JourneyLimits withEndpointReentryCap(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.
  - setMessagesPerSecond
```
public void setMessagesPerSecond(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.
  - getMessagesPerSecond
```
public Integer getMessagesPerSecond()
```
    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.
  - withMessagesPerSecond
```
public JourneyLimits withMessagesPerSecond(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.
  - setEndpointReentryInterval
```
public void setEndpointReentryInterval(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.
  - getEndpointReentryInterval
```
public String getEndpointReentryInterval()
```
    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.
  - withEndpointReentryInterval
```
public JourneyLimits withEndpointReentryInterval(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.
  - setTimeframeCap
```
public void setTimeframeCap(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.
  - getTimeframeCap
```
public JourneyTimeframeCap getTimeframeCap()
```
    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.
  - withTimeframeCap
```
public JourneyLimits withTimeframeCap(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.
  - setTotalCap
```
public void setTotalCap(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.
  - getTotalCap
```
public Integer getTotalCap()
```
    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.
  - withTotalCap
```
public JourneyLimits withTotalCap(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JourneyLimits clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.597

Class JourneyLimits

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JourneyLimits

Method Detail

setDailyCap

getDailyCap

withDailyCap

setEndpointReentryCap

getEndpointReentryCap

withEndpointReentryCap

setMessagesPerSecond

getMessagesPerSecond

withMessagesPerSecond

setEndpointReentryInterval

getEndpointReentryInterval

withEndpointReentryInterval

setTimeframeCap

getTimeframeCap

withTimeframeCap

setTotalCap

getTotalCap

withTotalCap

toString

equals

hashCode

clone

marshall