Package ai.vectros.resources.documents.requests

Class LookupDocumentsRequest

java.lang.Object

ai.vectros.resources.documents.requests.LookupDocumentsRequest

public final class LookupDocumentsRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LookupDocumentsRequest._FinalStage
static final class	LookupDocumentsRequest.Builder
static interface	LookupDocumentsRequest.FieldStage
static interface	LookupDocumentsRequest.TypeStage

Method Summary

Modifier and Type	Method	Description
static LookupDocumentsRequest.TypeStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
String	getField()
Optional<String>	getFrom()
Optional<Long>	getLimit()
Optional<LookupDocumentsRequestOrder>	getOrder()
Optional<String>	getPrefix()
Optional<String>	getStartFrom()
Optional<String>	getTo()
String	getType()
Optional<String>	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.

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.

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