Package ai.vectros.resources.records.requests

Class RecordLookupRequest

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

  • Method Details

    • getType

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

    • 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). For a lookup declared over several fields, give those field names joined with commas (status,area) and put the values in values.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match. Mutually exclusive with from/to, prefix and values. Sensitive fields can only be looked up by exact value, and only through this body variant. For a lookup over several fields, use values instead.

    • 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. Mutually exclusive with value; a single-element list is exactly value written uniformly.

      You may supply fewer values than the lookup declares, as long as they are a leading run of its fields: on a lookup over [status, area, owner] you can match status, or status and area, but never area alone. Supplying fewer values returns the records grouped by the fields you left unspecified; sortFrom/sortTo then need every value, because sorting is only continuous within one fully specified combination.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup (requires to; 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 (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 whose sort key is at or after this point. Use with value; may be combined 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 whose sort key is at or before this point. Use with value; may be combined with sortFrom.

    • 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 records to return per page (1–100; defaults to 20).

    • getOrder

      public Optional<RecordLookupRequestOrder> getOrder()
      Returns:
      Sort direction for the returned results: asc (default) or desc.

    • getIncludePayload

      public Optional<Boolean> getIncludePayload()
      Returns:
      When true, externalized record payloads are returned in full in this response (capped per page). Defaults to false, which returns only the indexed projection.

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