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 reserved namespace names; others are namespaces you registered yourself. 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. user is fully account-wide: filtering by it lists your account's identity schemas regardless of the calling context, since a user-surfaced schema always has one tenant-wide home. entity is NOT account-wide in the same sense: an entity schema is homed in whichever app context its namespace is placed in (or the tenant-wide home for a tenant-placed namespace), so filtering by entity reads your own context's entity schemas together with the tenant-wide ones — a different caller context can see a different result. record and document list within the calling context only.

    • 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 to resolve an account-wide identity schema, or surface=entity to resolve one from your own context plus the tenant-wide home (see the surface parameter). A type name may have several schemas in one context — a shared base, plus per-owner variants declared via basedOn — and resolution shadows by ownership: your own userId- or scope-owned variant wins if you have one, otherwise the shared base. For a scoped credential the owner is always your own token identity; userId/scope here only apply as an explicit owner selector for a root API key (a scoped credential's own identity always governs resolution, and a scope filter still narrows the result afterward regardless of credential type).

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor returned by the previous page to fetch the next page; omit it for the first page. The cursor is opaque — echo it back unchanged, and do not parse it or construct one. Keep every other query parameter identical while paging: a cursor is valid only for the exact query that returned it, and reusing one against a different query is rejected with a 400.

    • 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()