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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.