Interface SearchPrincipalsRequest.Builder

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

  • Method Details

    • domainId

      SearchPrincipalsRequest.Builder domainId(String domainId)

      The ID of the domain to search within.

      Parameters:
      domainId - The ID of the domain to search within.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchQuery

      SearchPrincipalsRequest.Builder searchQuery(String searchQuery)

      A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters.

      Parameters:
      searchQuery - A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      SearchPrincipalsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return. Defaults to 10. Valid only when searchQuery is *; other searches reject this parameter and return at most 10 results.

      Parameters:
      maxResults - The maximum number of results to return. Defaults to 10. Valid only when searchQuery is *; other searches reject this parameter and return at most 10 results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      SearchPrincipalsRequest.Builder nextToken(String nextToken)

      A token to retrieve the next page of results. Valid only when searchQuery is *; other searches do not paginate and reject this parameter. Tokens expire after 24 hours.

      Parameters:
      nextToken - A token to retrieve the next page of results. Valid only when searchQuery is *; other searches do not paginate and reject this parameter. Tokens expire after 24 hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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