Package ai.vectros.resources.documents.requests

Class ListDocumentsRequest.Builder

java.lang.Object

ai.vectros.resources.documents.requests.ListDocumentsRequest.Builder

Enclosing class:

ListDocumentsRequest

public static final class ListDocumentsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListDocumentsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
ListDocumentsRequest.Builder	additionalProperty(String key, Object value)
ListDocumentsRequest	build()
ListDocumentsRequest.Builder	folderId(String folderId)
ListDocumentsRequest.Builder	folderId(Optional<String> folderId)	List only documents in this folder (the Vectros folder ID).
ListDocumentsRequest.Builder	from(ListDocumentsRequest other)
ListDocumentsRequest.Builder	limit(Long limit)
ListDocumentsRequest.Builder	limit(Optional<Long> limit)	Maximum number of documents to return per page (1-100; defaults to 20).
ListDocumentsRequest.Builder	scope(String scope)
ListDocumentsRequest.Builder	scope(Optional<String> scope)	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>.
ListDocumentsRequest.Builder	startFrom(String startFrom)
ListDocumentsRequest.Builder	startFrom(Optional<String> startFrom)	Pagination cursor.
ListDocumentsRequest.Builder	userId(String userId)
ListDocumentsRequest.Builder	userId(Optional<String> userId)	Filter by owning user — the Vectros-assigned UUID of a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public ListDocumentsRequest.Builder from(ListDocumentsRequest other)

userId

public ListDocumentsRequest.Builder userId(Optional<String> userId)

Filter by owning user — the Vectros-assigned UUID of a user. To resolve from your own identifier, call GET /v1/users?externalId=.

userId

public ListDocumentsRequest.Builder userId(String userId)

scope

public ListDocumentsRequest.Builder scope(Optional<String> scope)

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=.

scope

public ListDocumentsRequest.Builder scope(String scope)

folderId

public ListDocumentsRequest.Builder folderId(Optional<String> folderId)

List only documents in this folder (the Vectros folder ID). Can be combined with the owner filters.

folderId

public ListDocumentsRequest.Builder folderId(String folderId)

startFrom

public ListDocumentsRequest.Builder startFrom(Optional<String> startFrom)

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.

startFrom

public ListDocumentsRequest.Builder startFrom(String startFrom)

limit

public ListDocumentsRequest.Builder limit(Optional<Long> limit)

Maximum number of documents to return per page (1-100; defaults to 20).

limit

public ListDocumentsRequest.Builder limit(Long limit)

build

public ListDocumentsRequest build()

additionalProperty

public ListDocumentsRequest.Builder additionalProperty(String key,
 Object value)

additionalProperties

public ListDocumentsRequest.Builder additionalProperties(Map<String,Object> additionalProperties)