Interface ListGroupsRequest.Builder

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

  • Method Details

    • filters

      ListGroupsRequest.Builder filters(Collection<GroupFilter> filters)

      Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

      • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

      • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

        • AWS::ResourceGroups::ApplicationGroup

        • AWS::AppRegistry::Application

        • AWS::AppRegistry::ApplicationResourceGroups

        • AWS::CloudFormation::Stack

        • AWS::EC2::CapacityReservationPool

        • AWS::EC2::HostManagement

        • AWS::NetworkFirewall::RuleGroup

      Parameters:
      filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

      • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

      • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

        • AWS::ResourceGroups::ApplicationGroup

        • AWS::AppRegistry::Application

        • AWS::AppRegistry::ApplicationResourceGroups

        • AWS::CloudFormation::Stack

        • AWS::EC2::CapacityReservationPool

        • AWS::EC2::HostManagement

        • AWS::NetworkFirewall::RuleGroup

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListGroupsRequest.Builder filters(GroupFilter... filters)

      Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

      • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

      • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

        • AWS::ResourceGroups::ApplicationGroup

        • AWS::AppRegistry::Application

        • AWS::AppRegistry::ApplicationResourceGroups

        • AWS::CloudFormation::Stack

        • AWS::EC2::CapacityReservationPool

        • AWS::EC2::HostManagement

        • AWS::NetworkFirewall::RuleGroup

      Parameters:
      filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

      • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

      • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

        • AWS::ResourceGroups::ApplicationGroup

        • AWS::AppRegistry::Application

        • AWS::AppRegistry::ApplicationResourceGroups

        • AWS::CloudFormation::Stack

        • AWS::EC2::CapacityReservationPool

        • AWS::EC2::HostManagement

        • AWS::NetworkFirewall::RuleGroup

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListGroupsRequest.Builder filters(Consumer<GroupFilter.Builder>... filters)

      Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

      • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

      • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

        • AWS::ResourceGroups::ApplicationGroup

        • AWS::AppRegistry::Application

        • AWS::AppRegistry::ApplicationResourceGroups

        • AWS::CloudFormation::Stack

        • AWS::EC2::CapacityReservationPool

        • AWS::EC2::HostManagement

        • AWS::NetworkFirewall::RuleGroup

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<GroupFilter>).

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

    • maxResults

      ListGroupsRequest.Builder maxResults(Integer maxResults)

      The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

      Parameters:
      maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListGroupsRequest.Builder nextToken(String nextToken)

      The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

      Parameters:
      nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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