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
```
Campaign Limits are used to limit the number of messages that can be sent to a user.

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 the campaign can send daily.
`Integer`	`getMaximumDuration()` The maximum duration of a campaign from the scheduled start.
`Integer`	`getMessagesPerSecond()` The maximum number of messages per second that the campaign will send.
`Integer`	`getTotal()` The maximum total number of messages that the campaign can send.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDaily(Integer daily)` The maximum number of messages that the campaign can send daily.
`void`	`setMaximumDuration(Integer maximumDuration)` The maximum duration of a campaign from the scheduled start.
`void`	`setMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages per second that the campaign will send.
`void`	`setTotal(Integer total)` The maximum total number of messages that the campaign can send.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CampaignLimits`	`withDaily(Integer daily)` The maximum number of messages that the campaign can send daily.
`CampaignLimits`	`withMaximumDuration(Integer maximumDuration)` The maximum duration of a campaign from the scheduled start.
`CampaignLimits`	`withMessagesPerSecond(Integer messagesPerSecond)` The maximum number of messages per second that the campaign will send.
`CampaignLimits`	`withTotal(Integer total)` The maximum total number of messages that the campaign can send.

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 the campaign can send daily.
    
    Parameters:
    
    daily - The maximum number of messages that the campaign can send daily.
  - getDaily
```
public Integer getDaily()
```
    The maximum number of messages that the campaign can send daily.
    
    Returns:
    
    The maximum number of messages that the campaign can send daily.
  - withDaily
```
public CampaignLimits withDaily(Integer daily)
```
    The maximum number of messages that the campaign can send daily.
    
    Parameters:
    
    daily - The maximum number of messages that the campaign can send daily.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumDuration
```
public void setMaximumDuration(Integer maximumDuration)
```
    The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.
    
    Parameters:
    
    maximumDuration - The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.
  - getMaximumDuration
```
public Integer getMaximumDuration()
```
    The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.
    
    Returns:
    
    The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.
  - withMaximumDuration
```
public CampaignLimits withMaximumDuration(Integer maximumDuration)
```
    The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.
    
    Parameters:
    
    maximumDuration - The maximum duration of a campaign from the scheduled start. Must be a minimum of 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 per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
    
    Parameters:
    
    messagesPerSecond - The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
  - getMessagesPerSecond
```
public Integer getMessagesPerSecond()
```
    The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
    
    Returns:
    
    The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
  - withMessagesPerSecond
```
public CampaignLimits withMessagesPerSecond(Integer messagesPerSecond)
```
    The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
    
    Parameters:
    
    messagesPerSecond - The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotal
```
public void setTotal(Integer total)
```
    The maximum total number of messages that the campaign can send.
    
    Parameters:
    
    total - The maximum total number of messages that the campaign can send.
  - getTotal
```
public Integer getTotal()
```
    The maximum total number of messages that the campaign can send.
    
    Returns:
    
    The maximum total number of messages that the campaign can send.
  - withTotal
```
public CampaignLimits withTotal(Integer total)
```
    The maximum total number of messages that the campaign can send.
    
    Parameters:
    
    total - The maximum total number of messages that the campaign can send.
    
    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; useful for testing and debugging.
    
    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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall