Interface SearchNotificationsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,ConnectRequest.Builder,CopyableBuilder<SearchNotificationsRequest.Builder,,SearchNotificationsRequest> SdkBuilder<SearchNotificationsRequest.Builder,,SearchNotificationsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SearchNotificationsRequest
-
Method Summary
Modifier and TypeMethodDescriptioninstanceId(String instanceId) The identifier of the Amazon Connect instance.maxResults(Integer maxResults) The maximum number of results to return per page.The token for the next set of results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.searchCriteria(Consumer<NotificationSearchCriteria.Builder> searchCriteria) The search criteria to apply when searching for notifications.searchCriteria(NotificationSearchCriteria searchCriteria) The search criteria to apply when searching for notifications.searchFilter(Consumer<NotificationSearchFilter.Builder> searchFilter) Filters to apply to the search results, such as tag-based filters.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
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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 theNotificationSearchFilter.Builderavoiding the need to create one manually viaNotificationSearchFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosearchFilter(NotificationSearchFilter).- Parameters:
searchFilter- a consumer that will call methods onNotificationSearchFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theNotificationSearchCriteria.Builderavoiding the need to create one manually viaNotificationSearchCriteria.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosearchCriteria(NotificationSearchCriteria).- Parameters:
searchCriteria- a consumer that will call methods onNotificationSearchCriteria.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchNotificationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-