com.vmware.vcloud.sdk
Class Organization

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.OrgType>
          com.vmware.vcloud.sdk.Organization

public class Organization
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.OrgType>

Helper class to access the Organization Resource in vCLoud API.

See Also:

OrgType

Method Summary

Task	createTask(com.vmware.vcloud.api.rest.schema.TaskType taskType) Creating a custom task.
com.vmware.vcloud.api.rest.schema.ControlAccessParamsType	getCatalogControlAccessByReference(com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef) Returns Catalog Control access for the given catlog reference
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getCatalogRefs() Returns a collection of the catalog refs
com.vmware.vcloud.api.rest.schema.ReferenceType	getNetworkRefByName(String name) Deprecated. SDK 5.5
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getNetworkRefs() Deprecated. SDK 5.5
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getNetworkRefsByName() Deprecated. SDK 5.5
static Organization	getOrganizationById(VcloudClient client, String vCloudId) Get Organization helper using the vCloud ID
static Organization	getOrganizationByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType orgRef) Returns Organization helper for the given reference
com.vmware.vcloud.api.rest.schema.ReferenceType	getTasksListRef() Returns the tasks list ref
com.vmware.vcloud.api.rest.schema.ReferenceType	getVdcRefByName(String name) Returns vdc ref for the given vdc name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVdcRefs() Returns a collection of vdc refs
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVdcRefsByName() Returns HashMap of VDC Refs by name.
Task	instantiateVdcTemplate(com.vmware.vcloud.api.rest.schema.InstantiateVdcTemplateParamsType instantiateVdcTemplateParams) Instantiating a VDC template.
com.vmware.vcloud.api.rest.schema.ControlAccessParamsType	updateCatalogControlAccessByReference(com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef, com.vmware.vcloud.api.rest.schema.ControlAccessParamsType controlAccessParams) Updates the Catalog Control access for the given catalog reference

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOrganizationByReference

public static Organization getOrganizationByReference(VcloudClient client,
                                                      com.vmware.vcloud.api.rest.schema.ReferenceType orgRef)
                                               throws VCloudException

Returns Organization helper for the given reference

Parameters:

client - vCloud API client VcloudClient

orgRef - ReferenceType to the Organization ReferenceType

Returns:

Organization helper Organization

Throws:

VCloudException

getOrganizationById

public static Organization getOrganizationById(VcloudClient client,
                                               String vCloudId)
                                        throws VCloudException

Get Organization helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

Organization

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getCatalogControlAccessByReference

public com.vmware.vcloud.api.rest.schema.ControlAccessParamsType getCatalogControlAccessByReference(com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef)
                                                                                             throws VCloudException

Returns Catalog Control access for the given catlog reference

Parameters:

catalogRef - ReferenceType

Returns:

ControlAccessParamsType

Throws:

VCloudException

Since:

SDK 1.5

updateCatalogControlAccessByReference

public com.vmware.vcloud.api.rest.schema.ControlAccessParamsType updateCatalogControlAccessByReference(com.vmware.vcloud.api.rest.schema.ReferenceType catalogRef,
                                                                                                       com.vmware.vcloud.api.rest.schema.ControlAccessParamsType controlAccessParams)
                                                                                                throws VCloudException

Updates the Catalog Control access for the given catalog reference

Parameters:

catalogRef - ReferenceType

controlAccessParams - ControlAccessParamsType

Returns:

ControlAccessParamsType

Throws:

VCloudException

Since:

SDK 1.5

getTasksListRef

public com.vmware.vcloud.api.rest.schema.ReferenceType getTasksListRef()

Returns the tasks list ref

Returns:

ReferenceType

getVdcRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getVdcRefsByName()

Returns HashMap of VDC Refs by name.

Returns:

HashMap

getNetworkRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getNetworkRefsByName()

Deprecated. SDK 5.5

Returns HashMap of Network Refs by name The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getLink() and from the list of references, get the network references.

Returns:

HashMap

getVdcRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getVdcRefs()

Returns a collection of vdc refs

Returns:

Collection

getVdcRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getVdcRefByName(String name)

Returns vdc ref for the given vdc name

Parameters:

name - VDC Name

Returns:

VDC ref ReferenceType

getCatalogRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getCatalogRefs()

Returns a collection of the catalog refs

Returns:

collection of Catalog refs Collection

getNetworkRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getNetworkRefs()

Deprecated. SDK 5.5

Returns a collection of network refs The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getLink() and from the list of references, get the network references.

Returns:

collection of Network refs Collection

getNetworkRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getNetworkRefByName(String name)

Deprecated. SDK 5.5

Returns a network ref for the given network name The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getLink() and from the list of references, get the network references.

Parameters:

name - Network Name

Returns:

Network ref ReferenceType

createTask

public Task createTask(com.vmware.vcloud.api.rest.schema.TaskType taskType)
                throws VCloudException

Creating a custom task.

Parameters:

taskType -

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

instantiateVdcTemplate

public Task instantiateVdcTemplate(com.vmware.vcloud.api.rest.schema.InstantiateVdcTemplateParamsType instantiateVdcTemplateParams)
                            throws VCloudException

Instantiating a VDC template. This operation requires the vdc template reference, name and description in the ParamsType. The name and description are the ony properties that a tenant can override.

Parameters:

instantiateVdcTemplateParams - InstantiateVdcTemplateParamsType

Returns:

Task

Throws:

VCloudException

Since:

API 5.7, SDK 5.7