Class

# VMware_VCloud_SDK_CatalogItem

class VMware_VCloud_SDK_CatalogItem extends VMware_VCloud_SDK_Abstract

## Methods

string | getEntityId() Get vCloud ID of the vCloud resource entity from its data object. | from VMware_VCloud_SDK_Abstract
VMware_VCloud_API_ReferenceType | getCatalogItemRef() Get a reference to a VMware vCloud catalog item entity. |
VMware_VCloud_API_CatalogItemType | getCatalogItem() Get a VMware vCloud catalog item entity. |
string | getId() Constructs vCloud ID of the catalog item from its UUID. |
VMware_VCloud_API_LinkType|null | getCatalogRef() Get the link to the catalog to which this catalog item belongs. |
VMware_VCloud_API_CatalogType | getCatalog() Get the catalog to which this catalog item belongs. |
VMware_VCloud_API_CatalogItemType | modify(VMware_VCloud_API_CatalogItemType $catalogItem) Modify a VMware vCloud catalog item. |
VMware_VCloud_API_TaskType | sync() Force sync the library item to the remote subscribed library. |
null | delete() Delete a VMware vCloud catalog item entity. |
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null | getMetadata(string $key = null, string $domain = null) Get metadata associated with the catalog item or metadata associated with the catalog item for the specified key in the specified domain. |
VMware_VCloud_API_TaskType | mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for the catalog item with the information provided. |
VMware_VCloud_API_TaskType | setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null) Sets the metadata for the particular key in the specified domain for the catalog item to thevalue provided. |
VMware_VCloud_API_TaskType | deleteMetadataByKey(string $key, string $domain = null) Deletes the metadata for the particular key in the specified domain for the catalog item. |

## Details

###
in VMware_VCloud_SDK_Abstract at line 85
`public string getEntityId()`

Get vCloud ID of the vCloud resource entity from its data object.

#### Return Value

string |

###
at line 10
`public VMware_VCloud_API_ReferenceType getCatalogItemRef()`

Get a reference to a VMware vCloud catalog item entity.

#### Return Value

VMware_VCloud_API_ReferenceType |

###
at line 22
`public VMware_VCloud_API_CatalogItemType getCatalogItem()`

Get a VMware vCloud catalog item entity.

#### Return Value

VMware_VCloud_API_CatalogItemType |

###
at line 33
`public string getId()`

Constructs vCloud ID of the catalog item from its UUID.

#### Return Value

string |

###
at line 44
`public VMware_VCloud_API_LinkType|null getCatalogRef()`

Get the link to the catalog to which this catalog item belongs.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 55
`public VMware_VCloud_API_CatalogType getCatalog()`

Get the catalog to which this catalog item belongs.

#### Return Value

VMware_VCloud_API_CatalogType |

###
at line 68
`public VMware_VCloud_API_CatalogItemType modify(VMware_VCloud_API_CatalogItemType $catalogItem)`

Modify a VMware vCloud catalog item.

#### Parameters

VMware_VCloud_API_CatalogItemType | $catalogItem |

#### Return Value

VMware_VCloud_API_CatalogItemType |

###
at line 81
`public VMware_VCloud_API_TaskType sync()`

Force sync the library item to the remote subscribed library.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 93
`public null delete()`

Delete a VMware vCloud catalog item entity.

#### Return Value

null |

###
at line 109
`public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)`

Get metadata associated with the catalog item or metadata associated with the catalog item for the specified key in the specified domain.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null |

###
at line 121
`public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)`

Merges the metadata for the catalog item with the information provided.

#### Parameters

VMware_VCloud_API_MetadataType | $meta |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 140
`public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)`

Sets the metadata for the particular key in the specified domain for the catalog item to thevalue provided.

Note: This will replace any existing metadata information.

#### Parameters

string | $key |
VMware_VCloud_API_MetadataValueType | $value |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 157
`public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)`

Deletes the metadata for the particular key in the specified domain for the catalog item.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |