com.vmware.vcloud.sdk
Class VappNetwork

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

public class VappNetwork
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.VAppNetworkType>

Helper class to access the vApp Network Resource in vCloud API.

Since:

API 1.5, SDK 1.5

See Also:

VAppNetworkType

Method Summary

static VappNetwork	getVappNetworkById(VcloudClient client, String vCloudId) Get VappNetwork helper using the vCloud ID
static VappNetwork	getVappNetworkByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vappNetworkRef) Get VappNetwork using the vApp Network ref typically obtained from the Vapp.
com.vmware.vcloud.api.rest.schema.ReferenceType	getVappReference() Returns the Vapp reference which contains this vapp network.
Task	reset() Resets the vApp Network.

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

getVappNetworkByReference

public static VappNetwork getVappNetworkByReference(VcloudClient client,
                                                    com.vmware.vcloud.api.rest.schema.ReferenceType vappNetworkRef)
                                             throws VCloudException

Get VappNetwork using the vApp Network ref typically obtained from the Vapp.

Parameters:

client - vCloud API client VcloudClient

vappNetworkRef - VappNetwork ref ReferenceType

Returns:

VappNetwork helper VappNetwork

Throws:

VCloudException

getVappNetworkById

public static VappNetwork getVappNetworkById(VcloudClient client,
                                             String vCloudId)
                                      throws VCloudException

Get VappNetwork 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:

VappNetwork

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

reset

public Task reset()
           throws VCloudException

Resets the vApp Network. The vApp Network needs to be deployed for Reset.

Returns:

Task

Throws:

VCloudException

getVappReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getVappReference()
                                                                 throws VCloudException

Returns the Vapp reference which contains this vapp network.

Returns:

ReferenceType

Throws:

VCloudException