Interface ListGuestUsersRequest.Builder

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

  • Method Details

    • networkId

      ListGuestUsersRequest.Builder networkId(String networkId)

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

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

    • maxResults

      ListGuestUsersRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of guest 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.

    • sortDirection

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

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

    • sortFields

      ListGuestUsersRequest.Builder sortFields(String sortFields)

      The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

      Parameters:
      sortFields - The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      ListGuestUsersRequest.Builder username(String username)

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

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

    • billingPeriod

      ListGuestUsersRequest.Builder billingPeriod(String billingPeriod)

      Filter results to only include guest users from this billing period (e.g., '2024-01').

      Parameters:
      billingPeriod - Filter results to only include guest users from this billing period (e.g., '2024-01').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

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

    • overrideConfiguration

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

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