WriteApplicationSettingsRequest (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Specifies the default settings for an application.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WriteApplicationSettingsRequest()

Constructors
Constructor and Description
`WriteApplicationSettingsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteApplicationSettingsRequest`	`clone()`
`boolean`	`equals(Object obj)`
`CampaignHook`	`getCampaignHook()` The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
`Boolean`	`getCloudWatchMetricsEnabled()` Specifies whether to enable application-related alarms in Amazon CloudWatch.
`CampaignLimits`	`getLimits()` The default sending limits for campaigns in the application.
`QuietTime`	`getQuietTime()` The default quiet time for campaigns in the application.
`int`	`hashCode()`
`Boolean`	`isCloudWatchMetricsEnabled()` Specifies whether to enable application-related alarms in Amazon CloudWatch.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCampaignHook(CampaignHook campaignHook)` The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
`void`	`setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)` Specifies whether to enable application-related alarms in Amazon CloudWatch.
`void`	`setLimits(CampaignLimits limits)` The default sending limits for campaigns in the application.
`void`	`setQuietTime(QuietTime quietTime)` The default quiet time for campaigns in the application.
`String`	`toString()` Returns a string representation of this object.
`WriteApplicationSettingsRequest`	`withCampaignHook(CampaignHook campaignHook)` The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
`WriteApplicationSettingsRequest`	`withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)` Specifies whether to enable application-related alarms in Amazon CloudWatch.
`WriteApplicationSettingsRequest`	`withLimits(CampaignLimits limits)` The default sending limits for campaigns in the application.
`WriteApplicationSettingsRequest`	`withQuietTime(QuietTime quietTime)` The default quiet time for campaigns in the application.

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

- Constructor Detail
  - WriteApplicationSettingsRequest
```
public WriteApplicationSettingsRequest()
```
- Method Detail
  - setCampaignHook
```
public void setCampaignHook(CampaignHook campaignHook)
```
    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
    
    Parameters:
    
    campaignHook - The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
  - getCampaignHook
```
public CampaignHook getCampaignHook()
```
    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
    
    Returns:
    
    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
  - withCampaignHook
```
public WriteApplicationSettingsRequest withCampaignHook(CampaignHook campaignHook)
```
    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
    
    Parameters:
    
    campaignHook - The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchMetricsEnabled
```
public void setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
    
    Parameters:
    
    cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch.
  - getCloudWatchMetricsEnabled
```
public Boolean getCloudWatchMetricsEnabled()
```
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
    
    Returns:
    
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
  - withCloudWatchMetricsEnabled
```
public WriteApplicationSettingsRequest withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
    
    Parameters:
    
    cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCloudWatchMetricsEnabled
```
public Boolean isCloudWatchMetricsEnabled()
```
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
    
    Returns:
    
    Specifies whether to enable application-related alarms in Amazon CloudWatch.
  - setLimits
```
public void setLimits(CampaignLimits limits)
```
    The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
    
    Parameters:
    
    limits - The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
  - getLimits
```
public CampaignLimits getLimits()
```
    The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
    
    Returns:
    
    The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
  - withLimits
```
public WriteApplicationSettingsRequest withLimits(CampaignLimits limits)
```
    The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
    
    Parameters:
    
    limits - The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuietTime
```
public void setQuietTime(QuietTime quietTime)
```
    The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
    Parameters:
    quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    
    The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    
    The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    
    The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
  - getQuietTime
```
public QuietTime getQuietTime()
```
    The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
    Returns:
    The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    
    The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    
    The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    
    The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
  - withQuietTime
```
public WriteApplicationSettingsRequest withQuietTime(QuietTime quietTime)
```
    The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
    Parameters:
    quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
    
    The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    
    The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
    
    The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for 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 WriteApplicationSettingsRequest 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 WriteApplicationSettingsRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WriteApplicationSettingsRequest

Method Detail

setCampaignHook

getCampaignHook

withCampaignHook

setCloudWatchMetricsEnabled

getCloudWatchMetricsEnabled

withCloudWatchMetricsEnabled

isCloudWatchMetricsEnabled

setLimits

getLimits

withLimits

setQuietTime

getQuietTime

withQuietTime

toString

equals

hashCode

clone

marshall