InAppMessageCampaign (AWS Java SDK for Amazon Pinpoint 1.12.474 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InAppMessageCampaign
extends Object
implements Serializable, Cloneable, StructuredPojo

Targeted in-app message campaign.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InAppMessageCampaign()

Constructors
Constructor and Description
`InAppMessageCampaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InAppMessageCampaign`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCampaignId()` Campaign id of the corresponding campaign.
`Integer`	`getDailyCap()` Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
`InAppMessage`	`getInAppMessage()` In-app message content with all fields required for rendering an in-app message.
`Integer`	`getPriority()` Priority of the in-app message.
`InAppCampaignSchedule`	`getSchedule()` Schedule of the campaign.
`Integer`	`getSessionCap()` Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
`Integer`	`getTotalCap()` Total cap which controls the number of times an in-app message can be shown to the endpoint.
`String`	`getTreatmentId()` Treatment id of the campaign.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCampaignId(String campaignId)` Campaign id of the corresponding campaign.
`void`	`setDailyCap(Integer dailyCap)` Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
`void`	`setInAppMessage(InAppMessage inAppMessage)` In-app message content with all fields required for rendering an in-app message.
`void`	`setPriority(Integer priority)` Priority of the in-app message.
`void`	`setSchedule(InAppCampaignSchedule schedule)` Schedule of the campaign.
`void`	`setSessionCap(Integer sessionCap)` Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
`void`	`setTotalCap(Integer totalCap)` Total cap which controls the number of times an in-app message can be shown to the endpoint.
`void`	`setTreatmentId(String treatmentId)` Treatment id of the campaign.
`String`	`toString()` Returns a string representation of this object.
`InAppMessageCampaign`	`withCampaignId(String campaignId)` Campaign id of the corresponding campaign.
`InAppMessageCampaign`	`withDailyCap(Integer dailyCap)` Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
`InAppMessageCampaign`	`withInAppMessage(InAppMessage inAppMessage)` In-app message content with all fields required for rendering an in-app message.
`InAppMessageCampaign`	`withPriority(Integer priority)` Priority of the in-app message.
`InAppMessageCampaign`	`withSchedule(InAppCampaignSchedule schedule)` Schedule of the campaign.
`InAppMessageCampaign`	`withSessionCap(Integer sessionCap)` Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
`InAppMessageCampaign`	`withTotalCap(Integer totalCap)` Total cap which controls the number of times an in-app message can be shown to the endpoint.
`InAppMessageCampaign`	`withTreatmentId(String treatmentId)` Treatment id of the campaign.

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

- Constructor Detail
  - InAppMessageCampaign
```
public InAppMessageCampaign()
```
- Method Detail
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    Campaign id of the corresponding campaign.
    
    Parameters:
    
    campaignId - Campaign id of the corresponding campaign.
  - getCampaignId
```
public String getCampaignId()
```
    Campaign id of the corresponding campaign.
    
    Returns:
    
    Campaign id of the corresponding campaign.
  - withCampaignId
```
public InAppMessageCampaign withCampaignId(String campaignId)
```
    Campaign id of the corresponding campaign.
    
    Parameters:
    
    campaignId - Campaign id of the corresponding campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDailyCap
```
public void setDailyCap(Integer dailyCap)
```
    Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
    
    Parameters:
    
    dailyCap - Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
  - getDailyCap
```
public Integer getDailyCap()
```
    Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
    
    Returns:
    
    Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
  - withDailyCap
```
public InAppMessageCampaign withDailyCap(Integer dailyCap)
```
    Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
    
    Parameters:
    
    dailyCap - Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInAppMessage
```
public void setInAppMessage(InAppMessage inAppMessage)
```
    In-app message content with all fields required for rendering an in-app message.
    
    Parameters:
    
    inAppMessage - In-app message content with all fields required for rendering an in-app message.
  - getInAppMessage
```
public InAppMessage getInAppMessage()
```
    In-app message content with all fields required for rendering an in-app message.
    
    Returns:
    
    In-app message content with all fields required for rendering an in-app message.
  - withInAppMessage
```
public InAppMessageCampaign withInAppMessage(InAppMessage inAppMessage)
```
    In-app message content with all fields required for rendering an in-app message.
    
    Parameters:
    
    inAppMessage - In-app message content with all fields required for rendering an in-app message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    Priority of the in-app message.
    
    Parameters:
    
    priority - Priority of the in-app message.
  - getPriority
```
public Integer getPriority()
```
    Priority of the in-app message.
    
    Returns:
    
    Priority of the in-app message.
  - withPriority
```
public InAppMessageCampaign withPriority(Integer priority)
```
    Priority of the in-app message.
    
    Parameters:
    
    priority - Priority of the in-app message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedule
```
public void setSchedule(InAppCampaignSchedule schedule)
```
    Schedule of the campaign.
    
    Parameters:
    
    schedule - Schedule of the campaign.
  - getSchedule
```
public InAppCampaignSchedule getSchedule()
```
    Schedule of the campaign.
    
    Returns:
    
    Schedule of the campaign.
  - withSchedule
```
public InAppMessageCampaign withSchedule(InAppCampaignSchedule schedule)
```
    Schedule of the campaign.
    
    Parameters:
    
    schedule - Schedule of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionCap
```
public void setSessionCap(Integer sessionCap)
```
    Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
    
    Parameters:
    
    sessionCap - Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
  - getSessionCap
```
public Integer getSessionCap()
```
    Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
    
    Returns:
    
    Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
  - withSessionCap
```
public InAppMessageCampaign withSessionCap(Integer sessionCap)
```
    Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
    
    Parameters:
    
    sessionCap - Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalCap
```
public void setTotalCap(Integer totalCap)
```
    Total cap which controls the number of times an in-app message can be shown to the endpoint.
    
    Parameters:
    
    totalCap - Total cap which controls the number of times an in-app message can be shown to the endpoint.
  - getTotalCap
```
public Integer getTotalCap()
```
    Total cap which controls the number of times an in-app message can be shown to the endpoint.
    
    Returns:
    
    Total cap which controls the number of times an in-app message can be shown to the endpoint.
  - withTotalCap
```
public InAppMessageCampaign withTotalCap(Integer totalCap)
```
    Total cap which controls the number of times an in-app message can be shown to the endpoint.
    
    Parameters:
    
    totalCap - Total cap which controls the number of times an in-app message can be shown to the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentId
```
public void setTreatmentId(String treatmentId)
```
    Treatment id of the campaign.
    
    Parameters:
    
    treatmentId - Treatment id of the campaign.
  - getTreatmentId
```
public String getTreatmentId()
```
    Treatment id of the campaign.
    
    Returns:
    
    Treatment id of the campaign.
  - withTreatmentId
```
public InAppMessageCampaign withTreatmentId(String treatmentId)
```
    Treatment id of the campaign.
    
    Parameters:
    
    treatmentId - Treatment id of the campaign.
    
    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 InAppMessageCampaign clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class InAppMessageCampaign

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InAppMessageCampaign

Method Detail

setCampaignId

getCampaignId

withCampaignId

setDailyCap

getDailyCap

withDailyCap

setInAppMessage

getInAppMessage

withInAppMessage

setPriority

getPriority

withPriority

setSchedule

getSchedule

withSchedule

setSessionCap

getSessionCap

withSessionCap

setTotalCap

getTotalCap

withTotalCap

setTreatmentId

getTreatmentId

withTreatmentId

toString

equals

hashCode

clone

marshall