Package ai.vectros.resources.records.requests

Class LookupRecordsRequest

java.lang.Object
ai.vectros.resources.records.requests.LookupRecordsRequest
public final class LookupRecordsRequest extends Object

  • Method Details

    • getValues

      public Optional<List<String>> getValues()
      Returns:
      Exact values to match, for a lookup declared over several fields — one value per field, in the order the lookup declares them, given as a repeated parameter (?field=status,area&values=open&values=billing). Mutually exclusive with value; a single values is identical to value.

      You may supply fewer values than the lookup declares, as long as they are a leading run of its fields; doing so returns the records grouped by the fields you left unspecified. Narrowing with sortFrom/sortTo then requires a value for every field, because the ordering is only continuous within one fully specified combination.

    • getType

      public String getType()
      Returns:
      The record type to look up, e.g. intake_form.

    • getField

      public String getField()
      Returns:
      The name of the lookup field to match on, as declared on the type's schema.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match. Mutually exclusive with from/to, prefix and values. Rejected for a sensitive field — use POST /v1/records/lookup instead so the value is not exposed in the URL.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound of a range lookup (requires to; non-sensitive fields only). Mutually exclusive with value and prefix.

    • getTo

      public Optional<String> getTo()
      Returns:
      Inclusive upper bound of a range lookup (requires from).

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Prefix to match (string, non-sensitive fields only). Mutually exclusive with value and from/to.

    • getSortFrom

      public Optional<String> getSortFrom()
      Returns:
      Inclusive lower bound on the lookup field's sort key, narrowing a value match to records at or after this point. Use with value; combine with sortTo to bound both ends. Give the bound in the same form as the sorted field's own values — epoch milliseconds when the lookup sorts by createdAt or lastUpdated. Records with no value for the sorted field are never included in a bounded window.

    • getSortTo

      public Optional<String> getSortTo()
      Returns:
      Inclusive upper bound on the lookup field's sort key, narrowing a value match to records at or before this point. Use with value; combine with sortFrom.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      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.

    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of records to return per page. Allowed range 1–100; defaults to 20.

    • getIncludePayload

      public Optional<String> getIncludePayload()
      Returns:
      Set to true to include each record's full payload, rehydrating any payloads stored externally (capped per page). Defaults to false, which returns only the indexed projection.

    • getOrder

      public Optional<LookupRecordsRequestOrder> getOrder()
      Returns:
      Sort direction by the field's value: asc (ascending, the default) or desc (descending).

    • 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 LookupRecordsRequest.TypeStage builder()