Interface ListProtectionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListProtectionsRequest.Builder,
,ListProtectionsRequest> SdkBuilder<ListProtectionsRequest.Builder,
,ListProtectionsRequest> SdkPojo
,SdkRequest.Builder
,ShieldRequest.Builder
- Enclosing class:
ListProtectionsRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault ListProtectionsRequest.Builder
inclusionFilters
(Consumer<InclusionProtectionFilters.Builder> inclusionFilters) Narrows the set of protections that the call retrieves.inclusionFilters
(InclusionProtectionFilters inclusionFilters) Narrows the set of protections that the call retrieves.maxResults
(Integer maxResults) The greatest number of objects that you want Shield Advanced to return to the list request.When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes aNextToken
value in the response.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.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.shield.model.ShieldRequest.Builder
build
-
Method Details
-
nextToken
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a
NextToken
value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults
setting. Shield Advanced will not return more thanMaxResults
objects, but may return fewer, even if more objects are still available.Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken
value.On your first call to a list operation, leave this setting empty.
- Parameters:
nextToken
- When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes aNextToken
value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
MaxResults
setting. Shield Advanced will not return more thanMaxResults
objects, but may return fewer, even if more objects are still available.Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
NextToken
value.On your first call to a list operation, leave this setting empty.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a
NextToken
value in the response.The default setting is 20.
- Parameters:
maxResults
- The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return aNextToken
value in the response.The default setting is 20.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inclusionFilters
Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
- Parameters:
inclusionFilters
- Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inclusionFilters
default ListProtectionsRequest.Builder inclusionFilters(Consumer<InclusionProtectionFilters.Builder> inclusionFilters) Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
This is a convenience method that creates an instance of theInclusionProtectionFilters.Builder
avoiding the need to create one manually viaInclusionProtectionFilters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinclusionFilters(InclusionProtectionFilters)
.- Parameters:
inclusionFilters
- a consumer that will call methods onInclusionProtectionFilters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListProtectionsRequest.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
ListProtectionsRequest.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.
-