Interface SearchContactFlowsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ConnectRequest.Builder
,CopyableBuilder<SearchContactFlowsRequest.Builder,
,SearchContactFlowsRequest> SdkBuilder<SearchContactFlowsRequest.Builder,
,SearchContactFlowsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchContactFlowsRequest
-
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<ContactFlowSearchCriteria.Builder> searchCriteria) The search criteria to be used to return flows.searchCriteria
(ContactFlowSearchCriteria searchCriteria) The search criteria to be used to return flows.searchFilter
(Consumer<ContactFlowSearchFilter.Builder> searchFilter) Filters to be applied to search results.searchFilter
(ContactFlowSearchFilter searchFilter) Filters to be applied to search results.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, 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 in the next request to retrieve the next set of results.
- Parameters:
nextToken
- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set 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.
- Parameters:
maxResults
- The maximum number of results to return per page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchFilter
Filters to be applied to search results.
- Parameters:
searchFilter
- Filters to be applied to search results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchFilter
default SearchContactFlowsRequest.Builder searchFilter(Consumer<ContactFlowSearchFilter.Builder> searchFilter) Filters to be applied to search results.
This is a convenience method that creates an instance of theContactFlowSearchFilter.Builder
avoiding the need to create one manually viaContactFlowSearchFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosearchFilter(ContactFlowSearchFilter)
.- Parameters:
searchFilter
- a consumer that will call methods onContactFlowSearchFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
searchCriteria
The search criteria to be used to return flows.
The
name
anddescription
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.- Parameters:
searchCriteria
- The search criteria to be used to return flows.The
name
anddescription
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchCriteria
default SearchContactFlowsRequest.Builder searchCriteria(Consumer<ContactFlowSearchCriteria.Builder> searchCriteria) The search criteria to be used to return flows.
The
name
anddescription
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.ContactFlowSearchCriteria.Builder
avoiding the need to create one manually viaContactFlowSearchCriteria.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosearchCriteria(ContactFlowSearchCriteria)
.- Parameters:
searchCriteria
- a consumer that will call methods onContactFlowSearchCriteria.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchContactFlowsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchContactFlowsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-