Package ai.vectros.resources.identity.requests

Class ListUsersRequest.Builder

java.lang.Object

ai.vectros.resources.identity.requests.ListUsersRequest.Builder

Enclosing class:

ListUsersRequest

public static final class ListUsersRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListUsersRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListUsersRequest.Builder	additionalProperty(String key, Object value)
ListUsersRequest	build()
ListUsersRequest.Builder	externalId(String externalId)
ListUsersRequest.Builder	externalId(Optional<String> externalId)	Look up a single user by your own externalId.
ListUsersRequest.Builder	field(String field)
ListUsersRequest.Builder	field(Optional<String> field)	The lookup field to filter on.
ListUsersRequest.Builder	from(ListUsersRequest other)
ListUsersRequest.Builder	from(String from)
ListUsersRequest.Builder	from(Optional<String> from)	Inclusive lower bound for a range lookup.
ListUsersRequest.Builder	limit(Long limit)
ListUsersRequest.Builder	limit(Optional<Long> limit)	Maximum number of users to return per page (1–100; defaults to 20).
ListUsersRequest.Builder	order(ListUsersRequestOrder order)
ListUsersRequest.Builder	order(Optional<ListUsersRequestOrder> order)	Sort direction for the matched users: asc (ascending, the default) or desc (descending).
ListUsersRequest.Builder	prefix(String prefix)
ListUsersRequest.Builder	prefix(Optional<String> prefix)	Prefix to match.
ListUsersRequest.Builder	startFrom(String startFrom)
ListUsersRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListUsersRequest.Builder	to(String to)
ListUsersRequest.Builder	to(Optional<String> to)	Inclusive upper bound for a range lookup.
ListUsersRequest.Builder	type(String type)
ListUsersRequest.Builder	type(Optional<String> type)	The schema record type whose lookup fields you are querying (the schema's declared record type, not the user's HUMAN/SERVICE kind).
ListUsersRequest.Builder	value(String value)
ListUsersRequest.Builder	value(Optional<String> value)	Exact value to match for field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public ListUsersRequest.Builder from(ListUsersRequest other)

externalId

public ListUsersRequest.Builder externalId(Optional<String> externalId)

Look up a single user by your own externalId. Returns a one-element list, or an empty list if no match. Cannot be combined with the type/field/value lookup parameters.

externalId

public ListUsersRequest.Builder externalId(String externalId)

startFrom

public ListUsersRequest.Builder startFrom(Optional<String> startFrom)

Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

startFrom

public ListUsersRequest.Builder startFrom(String startFrom)

limit

public ListUsersRequest.Builder limit(Optional<Long> limit)

Maximum number of users to return per page (1–100; defaults to 20).

limit

public ListUsersRequest.Builder limit(Long limit)

type

public ListUsersRequest.Builder type(Optional<String> type)

The schema record type whose lookup fields you are querying (the schema's declared record type, not the user's HUMAN/SERVICE kind). Must be supplied together with field and exactly one lookup mode (value, from+to, or prefix).

type

public ListUsersRequest.Builder type(String type)

field

public ListUsersRequest.Builder field(Optional<String> field)

The lookup field to filter on. Must be declared as a lookup field on the schema named by type. Supplied together with type and one lookup mode.

field

public ListUsersRequest.Builder field(String field)

value

public ListUsersRequest.Builder value(Optional<String> value)

Exact value to match for field. Cannot be combined with from/to or prefix. Not allowed for a sensitive (blind-indexed) field on this endpoint; use POST /v1/users/lookup instead, which keeps the value out of the URL.

value

public ListUsersRequest.Builder value(String value)

from

public ListUsersRequest.Builder from(Optional<String> from)

Inclusive lower bound for a range lookup. Requires to, and is only valid on non-sensitive fields declared with range support. Cannot be combined with value or prefix.

from

public ListUsersRequest.Builder from(String from)

to

public ListUsersRequest.Builder to(Optional<String> to)

Inclusive upper bound for a range lookup. Requires from.

to

public ListUsersRequest.Builder to(String to)

prefix

public ListUsersRequest.Builder prefix(Optional<String> prefix)

Prefix to match. Only valid on string fields declared with range support. Cannot be combined with value or from/to.

prefix

public ListUsersRequest.Builder prefix(String prefix)

order

public ListUsersRequest.Builder order(Optional<ListUsersRequestOrder> order)

Sort direction for the matched users: asc (ascending, the default) or desc (descending).

order

public ListUsersRequest.Builder order(ListUsersRequestOrder order)

build

public ListUsersRequest build()

additionalProperty

public ListUsersRequest.Builder additionalProperty(String key,
 Object value)

additionalProperties

public ListUsersRequest.Builder additionalProperties(Map<String,Object> additionalProperties)