Interface ApplicationSettingsResource.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>, SdkBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>, SdkPojo
Enclosing class:
ApplicationSettingsResource
@Mutable @NotThreadSafe public static interface ApplicationSettingsResource.Builder extends SdkPojo, CopyableBuilder<ApplicationSettingsResource.Builder,ApplicationSettingsResource>

  • Method Details

    • applicationId

      ApplicationSettingsResource.Builder applicationId(String applicationId)

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

      Parameters:
      applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • campaignHook

      ApplicationSettingsResource.Builder campaignHook(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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • campaignHook

      default ApplicationSettingsResource.Builder campaignHook(Consumer<CampaignHook.Builder> 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.

      This is a convenience method that creates an instance of the CampaignHook.Builder avoiding the need to create one manually via CampaignHook.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to campaignHook(CampaignHook).

      Parameters:
      campaignHook - a consumer that will call methods on CampaignHook.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastModifiedDate

      ApplicationSettingsResource.Builder lastModifiedDate(String lastModifiedDate)

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

      Parameters:
      lastModifiedDate - The date and time, in ISO 8601 format, when the application's settings were last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limits

      ApplicationSettingsResource.Builder limits(CampaignLimits limits)

      The default sending limits for campaigns in the application.

      Parameters:
      limits - The default sending limits for campaigns in the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limits

      default ApplicationSettingsResource.Builder limits(Consumer<CampaignLimits.Builder> limits)

      The default sending limits for campaigns in the application.

      This is a convenience method that creates an instance of the CampaignLimits.Builder avoiding the need to create one manually via CampaignLimits.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to limits(CampaignLimits).

      Parameters:
      limits - a consumer that will call methods on CampaignLimits.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • quietTime

      ApplicationSettingsResource.Builder quietTime(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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quietTime

      default ApplicationSettingsResource.Builder quietTime(Consumer<QuietTime.Builder> 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.

      This is a convenience method that creates an instance of the QuietTime.Builder avoiding the need to create one manually via QuietTime.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quietTime(QuietTime).

      Parameters:
      quietTime - a consumer that will call methods on QuietTime.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • journeyLimits

      ApplicationSettingsResource.Builder journeyLimits(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.

    • journeyLimits

      default ApplicationSettingsResource.Builder journeyLimits(Consumer<ApplicationSettingsJourneyLimits.Builder> 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.

      This is a convenience method that creates an instance of the ApplicationSettingsJourneyLimits.Builder avoiding the need to create one manually via ApplicationSettingsJourneyLimits.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to journeyLimits(ApplicationSettingsJourneyLimits).

      Parameters:
      journeyLimits - a consumer that will call methods on ApplicationSettingsJourneyLimits.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: