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 invoke by default as a code hook for campaigns in the application.
`Boolean`	`getCloudWatchMetricsEnabled()` Specifies whether to enable application-related alarms in Amazon CloudWatch.
`Boolean`	`getEventTaggingEnabled()`
`ApplicationSettingsJourneyLimits`	`getJourneyLimits()` The default sending limits for journeys in the application.
`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.
`Boolean`	`isEventTaggingEnabled()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCampaignHook(CampaignHook campaignHook)` The settings for the AWS Lambda function to invoke 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`	`setEventTaggingEnabled(Boolean eventTaggingEnabled)`
`void`	`setJourneyLimits(ApplicationSettingsJourneyLimits journeyLimits)` The default sending limits for journeys in the application.
`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 invoke 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`	`withEventTaggingEnabled(Boolean eventTaggingEnabled)`
`WriteApplicationSettingsRequest`	`withJourneyLimits(ApplicationSettingsJourneyLimits journeyLimits)` The default sending limits for journeys in the application.
`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 invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
    
    Parameters:
    
    campaignHook - The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
  - getCampaignHook
```
public CampaignHook getCampaignHook()
```
    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
    
    Returns:
    
    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
  - withCampaignHook
```
public WriteApplicationSettingsRequest withCampaignHook(CampaignHook campaignHook)
```
    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
    
    Parameters:
    
    campaignHook - The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
    
    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
    
    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.
  - setEventTaggingEnabled
```
public void setEventTaggingEnabled(Boolean eventTaggingEnabled)
```
    Parameters:
    
    eventTaggingEnabled -
  - getEventTaggingEnabled
```
public Boolean getEventTaggingEnabled()
```
    Returns:
  - withEventTaggingEnabled
```
public WriteApplicationSettingsRequest withEventTaggingEnabled(Boolean eventTaggingEnabled)
```
    Parameters:
    
    eventTaggingEnabled -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEventTaggingEnabled
```
public Boolean isEventTaggingEnabled()
```
    Returns:
  - setLimits
```
public void setLimits(CampaignLimits limits)
```
    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
    
    Parameters:
    
    limits - The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
  - getLimits
```
public CampaignLimits getLimits()
```
    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
    
    Returns:
    
    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
  - withLimits
```
public WriteApplicationSettingsRequest withLimits(CampaignLimits limits)
```
    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
    
    Parameters:
    
    limits - The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
    
    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 messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
    Parameters:
    quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
  - getQuietTime
```
public QuietTime getQuietTime()
```
    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
    Returns:
    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
  - withQuietTime
```
public WriteApplicationSettingsRequest withQuietTime(QuietTime quietTime)
```
    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
    Parameters:
    quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
    
    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
    
    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJourneyLimits
```
public void setJourneyLimits(ApplicationSettingsJourneyLimits journeyLimits)
```
    The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
    
    Parameters:
    
    journeyLimits - The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
  - getJourneyLimits
```
public ApplicationSettingsJourneyLimits getJourneyLimits()
```
    The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
    
    Returns:
    
    The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
  - withJourneyLimits
```
public WriteApplicationSettingsRequest withJourneyLimits(ApplicationSettingsJourneyLimits journeyLimits)
```
    The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
    
    Parameters:
    
    journeyLimits - The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.773

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

setEventTaggingEnabled

getEventTaggingEnabled

withEventTaggingEnabled

isEventTaggingEnabled

setLimits

getLimits

withLimits

setQuietTime

getQuietTime

withQuietTime

setJourneyLimits

getJourneyLimits

withJourneyLimits

toString

equals

hashCode

clone

marshall