Package ai.vectros.types

Class EntityResponse

java.lang.Object
ai.vectros.types.EntityResponse
public final class EntityResponse extends Object

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new entity. True when a new entity was created; false when an entity with the same externalId already existed and was returned unchanged (idempotent create) or updated (when ?upsert=true). Present only on the create response; absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing entity was returned.

    • getId

      public Optional<String> getId()
      Returns:
      The Vectros-assigned ID (UUID) for this entity.

    • getNamespace

      public Optional<String> getNamespace()
      Returns:
      The namespace this entity belongs to.

    • getContextId

      public Optional<String> getContextId()
      Returns:
      The app context that owns this entity, or null for a TENANT-WIDE entity visible to every app context. Mirrors the owning namespace registration's contextId (see GET /v1/namespaces) — a context-owned namespace's entities all carry that same context.

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Your own identifier for this entity, as supplied when it was created.

    • getName

      public Optional<String> getName()
      Returns:
      Human-readable name of the entity.

    • getStatus

      public Optional<String> getStatus()
      Returns:
      Lifecycle status of the entity: ACTIVE or SUSPENDED.

    • getScopes

      public Optional<List<String>> getScopes()
      Returns:
      The entity's effective scopes: its own reference (<namespace>:<id>) followed by its parent edges. Use these values to reference the entity as an owner elsewhere.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Free-form key-value attributes stored with the entity.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      ID of the record schema governing this entity, or null if unbound.

    • getSchemaVersion

      public Optional<Integer> getSchemaVersion()
      Returns:
      The governing schema's version in effect when this entity was last written, or null when unbound.

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      Timestamp when the entity was created, as an ISO-8601 UTC timestamp.

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