Package ai.vectros.resources.documents.requests

Class LookupDocumentsRequest

java.lang.Object
ai.vectros.resources.documents.requests.LookupDocumentsRequest
public final class LookupDocumentsRequest extends Object

  • Method Details

    • getType

      public String getType()
      Returns:
      The document type to look up (the type of the bound schema).

    • getField

      public String getField()
      Returns:
      The field to look up by. Use externalId to look up by the document's external identifier, or the name of any lookup field declared on the bound schema.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match. Mutually exclusive with from/to and prefix. Rejected for a sensitive field — use POST /v1/documents/lookup so the value isn't exposed in the URL.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only). Mutually exclusive with value and prefix.

    • getTo

      public Optional<String> getTo()
      Returns:
      Inclusive upper bound for a range lookup (requires from).

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

    • 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 documents to return per page (1-100; defaults to 20).

    • getOrder

      public Optional<LookupDocumentsRequestOrder> getOrder()
      Returns:
      Sort direction for the returned documents: asc (the default) or desc.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Root API key ONLY: resolve type's schema as this user would (basedOn-aware shadowing) instead of the shared base — mirrors GET /v1/schemas?recordType='s userId selector. Ignored for a scoped credential.

    • getScope

      public Optional<String> getScope()
      Returns:
      Root API key ONLY: resolve type's schema as this scope would, as a single namespace:value entry — mirrors GET /v1/schemas?recordType='s scope selector. Ignored for a scoped credential.

    • 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 LookupDocumentsRequest.TypeStage builder()