Class

# VMware_VCloud_SDK_Catalog

class VMware_VCloud_SDK_Catalog 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 | getCatalogRef() Get a reference to a VMware vCloud catalog entity. |
VMware_VCloud_API_CatalogType | getCatalog() Get a VMware vCloud catalog entity. |
string | getId() Constructs vCloud ID of the catalog from its UUID. |
VMware_VCloud_API_LinkType|null | getOrgRef() Get the link to the container of the catalog. |
VMware_VCloud_API_OrgType|null | getOrg() Get the container of the catalog. |
array | getCatalogItemRefs(string $name = null) Get references to catalog items entity in this catalog entity. |
array | getCatalogItems(string $name = null) Get all catalog items or catalog items with the given name in this catalog. |
VMware_VCloud_API_CatalogItemType | addCatalogItem(VMware_VCloud_API_CatalogItemType $catalogItem) Add a catalog item to this VMware vCloud catalog. |
VMware_VCloud_API_ControlAccessParamsType | getControlAccess() Get the control access of this catalog. |
VMware_VCloud_API_ControlAccessParamsType | modifyControlAccess(VMware_VCloud_API_ControlAccessParamsType $controlAccess) Modify the control access of this catalog. |
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null | getMetadata(string $key = null, string $domain = null) Get metadata associated with the catalog or metadata associated with the catalog for the specified key in the specified domain. |
VMware_VCloud_API_VAppTemplateType | uploadOVFAsVAppTemplate(string $name, string $ovfDescriptorPath, string $description = null, boolean $manifestRequired = null, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef) Creating vAppTemplate by uploading an ovf package. |
| checkCatalogForDuplicates(VMware_VCloud_SDK_Catalog $catalog, string $resourceName) Check if the resource name is already existing in the catalog. |
array | getUploadFiles(VMware_VCloud_API_VAppTemplateType $vAppTemplate) Get file information for uploading vApp template. |
null | uploadOVFDescriptor(string $url, string $filename) Upload OVF descriptor. |
VMware_VCloud_API_TaskType | captureVApp(VMware_VCloud_API_CaptureVAppParamsType $params) Create a vApp template in this library from a vApp. |
VMware_VCloud_API_TaskType | sync() Force sync the library to the remote subscribed library. |
VMware_VCloud_API_TaskType | copyCatalogItem(VMware_VCloud_API_CopyOrMoveCatalogItemParamsType $params) Copy a library item from one library to another. |
VMware_VCloud_API_TaskType | moveCatalogItem(VMware_VCloud_API_CopyOrMoveCatalogItemParamsType $params) Move a library item from one library to another. |

## 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 getCatalogRef()`

Get a reference to a VMware vCloud catalog entity.

#### Return Value

VMware_VCloud_API_ReferenceType |

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

Get a VMware vCloud catalog entity.

#### Return Value

VMware_VCloud_API_CatalogType |

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

Constructs vCloud ID of the catalog from its UUID.

#### Return Value

string |

###
at line 43
`public VMware_VCloud_API_LinkType|null getOrgRef()`

Get the link to the container of the catalog.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 54
`public VMware_VCloud_API_OrgType|null getOrg()`

Get the container of the catalog.

#### Return Value

VMware_VCloud_API_OrgType|null |

###
at line 67
`public array getCatalogItemRefs(string $name = null)`

Get references to catalog items entity in this catalog entity.

#### Parameters

string | $name | Name of the catalog item. If null, returns all

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 81
`public array getCatalogItems(string $name = null)`

Get all catalog items or catalog items with the given name in this catalog.

#### Parameters

string | $name | Name of the catalog item. If null, returns all

#### Return Value

array | VMwareVCloudAPI_CatalogItemType object array

###
at line 95
`public VMware_VCloud_API_CatalogItemType addCatalogItem(VMware_VCloud_API_CatalogItemType $catalogItem)`

Add a catalog item to this VMware vCloud catalog.

#### Parameters

VMware_VCloud_API_CatalogItemType | $catalogItem |

#### Return Value

VMware_VCloud_API_CatalogItemType | Represents the newly created catalog item

###
at line 123
`public VMware_VCloud_API_ControlAccessParamsType getControlAccess()`

Get the control access of this catalog.

#### Return Value

VMware_VCloud_API_ControlAccessParamsType |

###
at line 137
`public VMware_VCloud_API_ControlAccessParamsType modifyControlAccess(VMware_VCloud_API_ControlAccessParamsType $controlAccess)`

Modify the control access of this catalog.

Modify catalog sharing can be done with this function.

#### Parameters

VMware_VCloud_API_ControlAccessParamsType | $controlAccess |

#### Return Value

VMware_VCloud_API_ControlAccessParamsType |

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

Get metadata associated with the catalog or metadata associated with the catalog 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 174
`public VMware_VCloud_API_VAppTemplateType uploadOVFAsVAppTemplate(string $name, string $ovfDescriptorPath, string $description = null, boolean $manifestRequired = null, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef)`

Creating vAppTemplate by uploading an ovf package.

#### Parameters

string | $name | Name of the vApp template to be created
string | $ovfDescriptorPath | Path to the OVF descriptor
string | $description | Description of the vApp template to be created
boolean | $manifestRequired | A flag indicates the manifest file is required or not
VMware_VCloud_API_ReferenceType | $vdcStorageProfileRef |

#### Return Value

VMware_VCloud_API_VAppTemplateType | object.

#### Exceptions

VMware_VCloud_SDK_Exception |

###
at line 224
`public checkCatalogForDuplicates(VMware_VCloud_SDK_Catalog $catalog, string $resourceName)`

Check if the resource name is already existing in the catalog.

#### Parameters

VMware_VCloud_SDK_Catalog | $catalog | object $catalog
string | $resourceName | Name of the vApp template to be created.

###
at line 273
`public array getUploadFiles(VMware_VCloud_API_VAppTemplateType $vAppTemplate)`

Get file information for uploading vApp template.

#### Parameters

VMware_VCloud_API_VAppTemplateType | $vAppTemplate |

#### Return Value

array | VMwareVCloudAPI_FileType object array

#### Exceptions

VMware_VCloud_SDK_Exception |

###
at line 304
`public null uploadOVFDescriptor(string $url, string $filename)`

Upload OVF descriptor.

#### Parameters

string | $url | HTTP request URL
string | $filename | Path to the OVF descriptor

#### Return Value

null |

###
at line 317
`public VMware_VCloud_API_TaskType captureVApp(VMware_VCloud_API_CaptureVAppParamsType $params)`

Create a vApp template in this library from a vApp.

#### Parameters

VMware_VCloud_API_CaptureVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |

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

Force sync the library to the remote subscribed library.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 345
`public VMware_VCloud_API_TaskType copyCatalogItem(VMware_VCloud_API_CopyOrMoveCatalogItemParamsType $params)`

Copy a library item from one library to another.

#### Parameters

VMware_VCloud_API_CopyOrMoveCatalogItemParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 360
`public VMware_VCloud_API_TaskType moveCatalogItem(VMware_VCloud_API_CopyOrMoveCatalogItemParamsType $params)`

Move a library item from one library to another.

#### Parameters

VMware_VCloud_API_CopyOrMoveCatalogItemParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |