Package ai.vectros.resources.schemas.requests

Class ListSchemasRequest

java.lang.Object
ai.vectros.resources.schemas.requests.ListSchemasRequest
public final class ListSchemasRequest extends Object

  • Method Details

    • getUserId

      public Optional<String> getUserId()
      Returns:
      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.

    • getScope

      public Optional<String> getScope()
      Returns:
      Filter to schemas carrying this scope value, as a single namespace:value entry — for example org:6ba7b810-9dad-11d1-80b4-00c04fd430c8 or group:eng-team. org and client are built-in namespaces; others are custom scopes you define. Resolve a namespace's UUID from your own identifier with GET /v1/entities/{namespace}?externalId=.

    • getSurface

      public Optional<String> getSurface()
      Returns:
      Filter to schemas bindable to this surface: record, document, user, or entity — identity entities in any namespace (org, client, or one you registered) bind under the single entity surface. Returns only schemas whose allowed surfaces include the given one — useful for listing, say, document types separately from record types. The identity surfaces (user, entity) 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.

    • getRecordType

      public Optional<String> getRecordType()
      Returns:
      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 or surface=entity to resolve an account-wide identity schema. Takes precedence over userId; a scope filter still applies, so a resolved schema outside that scope returns an empty page. A type name is unique per owner, not per context — if more than one owner in this context has defined a schema with this name, the request fails with 400 AMBIGUOUS_RECORD_TYPE instead of guessing; resolve by id instead, or add userId/scope to narrow to one owner first.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor from the previous page to fetch the next page; omit it for the first page.

    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of schemas to return per page (1–100; defaults to 20).

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ListSchemasRequest.Builder builder()