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.

    • getOrgId

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

    • getSurface

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

    • 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, org, or client to resolve an account-wide identity schema. Mutually exclusive with userId/orgId — when supplied, recordType takes precedence.

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