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

Interface SearchUsersRequest.Builder

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

  • Method Details

    • 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<Filter>).

      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:

    • 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<Sort>).

      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:

    • overrideConfiguration

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

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