/** * The Entity model module. * @module Ntnx/Entity * @version 4.3.1 * @class Entity * @extends EntityBaseModel */ export default class Entity extends EntityBaseModel { /** * Returns A human-readable description of the LCM entity, providing additional context about the component. * @return {string} */ getEntityDescription(): string; /** * Sets A human-readable description of the LCM entity, providing additional context about the component. * @param {string} entityDescription A human-readable description of the LCM entity, providing additional context about the component. */ setEntityDescription(entityDescription: string): void; entityDescription: string; /** * @return {LocationInfo} */ getLocationInfo(): LocationInfo; /** * @param {LocationInfo} locationInfo */ setLocationInfo(locationInfo: LocationInfo): void; locationInfo: LocationInfo; /** * Returns The target version that this entity has been selected to upgrade to. This field is set when an upgrade selection or upgrade operation has designated a specific version for this entity. Unset if no upgrade target has been chosen. * @return {string} */ getTargetVersion(): string; /** * Sets The target version that this entity has been selected to upgrade to. This field is set when an upgrade selection or upgrade operation has designated a specific version for this entity. Unset if no upgrade target has been chosen. * @param {string} targetVersion The target version that this entity has been selected to upgrade to. This field is set when an upgrade selection or upgrade operation has designated a specific version for this entity. Unset if no upgrade target has been chosen. */ setTargetVersion(targetVersion: string): void; targetVersion: string; /** * Returns The UTC date and time (in RFC-3339 format) when the task was last updated. * @return {Date} */ getLastUpdatedTime(): Date; /** * Sets The UTC date and time (in RFC-3339 format) when the task was last updated. * @param {Date} lastUpdatedTime The UTC date and time (in RFC-3339 format) when the task was last updated. */ setLastUpdatedTime(lastUpdatedTime: Date): void; lastUpdatedTime: Date; /** * Returns A unique device identifier for the entity, such as a hard drive serial number, NIC serial number, or other hardware-specific identifier. * @return {string} */ getDeviceId(): string; /** * Sets A unique device identifier for the entity, such as a hard drive serial number, NIC serial number, or other hardware-specific identifier. * @param {string} deviceId A unique device identifier for the entity, such as a hard drive serial number, NIC serial number, or other hardware-specific identifier. */ setDeviceId(deviceId: string): void; deviceId: string; /** * Returns UUID of the entity group that this entity belongs to. Entities in the same group are logically related and may share upgrade dependencies or ordering constraints. * @return {string} */ getGroupUuid(): string; /** * Sets UUID of the entity group that this entity belongs to. Entities in the same group are logically related and may share upgrade dependencies or ordering constraints. * @param {string} groupUuid UUID of the entity group that this entity belongs to. Entities in the same group are logically related and may share upgrade dependencies or ordering constraints. */ setGroupUuid(groupUuid: string): void; groupUuid: string; /** * Returns Additional key-value metadata specific to the entity type. For example, firmware entities may include NIC vendor, slot number, or PCI address information. * @return {KVPair[]} */ getEntityDetails(): KVPair[]; /** * Sets Additional key-value metadata specific to the entity type. For example, firmware entities may include NIC vendor, slot number, or PCI address information. * @param {KVPair[]} entityDetails Additional key-value metadata specific to the entity type. For example, firmware entities may include NIC vendor, slot number, or PCI address information. */ setEntityDetails(entityDetails: KVPair[]): void; entityDetails: KVPair[]; /** * Returns Component information for payload-based entities. Lists the child entity identifiers that are bundled within this entity's upgrade payload. * @return {string[]} */ getChildEntities(): string[]; /** * Sets Component information for payload-based entities. Lists the child entity identifiers that are bundled within this entity's upgrade payload. * @param {string[]} childEntities Component information for payload-based entities. Lists the child entity identifiers that are bundled within this entity's upgrade payload. */ setChildEntities(childEntities: string[]): void; childEntities: string[]; /** * Returns List of available versions that this entity can be upgraded to. Each entry includes the version string, status, enablement state, dependencies, and release notes. Empty if no updates are available. * @return {AvailableVersion[]} */ getAvailableVersions(): AvailableVersion[]; /** * Sets List of available versions that this entity can be upgraded to. Each entry includes the version string, status, enablement state, dependencies, and release notes. Empty if no updates are available. * @param {AvailableVersion[]} availableVersions List of available versions that this entity can be upgraded to. Each entry includes the version string, status, enablement state, dependencies, and release notes. Empty if no updates are available. */ setAvailableVersions(availableVersions: AvailableVersion[]): void; availableVersions: AvailableVersion[]; /** * Returns A list of sub-entities associated with this entity. Sub-entities represent components that are logically part of the parent entity (e.g. individual firmware components within a composite firmware entity). * @return {EntityBaseModel[]} */ getSubEntities(): EntityBaseModel[]; /** * Sets A list of sub-entities associated with this entity. Sub-entities represent components that are logically part of the parent entity (e.g. individual firmware components within a composite firmware entity). * @param {EntityBaseModel[]} subEntities A list of sub-entities associated with this entity. Sub-entities represent components that are logically part of the parent entity (e.g. individual firmware components within a composite firmware entity). */ setSubEntities(subEntities: EntityBaseModel[]): void; subEntities: EntityBaseModel[]; /** * Returns The cluster UUID on which the resource is present or the operation is being performed. * @return {string} */ getClusterExtId(): string; /** * Sets The cluster UUID on which the resource is present or the operation is being performed. * @param {string} clusterExtId The cluster UUID on which the resource is present or the operation is being performed. */ setClusterExtId(clusterExtId: string): void; clusterExtId: string; /** * Returns The hardware vendor of the cluster (e.g. \"Dell\", \"HPE\", \"Lenovo\"). * @return {string} */ getHardwareVendor(): string; /** * Sets The hardware vendor of the cluster (e.g. \"Dell\", \"HPE\", \"Lenovo\"). * @param {string} hardwareVendor The hardware vendor of the cluster (e.g. \"Dell\", \"HPE\", \"Lenovo\"). */ setHardwareVendor(hardwareVendor: string): void; hardwareVendor: string; /** * Returns Indicates whether the most recent inventory operation failed for this entity. When true, the entity's version or available-version data may be stale. Re-run inventory (POST /$actions/inventory) to refresh. * @return {boolean} */ getHasPreviousInventoryFailed(): boolean; /** * Sets Indicates whether the most recent inventory operation failed for this entity. When true, the entity's version or available-version data may be stale. Re-run inventory (POST /$actions/inventory) to refresh. * @param {boolean} hasPreviousInventoryFailed Indicates whether the most recent inventory operation failed for this entity. When true, the entity's version or available-version data may be stale. Re-run inventory (POST /$actions/inventory) to refresh. */ setHasPreviousInventoryFailed(hasPreviousInventoryFailed: boolean): void; hasPreviousInventoryFailed: boolean; #private; } import EntityBaseModel from "../common/EntityBaseModel"; import LocationInfo from "../common/LocationInfo"; import KVPair from "../../../common/v1/config/KVPair"; import AvailableVersion from "./AvailableVersion";