Interface ListUsersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>, SdkBuilder<ListUsersRequest.Builder,ListUsersRequest>, SdkPojo, SdkRequest.Builder, WickrRequest.Builder
Enclosing class:
ListUsersRequest
@Mutable @NotThreadSafe public static interface ListUsersRequest.Builder extends WickrRequest.Builder, SdkPojo, CopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

  • Method Details

    • networkId

      ListUsersRequest.Builder networkId(String networkId)

      The ID of the Wickr network from which to list users.

      Parameters:
      networkId - The ID of the Wickr network from which to list users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListUsersRequest.Builder nextToken(String nextToken)

      The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

      Parameters:
      nextToken - The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListUsersRequest.Builder maxResults(Integer maxResults)

      The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

      Parameters:
      maxResults - The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortFields

      ListUsersRequest.Builder sortFields(String sortFields)

      The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.

      Parameters:
      sortFields - The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortDirection

      ListUsersRequest.Builder sortDirection(String sortDirection)

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

      Parameters:
      sortDirection - The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortDirection

      ListUsersRequest.Builder sortDirection(SortDirection sortDirection)

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

      Parameters:
      sortDirection - The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firstName

      ListUsersRequest.Builder firstName(String firstName)

      Filter results to only include users with first names matching this value.

      Parameters:
      firstName - Filter results to only include users with first names matching this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastName

      ListUsersRequest.Builder lastName(String lastName)

      Filter results to only include users with last names matching this value.

      Parameters:
      lastName - Filter results to only include users with last names matching this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      ListUsersRequest.Builder username(String username)

      Filter results to only include users with usernames matching this value.

      Parameters:
      username - Filter results to only include users with usernames matching this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ListUsersRequest.Builder status(Integer status)

      Filter results to only include users with this status (1 for pending, 2 for active).

      Parameters:
      status - Filter results to only include users with this status (1 for pending, 2 for active).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupId

      ListUsersRequest.Builder groupId(String groupId)

      Filter results to only include users belonging to this security group.

      Parameters:
      groupId - Filter results to only include users belonging to this security group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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