Package ai.vectros.resources.documents.requests

Class LookupDocumentsRequest.Builder

java.lang.Object

ai.vectros.resources.documents.requests.LookupDocumentsRequest.Builder

All Implemented Interfaces:

LookupDocumentsRequest._FinalStage, LookupDocumentsRequest.FieldStage, LookupDocumentsRequest.TypeStage

Enclosing class:

LookupDocumentsRequest

public static final class LookupDocumentsRequest.Builder
extends Object
implements LookupDocumentsRequest.TypeStage, LookupDocumentsRequest.FieldStage, LookupDocumentsRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
LookupDocumentsRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
LookupDocumentsRequest.Builder	additionalProperty(String key, Object value)
LookupDocumentsRequest	build()
LookupDocumentsRequest._FinalStage	field(@NotNull String field)	The name of the lookup field declared on the schema.
LookupDocumentsRequest.Builder	from(LookupDocumentsRequest other)
LookupDocumentsRequest._FinalStage	from(String from)	Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only).
LookupDocumentsRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only).
LookupDocumentsRequest._FinalStage	limit(Long limit)	Maximum number of documents to return per page (1-100; defaults to 20).
LookupDocumentsRequest._FinalStage	limit(Optional<Long> limit)	Maximum number of documents to return per page (1-100; defaults to 20).
LookupDocumentsRequest._FinalStage	order(LookupDocumentsRequestOrder order)	Sort direction for the returned documents: asc (the default) or desc.
LookupDocumentsRequest._FinalStage	order(Optional<LookupDocumentsRequestOrder> order)	Sort direction for the returned documents: asc (the default) or desc.
LookupDocumentsRequest._FinalStage	prefix(String prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
LookupDocumentsRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match for a prefix lookup (range-enabled string fields only).
LookupDocumentsRequest._FinalStage	startFrom(String startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
LookupDocumentsRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
LookupDocumentsRequest._FinalStage	to(String to)	Inclusive upper bound for a range lookup (requires from).
LookupDocumentsRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
LookupDocumentsRequest.FieldStage	type(@NotNull String type)	The document type to look up (the type of the bound schema).
LookupDocumentsRequest._FinalStage	value(String value)	Exact value to match.
LookupDocumentsRequest._FinalStage	value(Optional<String> value)	Exact value to match.

Methods inherited from class java.lang.Object

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

Method Details

from

public LookupDocumentsRequest.Builder from(LookupDocumentsRequest other)

Specified by:

from in interface LookupDocumentsRequest.TypeStage

type

public LookupDocumentsRequest.FieldStage type(@NotNull
 @NotNull String type)

The document type to look up (the type of the bound schema).

The document type to look up (the type of the bound schema).

Specified by:

type in interface LookupDocumentsRequest.TypeStage

Returns:

Reference to this so that method calls can be chained together.

field

public LookupDocumentsRequest._FinalStage field(@NotNull
 @NotNull String field)

The name of the lookup field declared on the schema.

The name of the lookup field declared on the schema.

Specified by:

field in interface LookupDocumentsRequest.FieldStage

Returns:

Reference to this so that method calls can be chained together.

order

public LookupDocumentsRequest._FinalStage order(LookupDocumentsRequestOrder order)

Sort direction for the returned documents: asc (the default) or desc.

Specified by:

order in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

order

public LookupDocumentsRequest._FinalStage order(Optional<LookupDocumentsRequestOrder> order)

Sort direction for the returned documents: asc (the default) or desc.

Specified by:

order in interface LookupDocumentsRequest._FinalStage

limit

public LookupDocumentsRequest._FinalStage limit(Long limit)

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

Specified by:

limit in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

limit

public LookupDocumentsRequest._FinalStage limit(Optional<Long> limit)

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

Specified by:

limit in interface LookupDocumentsRequest._FinalStage

startFrom

public LookupDocumentsRequest._FinalStage startFrom(String startFrom)

Pagination cursor — pass the nextCursor returned by the previous page.

Specified by:

startFrom in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

startFrom

public LookupDocumentsRequest._FinalStage startFrom(Optional<String> startFrom)

Pagination cursor — pass the nextCursor returned by the previous page.

Specified by:

startFrom in interface LookupDocumentsRequest._FinalStage

prefix

public LookupDocumentsRequest._FinalStage prefix(String prefix)

Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

Specified by:

prefix in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

prefix

public LookupDocumentsRequest._FinalStage prefix(Optional<String> prefix)

Prefix to match for a prefix lookup (range-enabled string fields only). Mutually exclusive with value and from/to.

Specified by:

prefix in interface LookupDocumentsRequest._FinalStage

to

public LookupDocumentsRequest._FinalStage to(String to)

Inclusive upper bound for a range lookup (requires from).

Specified by:

to in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

to

public LookupDocumentsRequest._FinalStage to(Optional<String> to)

Inclusive upper bound for a range lookup (requires from).

Specified by:

to in interface LookupDocumentsRequest._FinalStage

from

public LookupDocumentsRequest._FinalStage from(String from)

Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only). Mutually exclusive with value and prefix.

Specified by:

from in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

from

public LookupDocumentsRequest._FinalStage from(Optional<String> from)

Inclusive lower bound for a range lookup (requires to; range-enabled, non-sensitive fields only). Mutually exclusive with value and prefix.

Specified by:

from in interface LookupDocumentsRequest._FinalStage

value

public LookupDocumentsRequest._FinalStage value(String value)

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.

Specified by:

value in interface LookupDocumentsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

value

public LookupDocumentsRequest._FinalStage value(Optional<String> value)

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.

Specified by:

value in interface LookupDocumentsRequest._FinalStage

build

public LookupDocumentsRequest build()

Specified by:

build in interface LookupDocumentsRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface LookupDocumentsRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface LookupDocumentsRequest._FinalStage