Interface EntityRequest._FinalStage
- All Known Implementing Classes:
EntityRequest.Builder
- Enclosing class:
EntityRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()Human-readable name for the entity.Free-form key-value attributes to store with the entity.Optional ID of a record schema (created viaPOST /v1/schemas) that governs payload validation and lookup indexing for this entity, and must belong to your account.The entity's parent ownership edges, each as<namespace>:<value>(for exampleorg:6ba7b810-...).status(EntityRequestStatus status) status(Optional<EntityRequestStatus> status) Lifecycle status of the entity.
-
Method Details
-
build
EntityRequest build() -
additionalProperty
-
additionalProperties
-
name
Human-readable name for the entity.
-
name
-
status
Lifecycle status of the entity.
ACTIVEentities can be used normally;SUSPENDEDentities are retained but blocked from new operations. -
status
-
payload
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.
-
payload
-
schemaId
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. -
schemaId
-
scopes
The entity's parent ownership edges, each as
<namespace>:<value>(for exampleorg:6ba7b810-...). At most two parents, each in a DIFFERENT namespace from the entity's own. On update, providingscopesREPLACES 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 thescopesyou 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. -
scopes
-