Interface DescribeOptedOutNumbersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeOptedOutNumbersRequest.Builder,
,DescribeOptedOutNumbersRequest> PinpointSmsVoiceV2Request.Builder
,SdkBuilder<DescribeOptedOutNumbersRequest.Builder,
,DescribeOptedOutNumbersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeOptedOutNumbersRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<OptedOutFilter> filters) An array of OptedOutFilter objects to filter the results on.filters
(Consumer<OptedOutFilter.Builder>... filters) An array of OptedOutFilter objects to filter the results on.filters
(OptedOutFilter... filters) An array of OptedOutFilter objects to filter the results on.maxResults
(Integer maxResults) The maximum number of results to return per each request.The token to be used for the next set of paginated results.optedOutNumbers
(String... optedOutNumbers) An array of phone numbers to search for in the OptOutList.optedOutNumbers
(Collection<String> optedOutNumbers) An array of phone numbers to search for in the OptOutList.optOutListName
(String optOutListName) The OptOutListName or OptOutListArn of the OptOutList.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request.Builder
build
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
-
optOutListName
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
- Parameters:
optOutListName
- The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optedOutNumbers
An array of phone numbers to search for in the OptOutList.
- Parameters:
optedOutNumbers
- An array of phone numbers to search for in the OptOutList.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optedOutNumbers
An array of phone numbers to search for in the OptOutList.
- Parameters:
optedOutNumbers
- An array of phone numbers to search for in the OptOutList.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
An array of OptedOutFilter objects to filter the results on.
- Parameters:
filters
- An array of OptedOutFilter objects to filter the results on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
An array of OptedOutFilter objects to filter the results on.
- Parameters:
filters
- An array of OptedOutFilter objects to filter the results on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
An array of OptedOutFilter objects to filter the results on.
This is a convenience method that creates an instance of theOptedOutFilter.Builder
avoiding the need to create one manually viaOptedOutFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<OptedOutFilter>)
.- Parameters:
filters
- a consumer that will call methods onOptedOutFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- Parameters:
nextToken
- The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return per each request.
- Parameters:
maxResults
- The maximum number of results to return per each request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeOptedOutNumbersRequest.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
DescribeOptedOutNumbersRequest.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.
-