Package ai.vectros.types

Class IdentityLookupRequest.Builder

java.lang.Object

ai.vectros.types.IdentityLookupRequest.Builder

All Implemented Interfaces:

IdentityLookupRequest._FinalStage, IdentityLookupRequest.FieldStage, IdentityLookupRequest.TypeStage

Enclosing class:

IdentityLookupRequest

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

Method Summary

Modifier and Type	Method	Description
IdentityLookupRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
IdentityLookupRequest.Builder	additionalProperty(String key, Object value)
IdentityLookupRequest	build()
IdentityLookupRequest._FinalStage	field(@NotNull String field)	Name of the lookup field declared on the schema.
IdentityLookupRequest.Builder	from(IdentityLookupRequest other)
IdentityLookupRequest._FinalStage	from(String from)	Inclusive lower bound for a range lookup (requires to; supported only on range-enabled, non-sensitive fields).
IdentityLookupRequest._FinalStage	from(Optional<String> from)	Inclusive lower bound for a range lookup (requires to; supported only on range-enabled, non-sensitive fields).
IdentityLookupRequest._FinalStage	limit(Integer limit)	Maximum number of results to return per page (1–100; defaults to 20).
IdentityLookupRequest._FinalStage	limit(Optional<Integer> limit)	Maximum number of results to return per page (1–100; defaults to 20).
IdentityLookupRequest._FinalStage	order(IdentityLookupRequestOrder order)	Sort direction for the returned results: asc (default) or desc.
IdentityLookupRequest._FinalStage	order(Optional<IdentityLookupRequestOrder> order)	Sort direction for the returned results: asc (default) or desc.
IdentityLookupRequest._FinalStage	prefix(String prefix)	Prefix to match (supported only on range-enabled string fields).
IdentityLookupRequest._FinalStage	prefix(Optional<String> prefix)	Prefix to match (supported only on range-enabled string fields).
IdentityLookupRequest._FinalStage	startFrom(String startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
IdentityLookupRequest._FinalStage	startFrom(Optional<String> startFrom)	Pagination cursor — pass the nextCursor returned by the previous page.
IdentityLookupRequest._FinalStage	to(String to)	Inclusive upper bound for a range lookup (requires from).
IdentityLookupRequest._FinalStage	to(Optional<String> to)	Inclusive upper bound for a range lookup (requires from).
IdentityLookupRequest.FieldStage	type(@NotNull String type)	The identity schema type whose lookup fields you are querying (for example, person_v1).
IdentityLookupRequest._FinalStage	value(String value)	Exact value to match.
IdentityLookupRequest._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 IdentityLookupRequest.Builder from(IdentityLookupRequest other)

Specified by:

from in interface IdentityLookupRequest.TypeStage

type

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

The identity schema type whose lookup fields you are querying (for example, person_v1).

The identity schema type whose lookup fields you are querying (for example, person_v1).

Specified by:

type in interface IdentityLookupRequest.TypeStage

Returns:

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

field

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

Name of the lookup field declared on the schema. For a field marked sensitive, this body variant is required (the GET variant rejects looking up by a sensitive value).

Name of the lookup field declared on the schema. For a field marked sensitive, this body variant is required (the GET variant rejects looking up by a sensitive value).

Specified by:

field in interface IdentityLookupRequest.FieldStage

Returns:

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

order

public IdentityLookupRequest._FinalStage order(IdentityLookupRequestOrder order)

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

Specified by:

order in interface IdentityLookupRequest._FinalStage

Returns:

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

order

public IdentityLookupRequest._FinalStage order(Optional<IdentityLookupRequestOrder> order)

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

Specified by:

order in interface IdentityLookupRequest._FinalStage

limit

public IdentityLookupRequest._FinalStage limit(Integer limit)

Maximum number of results to return per page (1–100; defaults to 20).

Specified by:

limit in interface IdentityLookupRequest._FinalStage

Returns:

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

limit

public IdentityLookupRequest._FinalStage limit(Optional<Integer> limit)

Maximum number of results to return per page (1–100; defaults to 20).

Specified by:

limit in interface IdentityLookupRequest._FinalStage

startFrom

public IdentityLookupRequest._FinalStage startFrom(String startFrom)

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

Specified by:

startFrom in interface IdentityLookupRequest._FinalStage

Returns:

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

startFrom

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

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

Specified by:

startFrom in interface IdentityLookupRequest._FinalStage

prefix

public IdentityLookupRequest._FinalStage prefix(String prefix)

Prefix to match (supported only on range-enabled string fields). Mutually exclusive with value and from/to.

Specified by:

prefix in interface IdentityLookupRequest._FinalStage

Returns:

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

prefix

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

Prefix to match (supported only on range-enabled string fields). Mutually exclusive with value and from/to.

Specified by:

prefix in interface IdentityLookupRequest._FinalStage

to

public IdentityLookupRequest._FinalStage to(String to)

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

Specified by:

to in interface IdentityLookupRequest._FinalStage

Returns:

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

to

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

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

Specified by:

to in interface IdentityLookupRequest._FinalStage

from

public IdentityLookupRequest._FinalStage from(String from)

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

Specified by:

from in interface IdentityLookupRequest._FinalStage

Returns:

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

from

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

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

Specified by:

from in interface IdentityLookupRequest._FinalStage

value

public IdentityLookupRequest._FinalStage value(String value)

Exact value to match. Mutually exclusive with from/to and prefix.

Specified by:

value in interface IdentityLookupRequest._FinalStage

Returns:

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

value

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

Exact value to match. Mutually exclusive with from/to and prefix.

Specified by:

value in interface IdentityLookupRequest._FinalStage

build

public IdentityLookupRequest build()

Specified by:

build in interface IdentityLookupRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface IdentityLookupRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface IdentityLookupRequest._FinalStage