VappTemplate

Hierarchy

Entity
- VappTemplate

Index

Constructors

constructor

Methods

Constructors

constructor

new VappTemplate(_json: VappTemplateJson): VappTemplate

Overrides Entity.constructor
- Defined in model/vapp-template/vapp-template.ts:21
Parameters
- _json: VappTemplateJson
Returns VappTemplate

Accessors

catalogUuid

catalogUuid:

Get VappTemplate catalog uuid

companyId

companyId:

Gets the ID of the company that the entity belongs to.

createdDate

createdDate:

Get VappTemplate creation date

deleted

deleted:

Indicates whether the entity is deleted.

deletedDate

deletedDate:

Gets the date that the entity was deleted, or null if it is not deleted.

description

description:

Get VappTemplate description

entityType

entityType:

Get VappTemplate entity type.

isCustomisable

isCustomisable:

Indicate whether the VappTemplate is customisable or not.

isCustomizationRequired

isCustomizationRequired:

Indicate whether the VappTemplate customization is required or not.

isExpired

isExpired:

Indicate whether the VappTemplate is expired or not.

isGoldMaster

isGoldMaster:

Indicate whether the VappTemplate is gold master or not.

isPublic

isPublic:

Indicate whether the VappTemplate is public or not.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Get VappTemplate location ID

name

name:

Gets the name.

orgUuid

orgUuid:

Get VappTemplate org uuid

size

size:

Get VappTemplate size.

status

status:

Get VappTemplate status

storageProfileUuid

storageProfileUuid:

Get VappTemplate storage profile uuid.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vcloudHref

vcloudHref:

Get VappTemplate vCloudHref.

vdcUuid

vdcUuid:

Get VappTemplate vDc uuid

vmTemplates

vmTemplates:

Get vm templates.

Methods

deleteMetadata

deleteMetadata(key: string): Promise<Task>

- Defined in model/vapp-template/vapp-template.ts:325
Delete a specific piece of metadata associated with a vapp template by its key.

Parameters
- key: string
  
  metadata key
Returns Promise<Task>

promise Promise that resolves with a Task

deleteVappTemplate

deleteVappTemplate(): Promise<Task>

- Defined in model/vapp-template/vapp-template.ts:221
Delete a Vapp template.

Returns Promise<Task>

enableVappTemplateDownload

enableVappTemplateDownload(): Promise<Task>

- Defined in model/vapp-template/vapp-template.ts:257
Enable the download of the vapp template. Returns a CoreTask which monitors the progress of the download.

Returns Promise<Task>

promise Promise that resolves with a Task

getDownloadDetails

getDownloadDetails(): Promise<VappTemplateDownloadDetails>

- Defined in model/vapp-template/vapp-template.ts:272
Gets download details for the vApp Template. Details include whether the template is enabled for download, and, if enabled, the size and name of the download.

Returns Promise<VappTemplateDownloadDetails>

promise Promise that resolves with VappTemplateDownloadDetails

getMetadata

getMetadata(): Promise<Array<Metadata<MetadataType>>>

- Defined in model/vapp-template/vapp-template.ts:284
Gets the vApp Template's metadata.

Returns Promise<Array<Metadata<MetadataType>>>

promise Promise that resolves with a list of Metadata

getVappTemplateConfiguration

getVappTemplateConfiguration(): Promise<VappTemplateConfiguration>

- Defined in model/vapp-template/vapp-template.ts:245
Retrieve a vApp Template's detailed configuration.

Returns Promise<VappTemplateConfiguration>

promise Promise that resolves with VappTemplateConfiguration

getVappTemplateVms

getVappTemplateVms(): Promise<Array<VappTemplateVm>>

- Defined in model/vapp-template/vapp-template.ts:233
Retrieve a vApp Template's VMs.

Returns Promise<Array<VappTemplateVm>>

promise Promise that resolves with a list of VappTemplateVm

refresh

refresh(): Promise<VappTemplate>

- Defined in model/vapp-template/vapp-template.ts:195
Refreshes the VappTemplate data by retrieving it from the API again.

Returns Promise<VappTemplate>

promise that resolves with this object

toString

toString(): string

- Defined in model/vapp-template/vapp-template.ts:187
JSON format.

Returns string

updateMetadata

updateMetadata(metadata: Array<Metadata<MetadataType>>): Promise<Task>

- Defined in model/vapp-template/vapp-template.ts:308
Updates the vApp Template's metadata.

Parameters
- metadata: Array<Metadata<MetadataType>>
  
  the new array of metadata
Returns Promise<Task>

task promise

updateVappTemplate

updateVappTemplate(req: VappTemplateUpdateRequest): Promise<Task>

- Defined in model/vapp-template/vapp-template.ts:209
Update a Vapp Template. Capable of updating the templates name, and description.

Parameters
- req: VappTemplateUpdateRequest
  
  vapp template update request
Returns Promise<Task>

Static getVappTemplate

getVappTemplate(uuid: string): Promise<VappTemplate>

- Defined in model/vapp-template/vapp-template.ts:32
Get the VappTemplate from API.

Parameters
- uuid: string
Returns Promise<VappTemplate>

promise that resolves with the VappTemplate.

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: VappTemplateJson

Returns VappTemplate

Accessors

catalogUuid

companyId

createdDate

deleted

deletedDate

description

entityType

isCustomisable

isCustomizationRequired

isExpired

isGoldMaster

isPublic

json

locationId

name

orgUuid

size

status

storageProfileUuid

updatedDate

uuid

vcloudHref

vdcUuid

vmTemplates

Methods

deleteMetadata

Parameters

key: string

Returns Promise<Task>

deleteVappTemplate

Returns Promise<Task>

enableVappTemplateDownload

Returns Promise<Task>

getDownloadDetails

Returns Promise<VappTemplateDownloadDetails>

getMetadata

Returns Promise<Array<Metadata<MetadataType>>>

getVappTemplateConfiguration

Returns Promise<VappTemplateConfiguration>

getVappTemplateVms

Returns Promise<Array<VappTemplateVm>>

refresh

Returns Promise<VappTemplate>

toString

Returns string

updateMetadata

Parameters

metadata: Array<Metadata<MetadataType>>

Returns Promise<Task>

updateVappTemplate

Parameters

req: VappTemplateUpdateRequest

Returns Promise<Task>

Static getVappTemplate

Parameters

uuid: string

Returns Promise<VappTemplate>