Package software.amazon.awssdk.services.pinpoint.model

Class ApplicationSettingsResource

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ApplicationSettingsResource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>

@Generated("software.amazon.awssdk:codegen")
public final class ApplicationSettingsResource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>

Provides information about an application, including the default settings for an application.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApplicationSettingsResource.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier for the application.
static ApplicationSettingsResource.Builder	builder()
CampaignHook	campaignHook()	The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ApplicationSettingsJourneyLimits	journeyLimits()	The default sending limits for journeys in the application.
String	lastModifiedDate()	The date and time, in ISO 8601 format, when the application's settings were last modified.
CampaignLimits	limits()	The default sending limits for campaigns in the application.
QuietTime	quietTime()	The default quiet time for campaigns in the application.
List<SdkField<?>>	sdkFields()
static Class<? extends ApplicationSettingsResource.Builder>	serializableBuilderClass()
ApplicationSettingsResource.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationId

public final String applicationId()

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Returns:

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

campaignHook

public final 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.

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.

lastModifiedDate

public final String lastModifiedDate()

The date and time, in ISO 8601 format, when the application's settings were last modified.

Returns:

The date and time, in ISO 8601 format, when the application's settings were last modified.

limits

public final CampaignLimits limits()

The default sending limits for campaigns in the application.

Returns:

The default sending limits for campaigns in the application.

quietTime

public final 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.

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.

journeyLimits

public final 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.

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.

toBuilder

public ApplicationSettingsResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>

builder

public static ApplicationSettingsResource.Builder builder()

serializableBuilderClass

public static Class<? extends ApplicationSettingsResource.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo