Interface SendOutboundWebNotificationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SendOutboundWebNotificationRequest.Builder,SendOutboundWebNotificationRequest>, SdkBuilder<SendOutboundWebNotificationRequest.Builder,SendOutboundWebNotificationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SendOutboundWebNotificationRequest

@Mutable
@NotThreadSafe
public static interface SendOutboundWebNotificationRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SendOutboundWebNotificationRequest.Builder,SendOutboundWebNotificationRequest>

Method Summary

Modifier and Type	Method	Description
SendOutboundWebNotificationRequest.Builder	browserId(String browserId)	A unique identifier for the customer's web browser instance to which the notification is being sent.
SendOutboundWebNotificationRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default SendOutboundWebNotificationRequest.Builder	content(Consumer<WebNotificationContent.Builder> content)	The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.
SendOutboundWebNotificationRequest.Builder	content(WebNotificationContent content)	The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.
default SendOutboundWebNotificationRequest.Builder	destination(Consumer<WidgetDestination.Builder> destination)	The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.
SendOutboundWebNotificationRequest.Builder	destination(WidgetDestination destination)	The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.
SendOutboundWebNotificationRequest.Builder	expiresAt(Instant expiresAt)	The timestamp, in Unix epoch time format, at which the web notification expires.
SendOutboundWebNotificationRequest.Builder	instanceId(String instanceId)	The identifier of the Connect Customer instance.
SendOutboundWebNotificationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendOutboundWebNotificationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SendOutboundWebNotificationRequest.Builder	sessionId(String sessionId)	A unique identifier for the customer's web session to which the notification is being sent.
default SendOutboundWebNotificationRequest.Builder	source(Consumer<WebNotificationSource.Builder> source)	The source of the web notification.
SendOutboundWebNotificationRequest.Builder	source(WebNotificationSource source)	The source of the web notification.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

instanceId

SendOutboundWebNotificationRequest.Builder instanceId(String instanceId)

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

clientToken

SendOutboundWebNotificationRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

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

browserId

SendOutboundWebNotificationRequest.Builder browserId(String browserId)

A unique identifier for the customer's web browser instance to which the notification is being sent.

Parameters:

browserId - A unique identifier for the customer's web browser instance to which the notification is being sent.

Returns:

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

sessionId

SendOutboundWebNotificationRequest.Builder sessionId(String sessionId)

A unique identifier for the customer's web session to which the notification is being sent.

Parameters:

sessionId - A unique identifier for the customer's web session to which the notification is being sent.

Returns:

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

expiresAt

SendOutboundWebNotificationRequest.Builder expiresAt(Instant expiresAt)

The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

Parameters:

expiresAt - The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

Returns:

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

source

SendOutboundWebNotificationRequest.Builder source(WebNotificationSource source)

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

Parameters:

source - The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

Returns:

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

source

default SendOutboundWebNotificationRequest.Builder source(Consumer<WebNotificationSource.Builder> source)

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

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

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

Parameters:

source - a consumer that will call methods on WebNotificationSource.Builder

Returns:

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

See Also:

• source(WebNotificationSource)

destination

SendOutboundWebNotificationRequest.Builder destination(WidgetDestination destination)

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

Parameters:

destination - The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

Returns:

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

destination

default SendOutboundWebNotificationRequest.Builder destination(Consumer<WidgetDestination.Builder> destination)

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

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

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

Parameters:

destination - a consumer that will call methods on WidgetDestination.Builder

Returns:

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

See Also:

• destination(WidgetDestination)

content

SendOutboundWebNotificationRequest.Builder content(WebNotificationContent content)

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Parameters:

content - The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Returns:

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

content

default SendOutboundWebNotificationRequest.Builder content(Consumer<WebNotificationContent.Builder> content)

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

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

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

Parameters:

content - a consumer that will call methods on WebNotificationContent.Builder

Returns:

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

See Also:

• content(WebNotificationContent)

overrideConfiguration

SendOutboundWebNotificationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SendOutboundWebNotificationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.