Package software.amazon.awssdk.services.identitystore.model

Interface ListGroupsRequest.Builder

    • Method Detail

      • identityStoreId

        ListGroupsRequest.Builder identityStoreId​(String identityStoreId)

        The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

        Parameters:
        identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListGroupsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

        Parameters:
        maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListGroupsRequest.Builder nextToken​(String nextToken)

        The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

        Parameters:
        nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        @Deprecated
ListGroupsRequest.Builder filters​(Collection<Filter> filters)
        Deprecated.
        Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

        A list of Filter objects, which is used in the ListUsers and ListGroups requests.

        Parameters:
        filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        @Deprecated
ListGroupsRequest.Builder filters​(Filter... filters)
        Deprecated.
        Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

        A list of Filter objects, which is used in the ListUsers and ListGroups requests.

        Parameters:
        filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        @Deprecated
ListGroupsRequest.Builder filters​(Consumer<Filter.Builder>... filters)
        Deprecated.
        Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

        A list of Filter objects, which is used in the ListUsers and ListGroups requests.

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

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

        Parameters:
        filters - a consumer that will call methods on Filter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)