Package ai.vectros.types

Class EntityRequest

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

  • Method Details

    • getExternalId

      public String getExternalId()
      Returns:
      Your own unique identifier for this entity, unique within its namespace. Used for idempotent create: if an entity with this externalId already exists in the namespace, it is returned instead of creating a duplicate.

    • getName

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

    • getStatus

      public Optional<EntityRequestStatus> getStatus()
      Returns:
      Lifecycle status of the entity. ACTIVE entities can be used normally; SUSPENDED entities are retained but blocked from new operations.

    • getPayload

      public Optional<Map<String,Object>> getPayload()
      Returns:
      Free-form key-value attributes to store with the entity. On update, the supplied object replaces the stored payload in full (it is not key-merged); omit it to leave the stored payload unchanged.

    • getSchemaId

      public Optional<String> getSchemaId()
      Returns:
      Optional ID of a record schema (created via POST /v1/schemas) that governs payload validation and lookup indexing for this entity, and must belong to your account.

    • getScopes

      public Optional<List<String>> getScopes()
      Returns:
      The entity's parent ownership edges, each as <namespace>:<value> (for example org:6ba7b810-...). At most two parents, each in a DIFFERENT namespace from the entity's own. A <value> is 1-128 characters: a letter or digit first, then letters, digits, _ or -. On update, providing scopes REPLACES the full set of parents; omit it to leave ownership unchanged. The entity's own reference (<its namespace>:<its id>) is accepted and ignored, so you can send back the scopes you read from a GET unchanged; any OTHER value in its own namespace is rejected, because a parent edge always crosses namespaces — a value in this entity's own namespace names a peer, not a parent.

    • 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 EntityRequest.ExternalIdStage builder()