Class IdentityLookupRequest

java.lang.Object
ai.vectros.types.IdentityLookupRequest

public final class IdentityLookupRequest extends Object
  • Method Details

    • getType

      public String getType()
      Returns:
      The identity schema type whose lookup fields you are querying (for example, person_v1).
    • getField

      public String getField()
      Returns:
      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).
    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match. Mutually exclusive with from/to and prefix.
    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup (requires to; supported only on range-enabled, non-sensitive fields). 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 (supported only on range-enabled string fields). 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<Integer> getLimit()
      Returns:
      Maximum number of results to return per page (1–100; defaults to 20).
    • getOrder

      Returns:
      Sort direction for the returned results: asc (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 IdentityLookupRequest.TypeStage builder()