Package ai.vectros.resources.identity.requests

Class ListEntitiesRequest

java.lang.Object
ai.vectros.resources.identity.requests.ListEntitiesRequest
public final class ListEntitiesRequest extends Object

  • Method Details

    • getContextId

      public Optional<String> getContextId()
      Returns:
      Which app context to read from. Required when the namespace is context-placed and rejected otherwise: a tenant-placed namespace's entities are shared by every context, so there is nothing to name. A context-placed namespace's entities belong to exactly one context and are invisible from the others — the same externalId may name a different entity in each. A context-confined credential may only name its own context.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Return only entities owned by this user (Vectros user ID).

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Look up an entity by your own identifier. Returns a list with the single match, or empty.

    • getScope

      public Optional<String> getScope()
      Returns:
      Filter by parent edge as <namespace>:<value> (e.g. org:6ba7...). Matches any of the entity's parents, not just its first. Naming this route's own namespace resolves the entity itself.

    • getType

      public Optional<String> getType()
      Returns:
      Schema record type whose lookup fields you want to query. Supply with field and one lookup mode (value, from/to, or prefix).

    • getField

      public Optional<String> getField()
      Returns:
      The schema-declared lookup field to filter on. Supply with type and one lookup mode.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match for field (equality). Not allowed for a sensitive field — use POST /v1/entities/{namespace}/lookup.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup (requires to; range-enabled fields).

    • getTo

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

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Match all values of field starting with this prefix (range-enabled string fields).

    • getOrder

      public Optional<ListEntitiesRequestOrder> getOrder()
      Returns:
      Sort direction by the field's value for a type/field lookup: asc (ascending, the default) or desc. Lookup mode only — listing by namespace, userId, scope, or externalId does not take a sort direction and rejects this parameter.

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

    • 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 ListEntitiesRequest.Builder builder()