Package ai.vectros.resources.documents.requests

Class ListDocumentsRequest

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

  • Method Details

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Filter by owning user — the Vectros-assigned UUID of a user. To resolve from your own identifier, call GET /v1/users?externalId=.

    • getScope

      public Optional<String> getScope()
      Returns:
      Filter to documents carrying this scope value, in namespace:value form (a value is 1-128 chars: a letter or digit first, then letters, digits, _ or -) — for example group:eng-team, org:<id>, or client:<id>. Resolve an entity's UUID from your own identifier via GET /v1/entities/{namespace}?externalId=.

    • getFolderId

      public Optional<String> getFolderId()
      Returns:
      List only documents in this folder (the Vectros folder ID). Can be combined with the owner filters.

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

    • 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 ListDocumentsRequest.Builder builder()