Catalog | iland-sdk

Catalog.

Hierarchy

Entity
- Catalog

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Catalog(_json: CatalogJson): Catalog

Overrides Entity.constructor
- Defined in model/catalog/catalog.ts:22
Parameters
- _json: CatalogJson
Returns Catalog

Accessors

companyId

companyId:

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

createdDate

createdDate:

Get the 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 description for catalog

entityType

entityType:

Get entity type for catalog.

isPublic

isPublic:

Indicate whether the catalog is public or not.

isShared

isShared:

Indicate whether the catalog is shared or not.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Get location ID

name

name:

Gets the name.

orgUuid

orgUuid:

Get org uuid for catalog.

originalUuid

originalUuid:

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

vcloudHref

vcloudHref:

Get vCloudHref for catalog

version

version:

Get the catalog version

Methods

addVappTemplateFromVapp

addVappTemplateFromVapp(spec: VappTemplateFromVappCreateRequest): Promise<Task>

- Defined in model/catalog/catalog.ts:191
Add a Vapp Template to the catalog based on an existing vapp. The json can contain params "name" and "description" for the new vapp template.

Parameters
- spec: VappTemplateFromVappCreateRequest
  
  vapp template spec
Returns Promise<Task>

promise Promise that resolves with a Task

deleteCatalog

deleteCatalog(): Promise<any>

- Defined in model/catalog/catalog.ts:280
Deletes the catalog.

Returns Promise<any>

deleteMetadata

deleteMetadata(metadataKey: string): Promise<Task>

- Defined in model/catalog/catalog.ts:243
Deletes a metadata entry.

Parameters
- metadataKey: string
  
  the key of the metadata entry to delete
Returns Promise<Task>

task promise

getItemDownloads

getItemDownloads(): Promise<Array<ItemDownloadJson>>

- Defined in model/catalog/catalog.ts:155
Gets Catalog's item downloads.

description

There are two types of catalog items that will show up: 'media' or 'template'. The item type field will report 'media' or 'vapp_template'.If the item is a media, the 'template' field will be null and vice-versa. (null 'media' field if item is a vapp_template). Only private catalogs will have a list of catalog item downloads returned.

Returns Promise<Array<ItemDownloadJson>>

getMedia

getMedia(): Promise<Array<Media>>

- Defined in model/catalog/catalog.ts:165
Gets the Catalog's Medias

Returns Promise<Array<Media>>

getMetadata

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

- Defined in model/catalog/catalog.ts:204
Gets the Catalog's metadata.

throws

Error Throw an error if the type is unrecognized.

Returns Promise<Array<Metadata<MetadataType>>>

getVappTemplates

getVappTemplates(): Promise<Array<VappTemplate>>

- Defined in model/catalog/catalog.ts:176
Gets the Catalog's vApp-Templates

Returns Promise<Array<VappTemplate>>

initiateOVFUpload

initiateOVFUpload(body: InitiateOVFUploadRequest): Promise<Task>

- Defined in model/catalog/catalog.ts:269
Initiates a new OVF upload.

Parameters
- body: InitiateOVFUploadRequest
Returns Promise<Task>

refresh

refresh(): Promise<Catalog>

- Defined in model/catalog/catalog.ts:140
Refreshes the Catalog data by retrieving it from the API again.

Returns Promise<Catalog>

promise that resolves with the Catalog

toString

toString(): string

- Defined in model/catalog/catalog.ts:132
JSON format.

Returns string

updateCatalog

updateCatalog(catalog: CatalogUpdateRequest): Promise<Catalog>

- Defined in model/catalog/catalog.ts:256
Updates the catalog.

Parameters
- catalog: CatalogUpdateRequest
Returns Promise<Catalog>

updateMetadata

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

- Defined in model/catalog/catalog.ts:228
Updates the catalog's metadata.

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

task promise

Static getCatalog

getCatalog(uuid: string): Promise<Catalog>

- Defined in model/catalog/catalog.ts:33
Get the Catalog from API.

Parameters
- uuid: string
Returns Promise<Catalog>

promise that resolves with the Catalog

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: CatalogJson

Returns Catalog

Accessors

companyId

createdDate

deleted

deletedDate

description

entityType

isPublic

isShared

json

locationId

name

orgUuid

originalUuid

updatedDate

uuid

vcloudHref

version

Methods

addVappTemplateFromVapp

Parameters

spec: VappTemplateFromVappCreateRequest

Returns Promise<Task>

deleteCatalog

Returns Promise<any>

deleteMetadata

Parameters

metadataKey: string

Returns Promise<Task>

getItemDownloads

Returns Promise<Array<ItemDownloadJson>>

getMedia

Returns Promise<Array<Media>>

getMetadata

Returns Promise<Array<Metadata<MetadataType>>>

getVappTemplates

Returns Promise<Array<VappTemplate>>

initiateOVFUpload

Parameters

body: InitiateOVFUploadRequest

Returns Promise<Task>

refresh

Returns Promise<Catalog>

toString

Returns string

updateCatalog

Parameters

catalog: CatalogUpdateRequest

Returns Promise<Catalog>

updateMetadata

Parameters

metadata: Array<Metadata<MetadataType>>

Returns Promise<Task>

Static getCatalog

Parameters

uuid: string

Returns Promise<Catalog>