Interface SearchNotificationsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchNotificationsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchNotificationsRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchNotificationsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchNotificationsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchNotificationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchNotificationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchNotificationsRequest.Builder	searchCriteria(Consumer<NotificationSearchCriteria.Builder> searchCriteria)	The search criteria to apply when searching for notifications.
SearchNotificationsRequest.Builder	searchCriteria(NotificationSearchCriteria searchCriteria)	The search criteria to apply when searching for notifications.
default SearchNotificationsRequest.Builder	searchFilter(Consumer<NotificationSearchFilter.Builder> searchFilter)	Filters to apply to the search results, such as tag-based filters.
SearchNotificationsRequest.Builder	searchFilter(NotificationSearchFilter searchFilter)	Filters to apply to the search results, such as tag-based filters.

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

SearchNotificationsRequest.Builder instanceId(String instanceId)

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

Parameters:

instanceId - The identifier of the Amazon Connect 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.

nextToken

SearchNotificationsRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

Returns:

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

maxResults

SearchNotificationsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page. Valid range is 1-100.

Parameters:

maxResults - The maximum number of results to return per page. Valid range is 1-100.

Returns:

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

searchFilter

SearchNotificationsRequest.Builder searchFilter(NotificationSearchFilter searchFilter)

Filters to apply to the search results, such as tag-based filters.

Parameters:

searchFilter - Filters to apply to the search results, such as tag-based filters.

Returns:

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

searchFilter

default SearchNotificationsRequest.Builder searchFilter(Consumer<NotificationSearchFilter.Builder> searchFilter)

Filters to apply to the search results, such as tag-based filters.

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

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

Parameters:

searchFilter - a consumer that will call methods on NotificationSearchFilter.Builder

Returns:

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

See Also:

• searchFilter(NotificationSearchFilter)

searchCriteria

SearchNotificationsRequest.Builder searchCriteria(NotificationSearchCriteria searchCriteria)

The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

Parameters:

searchCriteria - The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

Returns:

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

searchCriteria

default SearchNotificationsRequest.Builder searchCriteria(Consumer<NotificationSearchCriteria.Builder> searchCriteria)

The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

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

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

Parameters:

searchCriteria - a consumer that will call methods on NotificationSearchCriteria.Builder

Returns:

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

See Also:

• searchCriteria(NotificationSearchCriteria)

overrideConfiguration

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

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