CampaignLimits (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignLimits
extends Object
implements Serializable, Cloneable, StructuredPojo
```
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignLimits()

Constructors
Constructor and Description
`CampaignLimits()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignLimits`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getDaily()` The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
`Integer`	`getMaximumDuration()` The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
`Integer`	`getMessagesPerSecond()` The maximum number of messages that a campaign can send each second.
`Integer`	`getSession()` The maximum total number of messages that the campaign can send per user session.
`Integer`	`getTotal()` The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDaily(Integer daily)` The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
`void`	`setMaximumDuration(Integer maximumDuration)` The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
`void`	`setMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages that a campaign can send each second.
`void`	`setSession(Integer session)` The maximum total number of messages that the campaign can send per user session.
`void`	`setTotal(Integer total)` The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.
`String`	`toString()` Returns a string representation of this object.
`CampaignLimits`	`withDaily(Integer daily)` The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
`CampaignLimits`	`withMaximumDuration(Integer maximumDuration)` The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
`CampaignLimits`	`withMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages that a campaign can send each second.
`CampaignLimits`	`withSession(Integer session)` The maximum total number of messages that the campaign can send per user session.
`CampaignLimits`	`withTotal(Integer total)` The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

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

- Constructor Detail
  - CampaignLimits
```
public CampaignLimits()
```
- Method Detail
  - setDaily
```
public void setDaily(Integer daily)
```
    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
    
    Parameters:
    
    daily - The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
  - getDaily
```
public Integer getDaily()
```
    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
    
    Returns:
    
    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
  - withDaily
```
public CampaignLimits withDaily(Integer daily)
```
    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
    
    Parameters:
    
    daily - The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint 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.
  - setMaximumDuration
```
public void setMaximumDuration(Integer maximumDuration)
```
    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
    
    Parameters:
    
    maximumDuration - The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
  - getMaximumDuration
```
public Integer getMaximumDuration()
```
    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
    
    Returns:
    
    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
  - withMaximumDuration
```
public CampaignLimits withMaximumDuration(Integer maximumDuration)
```
    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
    
    Parameters:
    
    maximumDuration - The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
    
    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 a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
    
    Parameters:
    
    messagesPerSecond - The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
  - getMessagesPerSecond
```
public Integer getMessagesPerSecond()
```
    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
    
    Returns:
    
    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
  - withMessagesPerSecond
```
public CampaignLimits withMessagesPerSecond(Integer messagesPerSecond)
```
    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
    
    Parameters:
    
    messagesPerSecond - The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotal
```
public void setTotal(Integer total)
```
    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
    
    Parameters:
    
    total - The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
  - getTotal
```
public Integer getTotal()
```
    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
    
    Returns:
    
    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
  - withTotal
```
public CampaignLimits withTotal(Integer total)
```
    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
    
    Parameters:
    
    total - The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSession
```
public void setSession(Integer session)
```
    The maximum total number of messages that the campaign can send per user session.
    
    Parameters:
    
    session - The maximum total number of messages that the campaign can send per user session.
  - getSession
```
public Integer getSession()
```
    The maximum total number of messages that the campaign can send per user session.
    
    Returns:
    
    The maximum total number of messages that the campaign can send per user session.
  - withSession
```
public CampaignLimits withSession(Integer session)
```
    The maximum total number of messages that the campaign can send per user session.
    
    Parameters:
    
    session - The maximum total number of messages that the campaign can send per user session.
    
    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 CampaignLimits 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.779

Class CampaignLimits

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignLimits

Method Detail

setDaily

getDaily

withDaily

setMaximumDuration

getMaximumDuration

withMaximumDuration

setMessagesPerSecond

getMessagesPerSecond

withMessagesPerSecond

setTotal

getTotal

withTotal

setSession

getSession

withSession

toString

equals

hashCode

clone

marshall