Package software.amazon.awssdk.services.resourcegroups.model

Class ListGroupsRequest

    • Method Detail

      • hasFilters

        public final boolean hasFilters()
        For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • filters

        public final List<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::AppRegistry::Application

          • AWS::AppRegistry::ApplicationResourceGroups

          • AWS::CloudFormation::Stack

          • AWS::EC2::CapacityReservationPool

          • AWS::EC2::HostManagement

          • AWS::NetworkFirewall::RuleGroup

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

        Returns:
        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::AppRegistry::Application

          • AWS::AppRegistry::ApplicationResourceGroups

          • AWS::CloudFormation::Stack

          • AWS::EC2::CapacityReservationPool

          • AWS::EC2::HostManagement

          • AWS::NetworkFirewall::RuleGroup

      • maxResults

        public final 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.

        Returns:
        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.

      • nextToken

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object