Package ai.vectros.resources.schemas.requests

Class ListSchemasRequest.Builder

java.lang.Object

ai.vectros.resources.schemas.requests.ListSchemasRequest.Builder

Enclosing class:

ListSchemasRequest

public static final class ListSchemasRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListSchemasRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListSchemasRequest.Builder	additionalProperty(String key, Object value)
ListSchemasRequest	build()
ListSchemasRequest.Builder	from(ListSchemasRequest other)
ListSchemasRequest.Builder	limit(Long limit)
ListSchemasRequest.Builder	limit(Optional<Long> limit)	Maximum number of schemas to return per page (1–100; defaults to 20).
ListSchemasRequest.Builder	orgId(String orgId)
ListSchemasRequest.Builder	orgId(Optional<String> orgId)	Filter to schemas owned by this organization — the Vectros-assigned UUID of an organization in your account.
ListSchemasRequest.Builder	recordType(String recordType)
ListSchemasRequest.Builder	recordType(Optional<String> recordType)	Resolve the single schema for this record type — the natural handle for a schema, and the direct alternative to remembering its opaque id.
ListSchemasRequest.Builder	startFrom(String startFrom)
ListSchemasRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListSchemasRequest.Builder	surface(String surface)
ListSchemasRequest.Builder	surface(Optional<String> surface)	Filter to schemas bindable to this surface: record, document, user, org, or client.
ListSchemasRequest.Builder	userId(String userId)
ListSchemasRequest.Builder	userId(Optional<String> userId)	Filter to schemas owned by this user — the Vectros-assigned UUID of a user in your account.

Methods inherited from class java.lang.Object

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

Method Details

from

public ListSchemasRequest.Builder from(ListSchemasRequest other)

userId

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

Filter to schemas owned by this user — the Vectros-assigned UUID of a user in your account. Use GET /v1/users?externalId= to resolve a UUID from your own external id.

userId

public ListSchemasRequest.Builder userId(String userId)

orgId

public ListSchemasRequest.Builder orgId(Optional<String> orgId)

Filter to schemas owned by this organization — the Vectros-assigned UUID of an organization in your account. Use GET /v1/orgs?externalId= to resolve a UUID from your own external id.

orgId

public ListSchemasRequest.Builder orgId(String orgId)

surface

public ListSchemasRequest.Builder surface(Optional<String> surface)

Filter to schemas bindable to this surface: record, document, user, org, or client. Returns only schemas whose allowed surfaces include the given one — useful for listing, say, document types separately from record types. The identity surfaces (user, org, client) are account-wide: filtering by one lists your account's identity schemas regardless of the calling context, whereas record and document list within the calling context.

surface

public ListSchemasRequest.Builder surface(String surface)

recordType

public ListSchemasRequest.Builder recordType(Optional<String> recordType)

Resolve the single schema for this record type — the natural handle for a schema, and the direct alternative to remembering its opaque id. Returns a one-element page, or an empty page if no such schema exists. Resolved in the calling context for record and document types; combine with surface=user, org, or client to resolve an account-wide identity schema. Mutually exclusive with userId/orgId — when supplied, recordType takes precedence.

recordType

public ListSchemasRequest.Builder recordType(String recordType)

startFrom

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

limit

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

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

limit

public ListSchemasRequest.Builder limit(Long limit)

build

public ListSchemasRequest build()

additionalProperty

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

additionalProperties

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