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

Class WriteApplicationSettingsRequest

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.WriteApplicationSettingsRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class WriteApplicationSettingsRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>

Specifies the default settings for an application.

See Also:

  • Method Details

    • 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.

      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.

    • cloudWatchMetricsEnabled

      public final Boolean cloudWatchMetricsEnabled()

      Specifies whether to enable application-related alarms in Amazon CloudWatch.

      Returns:
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

    • eventTaggingEnabled

      public final Boolean eventTaggingEnabled()
      Returns the value of the EventTaggingEnabled property for this object.
      Returns:
      The value of the EventTaggingEnabled property for this object.

    • limits

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

      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.

    • 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.

      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.

    • 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 WriteApplicationSettingsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>

    • builder

      public static WriteApplicationSettingsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WriteApplicationSettingsRequest.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo