Package software.amazon.awssdk.services.alexaforbusiness.model

Interface SearchUsersRequest.Builder

    • Method Detail

      • nextToken

        SearchUsersRequest.Builder nextToken​(String nextToken)

        An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

        Parameters:
        nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        SearchUsersRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

        Parameters:
        maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchUsersRequest.Builder filters​(Collection<Filter> filters)

        The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

        Parameters:
        filters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchUsersRequest.Builder filters​(Filter... filters)

        The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

        Parameters:
        filters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchUsersRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

        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)

      • sortCriteria

        SearchUsersRequest.Builder sortCriteria​(Collection<Sort> sortCriteria)

        The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

        Parameters:
        sortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortCriteria

        SearchUsersRequest.Builder sortCriteria​(Sort... sortCriteria)

        The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

        Parameters:
        sortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortCriteria

        SearchUsersRequest.Builder sortCriteria​(Consumer<Sort.Builder>... sortCriteria)

        The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

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

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

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