[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Introduced1 Changed1

DefinedEntity

Describes what a defined entity should look like.


Properties

map of object
entity Required

A JSON value representation. The JSON will be validated against the schema of the entityType that the entity is an instance of.


string
name Required

The name of the defined entity.


string
entityState Introduced Optional

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.

Added in 37.1

string
entityType Optional

The URN ID of the defined entity type that the entity is an instance of. This is a read-only field.


string
externalId Optional

An external entity’s id that this entity may have a relation to.


string
id Optional

The id of the defined entity in URN format.


org Optional

The organization of the defined entity.


owner Optional

The owner of the defined entity.


string
state Changed Optional

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_CREATEDRESOLVEDRESOLUTION_ERROR

Deprecated in 37.1

JSON Example

{
    "name": "vspheresddc1"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    org:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSortable
    owner:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSortable
[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 35.0
Property Of

InlineDefinedEntities1
Parameter To

Update Defined Entity
Create Defined Entity
Returned By

Get Defined Entity
Update Defined Entity
What's changed in v37.1?

INTRODUCED (1)

Added Properties
entityState
CHANGED (1)
Changed Properties
state

Feedback

Was this page helpful?