Package ai.vectros.resources.identity.requests

Class ListEntitiesRequest.Builder

java.lang.Object

ai.vectros.resources.identity.requests.ListEntitiesRequest.Builder

Enclosing class:

ListEntitiesRequest

public static final class ListEntitiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListEntitiesRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListEntitiesRequest.Builder	additionalProperty(String key, Object value)
ListEntitiesRequest	build()
ListEntitiesRequest.Builder	externalId(String externalId)
ListEntitiesRequest.Builder	externalId(Optional<String> externalId)	Look up an entity by your own identifier.
ListEntitiesRequest.Builder	field(String field)
ListEntitiesRequest.Builder	field(Optional<String> field)	The schema-declared lookup field to filter on.
ListEntitiesRequest.Builder	from(ListEntitiesRequest other)
ListEntitiesRequest.Builder	from(String from)
ListEntitiesRequest.Builder	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; range-enabled fields).
ListEntitiesRequest.Builder	limit(Long limit)
ListEntitiesRequest.Builder	limit(Optional<Long> limit)	Maximum entities per page (1-100; defaults to 20).
ListEntitiesRequest.Builder	order(ListEntitiesRequestOrder order)
ListEntitiesRequest.Builder	order(Optional<ListEntitiesRequestOrder> order)	Sort direction by the field's value for a type/field lookup: asc (ascending, the default) or desc.
ListEntitiesRequest.Builder	prefix(String prefix)
ListEntitiesRequest.Builder	prefix(Optional<String> prefix)	Match all values of field starting with this prefix (range-enabled string fields).
ListEntitiesRequest.Builder	scope(String scope)
ListEntitiesRequest.Builder	scope(Optional<String> scope)	Filter by parent edge as <namespace>:<value> (e.g.
ListEntitiesRequest.Builder	startFrom(String startFrom)
ListEntitiesRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor from a previous page's nextCursor.
ListEntitiesRequest.Builder	to(String to)
ListEntitiesRequest.Builder	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
ListEntitiesRequest.Builder	type(String type)
ListEntitiesRequest.Builder	type(Optional<String> type)	Schema record type whose lookup fields you want to query.
ListEntitiesRequest.Builder	userId(String userId)
ListEntitiesRequest.Builder	userId(Optional<String> userId)	Return only entities owned by this user (Vectros user ID).
ListEntitiesRequest.Builder	value(String value)
ListEntitiesRequest.Builder	value(Optional<String> value)	Exact value to match for field (equality).

Methods inherited from class java.lang.Object

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

Method Details

from

public ListEntitiesRequest.Builder from(ListEntitiesRequest other)

userId

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

Return only entities owned by this user (Vectros user ID).

userId

public ListEntitiesRequest.Builder userId(String userId)

externalId

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

Look up an entity by your own identifier. Returns a list with the single match, or empty.

externalId

public ListEntitiesRequest.Builder externalId(String externalId)

scope

public ListEntitiesRequest.Builder scope(Optional<String> scope)

Filter by parent edge as <namespace>:<value> (e.g. org:6ba7...). Matches any of the entity's parents, not just its first. Naming this route's own namespace resolves the entity itself.

scope

public ListEntitiesRequest.Builder scope(String scope)

type

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

Schema record type whose lookup fields you want to query. Supply with field and one lookup mode (value, from/to, or prefix).

type

public ListEntitiesRequest.Builder type(String type)

field

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

The schema-declared lookup field to filter on. Supply with type and one lookup mode.

field

public ListEntitiesRequest.Builder field(String field)

value

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

Exact value to match for field (equality). Not allowed for a sensitive field — use POST /v1/entities/{namespace}/lookup.

value

public ListEntitiesRequest.Builder value(String value)

from

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

Inclusive lower bound for a range lookup (requires to; range-enabled fields).

from

public ListEntitiesRequest.Builder from(String from)

to

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

Inclusive upper bound for a range lookup (requires from).

to

public ListEntitiesRequest.Builder to(String to)

prefix

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

Match all values of field starting with this prefix (range-enabled string fields).

prefix

public ListEntitiesRequest.Builder prefix(String prefix)

order

public ListEntitiesRequest.Builder order(Optional<ListEntitiesRequestOrder> order)

Sort direction by the field's value for a type/field lookup: asc (ascending, the default) or desc. Lookup mode only — listing by namespace, userId, scope, or externalId does not take a sort direction and rejects this parameter.

order

public ListEntitiesRequest.Builder order(ListEntitiesRequestOrder order)

startFrom

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

Pagination cursor from a previous page's nextCursor.

startFrom

public ListEntitiesRequest.Builder startFrom(String startFrom)

limit

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

Maximum entities per page (1-100; defaults to 20).

limit

public ListEntitiesRequest.Builder limit(Long limit)

build

public ListEntitiesRequest build()

additionalProperty

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

additionalProperties

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