software.amazon.awssdk.services.pinpoint.model

Interface WriteApplicationSettingsRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>, SdkBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>, SdkPojo

Enclosing class:

WriteApplicationSettingsRequest

public static interface WriteApplicationSettingsRequest.Builder
extends SdkPojo, CopyableBuilder<WriteApplicationSettingsRequest.Builder,WriteApplicationSettingsRequest>

Method Summary

Modifier and Type	Method and Description
WriteApplicationSettingsRequest.Builder	campaignHook(CampaignHook campaignHook) The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application.
default WriteApplicationSettingsRequest.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.
WriteApplicationSettingsRequest.Builder	cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled) Specifies whether to enable application-related alarms in Amazon CloudWatch.
WriteApplicationSettingsRequest.Builder	eventTaggingEnabled(Boolean eventTaggingEnabled) Sets the value of the EventTaggingEnabled property for this object.
WriteApplicationSettingsRequest.Builder	journeyLimits(ApplicationSettingsJourneyLimits journeyLimits) The default sending limits for journeys in the application.
default WriteApplicationSettingsRequest.Builder	journeyLimits(Consumer<ApplicationSettingsJourneyLimits.Builder> journeyLimits) The default sending limits for journeys in the application.
WriteApplicationSettingsRequest.Builder	limits(CampaignLimits limits) The default sending limits for campaigns in the application.
default WriteApplicationSettingsRequest.Builder	limits(Consumer<CampaignLimits.Builder> limits) The default sending limits for campaigns in the application.
default WriteApplicationSettingsRequest.Builder	quietTime(Consumer<QuietTime.Builder> quietTime) The default quiet time for campaigns in the application.
WriteApplicationSettingsRequest.Builder	quietTime(QuietTime quietTime) The default quiet time for campaigns in the application.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

campaignHook

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

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

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.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

Returns:

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

campaignHook

default WriteApplicationSettingsRequest.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.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

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:

campaignHook(CampaignHook)

cloudWatchMetricsEnabled

WriteApplicationSettingsRequest.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)

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

Parameters:

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

Returns:

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

eventTaggingEnabled

WriteApplicationSettingsRequest.Builder eventTaggingEnabled(Boolean eventTaggingEnabled)

Sets the value of the EventTaggingEnabled property for this object.

Parameters:

eventTaggingEnabled - The new value for the EventTaggingEnabled property for this object.

Returns:

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

limits

WriteApplicationSettingsRequest.Builder limits(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.

Parameters:

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:

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

limits

default WriteApplicationSettingsRequest.Builder limits(Consumer<CampaignLimits.Builder> 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.

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:

limits(CampaignLimits)

quietTime

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

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.

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.

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:

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

quietTime

default WriteApplicationSettingsRequest.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.

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.

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:

quietTime(QuietTime)

journeyLimits

WriteApplicationSettingsRequest.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 WriteApplicationSettingsRequest.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:

journeyLimits(ApplicationSettingsJourneyLimits)