Class ApplicationSettingsResource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ApplicationSettingsResource.Builder,
ApplicationSettingsResource>
Provides information about an application, including the default settings for an application.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the application.builder()
final CampaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The default sending limits for journeys in the application.final String
The date and time, in ISO 8601 format, when the application's settings were last modified.final CampaignLimits
limits()
The default sending limits for campaigns in the application.final QuietTime
The default quiet time for campaigns in the application.static Class
<? extends ApplicationSettingsResource.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
The default sending limits for campaigns in the application.
- Returns:
- The default sending limits for campaigns in the application.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ApplicationSettingsResource.Builder,
ApplicationSettingsResource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-