Constructor Detail

Method Detail

• email

   final UserListParams.Builder email(UserListParams.Email email)

  Email of the user to search for. You may pass the param multiple times to filter for more than one email

• email

   final UserListParams.Builder email(Optional<UserListParams.Email> email)

  Alias for calling Builder.email with email.orElse(null).

• email

   final UserListParams.Builder email(String string)

  Alias for calling email with Email.ofString(string).

• emailOfStrings

   final UserListParams.Builder emailOfStrings(List<String> strings)

  Alias for calling email with Email.ofStrings(strings).

• endingBefore

   final UserListParams.Builder endingBefore(String endingBefore)

  Pagination cursor id.

  For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

• endingBefore

   final UserListParams.Builder endingBefore(Optional<String> endingBefore)

  Alias for calling Builder.endingBefore with endingBefore.orElse(null).

• familyName

   final UserListParams.Builder familyName(UserListParams.FamilyName familyName)

  Family name of the user to search for. You may pass the param multiple times to filter for more than one family name

• familyName

   final UserListParams.Builder familyName(Optional<UserListParams.FamilyName> familyName)

  Alias for calling Builder.familyName with familyName.orElse(null).

• familyName

   final UserListParams.Builder familyName(String string)

  Alias for calling familyName with FamilyName.ofString(string).

• familyNameOfStrings

   final UserListParams.Builder familyNameOfStrings(List<String> strings)

  Alias for calling familyName with FamilyName.ofStrings(strings).

• givenName

   final UserListParams.Builder givenName(UserListParams.GivenName givenName)

  Given name of the user to search for. You may pass the param multiple times to filter for more than one given name

• givenName

   final UserListParams.Builder givenName(Optional<UserListParams.GivenName> givenName)

  Alias for calling Builder.givenName with givenName.orElse(null).

• givenName

   final UserListParams.Builder givenName(String string)

  Alias for calling givenName with GivenName.ofString(string).

• givenNameOfStrings

   final UserListParams.Builder givenNameOfStrings(List<String> strings)

  Alias for calling givenName with GivenName.ofStrings(strings).

• ids

   final UserListParams.Builder ids(UserListParams.Ids ids)

  Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

• ids

   final UserListParams.Builder ids(Optional<UserListParams.Ids> ids)

  Alias for calling Builder.ids with ids.orElse(null).

• ids

   final UserListParams.Builder ids(String string)

  Alias for calling ids with Ids.ofString(string).

• idsOfStrings

   final UserListParams.Builder idsOfStrings(List<String> strings)

  Alias for calling ids with Ids.ofStrings(strings).

• limit

   final UserListParams.Builder limit(Long limit)

  Limit the number of objects to return

• limit

   final UserListParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final UserListParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• orgName

   final UserListParams.Builder orgName(String orgName)

  Filter search results to within a particular organization

• orgName

   final UserListParams.Builder orgName(Optional<String> orgName)

  Alias for calling Builder.orgName with orgName.orElse(null).

• startingAfter

   final UserListParams.Builder startingAfter(String startingAfter)

  Pagination cursor id.

  For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

• startingAfter

   final UserListParams.Builder startingAfter(Optional<String> startingAfter)

  Alias for calling Builder.startingAfter with startingAfter.orElse(null).

• additionalHeaders

   final UserListParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final UserListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final UserListParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final UserListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final UserListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final UserListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final UserListParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final UserListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final UserListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final UserListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final UserListParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final UserListParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final UserListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final UserListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final UserListParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final UserListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final UserListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final UserListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final UserListParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final UserListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final UserListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final UserListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final UserListParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final UserListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final UserListParams build()

  Returns an immutable instance of UserListParams.

  Further updates to this Builder will not mutate the returned instance.