Package ai.vectros.types

Class EntityResponse.Builder

java.lang.Object

ai.vectros.types.EntityResponse.Builder

Enclosing class:

EntityResponse

public static final class EntityResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
EntityResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
EntityResponse.Builder	additionalProperty(String key, Object value)
EntityResponse	build()
EntityResponse.Builder	contextId(String contextId)
EntityResponse.Builder	contextId(Optional<String> contextId)	The app context that owns this entity, or null for a TENANT-WIDE entity visible to every app context.
EntityResponse.Builder	created(Boolean created)
EntityResponse.Builder	created(Optional<Boolean> created)	Whether this call created a new entity.
EntityResponse.Builder	createdAt(String createdAt)
EntityResponse.Builder	createdAt(Optional<String> createdAt)	Timestamp when the entity was created, as an ISO-8601 UTC timestamp.
EntityResponse.Builder	externalId(String externalId)
EntityResponse.Builder	externalId(Optional<String> externalId)	Your own identifier for this entity, as supplied when it was created.
EntityResponse.Builder	from(EntityResponse other)
EntityResponse.Builder	id(String id)
EntityResponse.Builder	id(Optional<String> id)	The Vectros-assigned ID (UUID) for this entity.
EntityResponse.Builder	name(String name)
EntityResponse.Builder	name(Optional<String> name)	Human-readable name of the entity.
EntityResponse.Builder	namespace(String namespace)
EntityResponse.Builder	namespace(Optional<String> namespace)	The namespace this entity belongs to.
EntityResponse.Builder	payload(Map<String,Object> payload)
EntityResponse.Builder	payload(Optional<Map<String,Object>> payload)	Free-form key-value attributes stored with the entity.
EntityResponse.Builder	schemaId(String schemaId)
EntityResponse.Builder	schemaId(Optional<String> schemaId)	ID of the record schema governing this entity, or null if unbound.
EntityResponse.Builder	schemaVersion(Integer schemaVersion)
EntityResponse.Builder	schemaVersion(Optional<Integer> schemaVersion)	The governing schema's version in effect when this entity was last written, or null when unbound.
EntityResponse.Builder	scopes(List<String> scopes)
EntityResponse.Builder	scopes(Optional<List<String>> scopes)	The entity's effective scopes: its own reference (<namespace>:<id>) followed by its parent edges.
EntityResponse.Builder	status(String status)
EntityResponse.Builder	status(Optional<String> status)	Lifecycle status of the entity: ACTIVE or SUSPENDED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public EntityResponse.Builder from(EntityResponse other)

created

public EntityResponse.Builder created(Optional<Boolean> created)

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.

created

public EntityResponse.Builder created(Boolean created)

id

public EntityResponse.Builder id(Optional<String> id)

The Vectros-assigned ID (UUID) for this entity.

id

public EntityResponse.Builder id(String id)

namespace

public EntityResponse.Builder namespace(Optional<String> namespace)

The namespace this entity belongs to.

namespace

public EntityResponse.Builder namespace(String namespace)

contextId

public EntityResponse.Builder contextId(Optional<String> contextId)

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.

contextId

public EntityResponse.Builder contextId(String contextId)

externalId

public EntityResponse.Builder externalId(Optional<String> externalId)

Your own identifier for this entity, as supplied when it was created.

externalId

public EntityResponse.Builder externalId(String externalId)

name

public EntityResponse.Builder name(Optional<String> name)

Human-readable name of the entity.

name

public EntityResponse.Builder name(String name)

status

public EntityResponse.Builder status(Optional<String> status)

Lifecycle status of the entity: ACTIVE or SUSPENDED.

status

public EntityResponse.Builder status(String status)

scopes

public EntityResponse.Builder scopes(Optional<List<String>> scopes)

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.

scopes

public EntityResponse.Builder scopes(List<String> scopes)

payload

public EntityResponse.Builder payload(Optional<Map<String,Object>> payload)

Free-form key-value attributes stored with the entity.

payload

public EntityResponse.Builder payload(Map<String,Object> payload)

schemaId

public EntityResponse.Builder schemaId(Optional<String> schemaId)

ID of the record schema governing this entity, or null if unbound.

schemaId

public EntityResponse.Builder schemaId(String schemaId)

schemaVersion

public EntityResponse.Builder schemaVersion(Optional<Integer> schemaVersion)

The governing schema's version in effect when this entity was last written, or null when unbound.

schemaVersion

public EntityResponse.Builder schemaVersion(Integer schemaVersion)

createdAt

public EntityResponse.Builder createdAt(Optional<String> createdAt)

Timestamp when the entity was created, as an ISO-8601 UTC timestamp.

createdAt

public EntityResponse.Builder createdAt(String createdAt)

build

public EntityResponse build()

additionalProperty

public EntityResponse.Builder additionalProperty(String key,
 Object value)

additionalProperties

public EntityResponse.Builder additionalProperties(Map<String,Object> additionalProperties)