Package ai.vectros.resources.identity.requests

Class ListOrgsRequest.Builder

java.lang.Object

ai.vectros.resources.identity.requests.ListOrgsRequest.Builder

Enclosing class:

ListOrgsRequest

public static final class ListOrgsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListOrgsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListOrgsRequest.Builder	additionalProperty(String key, Object value)
ListOrgsRequest	build()
ListOrgsRequest.Builder	externalId(String externalId)
ListOrgsRequest.Builder	externalId(Optional<String> externalId)	Look up an organization by your own identifier.
ListOrgsRequest.Builder	field(String field)
ListOrgsRequest.Builder	field(Optional<String> field)	The schema-declared lookup field to filter on.
ListOrgsRequest.Builder	from(ListOrgsRequest other)
ListOrgsRequest.Builder	from(String from)
ListOrgsRequest.Builder	from(Optional<String> from)	Inclusive lower bound for a range lookup.
ListOrgsRequest.Builder	limit(Long limit)
ListOrgsRequest.Builder	limit(Optional<Long> limit)	Maximum number of organizations to return per page (1–100; defaults to 20).
ListOrgsRequest.Builder	order(ListOrgsRequestOrder order)
ListOrgsRequest.Builder	order(Optional<ListOrgsRequestOrder> order)	Sort direction for lookup results: asc (ascending, the default) or desc (descending).
ListOrgsRequest.Builder	prefix(String prefix)
ListOrgsRequest.Builder	prefix(Optional<String> prefix)	Match all values for field that start with this prefix.
ListOrgsRequest.Builder	startFrom(String startFrom)
ListOrgsRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListOrgsRequest.Builder	to(String to)
ListOrgsRequest.Builder	to(Optional<String> to)	Inclusive upper bound for a range lookup.
ListOrgsRequest.Builder	type(String type)
ListOrgsRequest.Builder	type(Optional<String> type)	The schema record type whose lookup fields you want to query.
ListOrgsRequest.Builder	userId(String userId)
ListOrgsRequest.Builder	userId(Optional<String> userId)	Return only organizations owned by this user, given as the Vectros-assigned ID (UUID) of a user.
ListOrgsRequest.Builder	value(String value)
ListOrgsRequest.Builder	value(Optional<String> value)	Exact value to match for field (equality lookup).

Methods inherited from class java.lang.Object

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

Method Details

from

public ListOrgsRequest.Builder from(ListOrgsRequest other)

userId

public ListOrgsRequest.Builder userId(Optional<String> userId)

Return only organizations owned by this user, given as the Vectros-assigned ID (UUID) of a user. To resolve a user ID from your own identifier, call GET /v1/users?externalId=.

userId

public ListOrgsRequest.Builder userId(String userId)

externalId

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

Look up an organization by your own identifier. Returns a list with the single matching organization, or an empty list if none matches.

externalId

public ListOrgsRequest.Builder externalId(String externalId)

startFrom

public ListOrgsRequest.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 ListOrgsRequest.Builder startFrom(String startFrom)

limit

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

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

limit

public ListOrgsRequest.Builder limit(Long limit)

type

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

The schema record type whose lookup fields you want to query. Must be supplied together with field and exactly one lookup mode (value, from/to, or prefix).

type

public ListOrgsRequest.Builder type(String type)

field

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

The schema-declared lookup field to filter on. Must be one of the lookup fields defined on the schema named by type. Supplied together with type and one lookup mode.

field

public ListOrgsRequest.Builder field(String field)

value

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

Exact value to match for field (equality lookup). Mutually exclusive with from/to and prefix. Not allowed for a sensitive field — use POST /v1/orgs/lookup instead so the value is not exposed in the URL.

value

public ListOrgsRequest.Builder value(String value)

from

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

Inclusive lower bound for a range lookup. Requires to, and is only supported on non-sensitive fields that have range lookups enabled. Mutually exclusive with value and prefix.

from

public ListOrgsRequest.Builder from(String from)

to

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

Inclusive upper bound for a range lookup. Requires from.

to

public ListOrgsRequest.Builder to(String to)

prefix

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

Match all values for field that start with this prefix. Only supported on string fields that have range lookups enabled. Mutually exclusive with value and from/to.

prefix

public ListOrgsRequest.Builder prefix(String prefix)

order

public ListOrgsRequest.Builder order(Optional<ListOrgsRequestOrder> order)

Sort direction for lookup results: asc (ascending, the default) or desc (descending).

order

public ListOrgsRequest.Builder order(ListOrgsRequestOrder order)

build

public ListOrgsRequest build()

additionalProperty

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

additionalProperties

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