DefinedEntity
Describes what a defined entity should look like.
Properties
A JSON value representation. The JSON will be validated against the schema of the entityType that the entity is an instance of.
The name of the defined entity.
The “entityState” field may have the following values: “PRE_CREATED”, “RESOLVED”, “RESOLUTION_ERROR”, “IN_DELETION”. Every entity is created in the “PRE_CREATED” state. Once an entity is ready to be validated against its schema, it will transition in another state - “RESOLVED”, if the entity is valid according to the schema, or “RESOLUTION_ERROR” otherwise. If an entity in an “RESOLUTION_ERROR” state is updated, it will transition to the initial “PRE_CREATED” state without performing any validation. If its in the “RESOLVED” state, then it will be validated against the entity type schema and throw an exception if its invalid. Once an entity is ready to be deleted, if any external resources need to be cleaned up, the entity deletion process can be set up into multiple stages. The entity will transition into state IN_DELETION when the finalization process starts and will be permanently deleted once it completes successfully. If the finalization is not successful, the entity will once it completes successfully. If the finalization is not successful, the entity will remain in IN_DELETION state.
The URN ID of the defined entity type that the entity is an instance of. This is a read-only field.
An external entity’s id that this entity may have a relation to.
The id of the defined entity in URN format.
Every entity is created in the “PRE_CREATED” state. Once an entity is ready to be validated against its schema, it will transition in another state - RESOLVED, if the entity is valid according to the schema, or RESOLUTION_ERROR otherwise. If an entity in an “RESOLUTION_ERROR” state is updated, it will transition to the initial “PRE_CREATED” state without performing any validation. If its in the “RESOLVED” state, then it will be validated against the entity type schema and throw an exception if its invalid.
Possible values are: PRE_CREATED , RESOLVED , RESOLUTION_ERROR
JSON Example
{
"name": "vspheresddc1"
}
Vendor Extensions
x-vcloud-property-annotations:
org:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
owner:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
Availability
Property Of
InlineDefinedEntities1
Parameter To
Update Defined Entity
Create Defined Entity
Returned By
Get Defined Entity
Update Defined Entity
