Package software.amazon.awssdk.services.shield.model

Interface ListProtectionGroupsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListProtectionGroupsRequest.Builder,ListProtectionGroupsRequest>, SdkBuilder<ListProtectionGroupsRequest.Builder,ListProtectionGroupsRequest>, SdkPojo, SdkRequest.Builder, ShieldRequest.Builder
Enclosing class:
ListProtectionGroupsRequest
public static interface ListProtectionGroupsRequest.Builder extends ShieldRequest.Builder, SdkPojo, CopyableBuilder<ListProtectionGroupsRequest.Builder,ListProtectionGroupsRequest>

  • Method Details

    • nextToken

      ListProtectionGroupsRequest.Builder nextToken(String 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 than MaxResults 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 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 than MaxResults 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

      ListProtectionGroupsRequest.Builder maxResults(Integer 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 a NextToken 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

      ListProtectionGroupsRequest.Builder inclusionFilters(InclusionProtectionGroupFilters inclusionFilters)

      Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

      Parameters:
      inclusionFilters - Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionFilters

      default ListProtectionGroupsRequest.Builder inclusionFilters(Consumer<InclusionProtectionGroupFilters.Builder> inclusionFilters)

      Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

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

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

      Parameters:
      inclusionFilters - a consumer that will call methods on InclusionProtectionGroupFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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