Class ListFoldersRequest

java.lang.Object
ai.vectros.resources.folders.requests.ListFoldersRequest

public final class ListFoldersRequest extends Object
  • Method Details

    • getParentFolderId

      public Optional<String> getParentFolderId()
      Returns:
      List only the direct children of this folder — the Vectros-assigned UUID of a folder — for tree navigation. Omit for a flat list across your account.
    • getUserId

      public Optional<String> getUserId()
      Returns:
      Filter to folders owned by this user — the Vectros-assigned UUID of a user. Use GET /v1/users?externalId= to resolve your own external ID to this UUID.
    • getScope

      public Optional<String> getScope()
      Returns:
      Filter to folders 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=.
    • 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 folders to return per page. Must be between 1 and 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 ListFoldersRequest.Builder builder()